sourceDestination.md

etcher-sdk / sourceDestination

Namespace: sourceDestination

Table of contents

Classes

• BZip2Source
• BalenaS3CompressedSource
• BalenaS3Source
• BalenaS3SourceBase
• BlockDevice
• CompressedSource
• ConfiguredSource
• CountingHashStream
• CountingWritable
• DmgSource
• DriverlessDevice
• File
• GZipSource
• Http
• MultiDestination
• MultiDestinationError
• MultiDestinationVerifier
• RandomAccessZipSource
• SingleUseStreamSource
• SourceDestination
• SourceDestinationFs
• SourceDisk
• SourceSource
• SparseStreamVerifier
• StreamVerifier
• StreamZipSource
• UsbBBbootDrive
• UsbbootDrive
• Verifier
• XzSource
• ZipSource

Interfaces

• AwsCredentials
• BalenaS3CompressedSourceOptions
• BalenaS3SourceOptions
• CreateReadStreamOptions
• CreateSparseReadStreamOptions
• Metadata
• ProgressEvent
• SourceTransform

Type Aliases

• ConfigureFunction
• Constructor
• ImageJSON

Variables

• ProgressHashStream
• ProgressWritable
• ProgressWriteStream

Functions

• createHasher
• getRootStream
• isSourceTransform
• makeClassEmitProgressEvents
• matchSupportedExtensions

Type Aliases

ConfigureFunction

Ƭ ConfigureFunction: (disk: Disk) => Promise<void>

Type declaration

▸ (disk): Promise<void>

Parameters

Name	Type
disk	Disk

Returns

Promise<void>

Defined in

lib/source-destination/configured-source/configured-source.ts:45

---

Constructor

Ƭ Constructor<T>: (...args: any[]) => T

Type parameters

Name
T

Type declaration

• (...args)

Parameters

Name	Type
...args	any[]

Defined in

lib/source-destination/progress.ts:24

---

ImageJSON

Ƭ ImageJSON: Dictionary<{ parts: ImageJSONPart[] }>

Defined in

lib/source-destination/balena-s3-compressed-source.ts:36

Variables

ProgressHashStream

• Const ProgressHashStream: (...args: any[]) => __class<typeof CountingHashStream> & typeof CountingHashStream

Defined in

lib/source-destination/source-destination.ts:95

---

ProgressWritable

• Const ProgressWritable: (...args: any[]) => __class<typeof CountingWritable> & typeof CountingWritable

Defined in

lib/source-destination/progress.ts:113

---

ProgressWriteStream

• Const ProgressWriteStream: (...args: any[]) => __class<typeof WriteStream> & typeof WriteStream

Defined in

lib/source-destination/file.ts:36

Functions

createHasher

▸ createHasher(): __class<typeof CountingHashStream> & CountingHashStream

Returns

__class<typeof CountingHashStream> & CountingHashStream

Defined in

lib/source-destination/source-destination.ts:101

---

getRootStream

▸ getRootStream(stream): NodeJS.ReadableStream

Parameters

Name	Type
stream	ReadableStream

Returns

NodeJS.ReadableStream

Defined in

lib/source-destination/compressed-source.ts:35

---

isSourceTransform

▸ isSourceTransform(stream): stream is SourceTransform

Parameters

Name	Type
stream	any

Returns

stream is SourceTransform

Defined in

lib/source-destination/compressed-source.ts:31

---

makeClassEmitProgressEvents

▸ makeClassEmitProgressEvents<T>(Cls, attribute, positionAttribute, interval?): (...args: any[]) => __class<T> & T

Type parameters

Name	Type
T	extends Constructor<EventEmitter>

Parameters

Name	Type	Default value
Cls	T	undefined
attribute	string	undefined
positionAttribute	string	undefined
interval	number	PROGRESS_EMISSION_INTERVAL

Returns

(...args: any[]) => __class<T> & T

Defined in

lib/source-destination/progress.ts:33

---

matchSupportedExtensions

▸ matchSupportedExtensions(filename): boolean

Parameters

Name	Type
filename	string

Returns

boolean

Defined in

lib/source-destination/zip.ts:62