From b7d24d28fb28d0eb2ed5bde3a5d49b37b192255c Mon Sep 17 00:00:00 2001 From: Alexis Svinartchouk Date: Tue, 7 Apr 2020 14:45:54 +0200 Subject: [PATCH] Update generated docs Change-type: patch --- doc/README.md | 343 ++++------ doc/classes/adapter.md | 86 ++- doc/classes/alignedreadablestate.md | 14 +- doc/classes/balenas3source.md | 160 +++-- doc/classes/blockdevice.md | 198 +++--- doc/classes/blockdeviceadapter.md | 125 ++-- doc/classes/blockreadstream.md | 468 ++++++++------ doc/classes/blocksverificationerror.md | 8 +- doc/classes/blocktransformstream.md | 561 ++++++++++------- doc/classes/blockwritestream.md | 456 ++++++++------ doc/classes/bzip2source.md | 146 +++-- doc/classes/checksumverificationerror.md | 8 +- doc/classes/compressedsource.md | 146 +++-- doc/classes/configuredsource.md | 184 ++++-- doc/classes/countinghashstream.md | 584 ++++++++++------- doc/classes/countingwritable.md | 448 +++++++------ doc/classes/crc32hasher.md | 8 +- doc/classes/dmgsource.md | 144 +++-- doc/classes/driverlessdevice.md | 158 +++-- doc/classes/driverlessdeviceadapter_.md | 100 ++- doc/classes/file.md | 160 +++-- doc/classes/gzipsource.md | 146 +++-- doc/classes/http.md | 150 +++-- doc/classes/multidestination.md | 177 ++++-- doc/classes/multidestinationerror.md | 6 +- doc/classes/multidestinationverifier.md | 104 ++- doc/classes/randomaccesszipsource.md | 164 +++-- doc/classes/scanner.md | 98 ++- doc/classes/singleusestreamsource.md | 140 +++-- doc/classes/sourcedestination.md | 146 +++-- doc/classes/sourcedestinationfs.md | 12 +- doc/classes/sourcedisk.md | 12 +- doc/classes/sourcerandomaccessreader.md | 88 ++- doc/classes/sourcesource.md | 140 +++-- doc/classes/sparsefilterstream.md | 576 ++++++++++------- doc/classes/sparsereadstream.md | 482 ++++++++------ doc/classes/sparsestreamverifier.md | 100 ++- doc/classes/sparsetransformstream.md | 591 +++++++++++------- doc/classes/sparsewritestream.md | 470 ++++++++------ doc/classes/streamlimiter.md | 560 ++++++++++------- doc/classes/streamverifier.md | 102 ++- doc/classes/streamzipsource.md | 146 +++-- doc/classes/usbbootdeviceadapter.md | 96 ++- doc/classes/usbbootdrive.md | 164 +++-- doc/classes/verificationerror.md | 2 +- doc/classes/verifier.md | 94 ++- doc/classes/xzsource.md | 146 +++-- doc/classes/zipsource.md | 150 +++-- doc/interfaces/adaptersourcedestination.md | 150 +++-- doc/interfaces/alignedlockablebuffer.md | 165 ++--- doc/interfaces/block.md | 4 +- doc/interfaces/blockswithchecksum.md | 6 +- doc/interfaces/createreadstreamoptions.md | 10 +- .../createsparsereadstreamoptions.md | 6 +- doc/interfaces/drivelistdrive.md | 4 +- doc/interfaces/execresult.md | 4 +- doc/interfaces/metadata.md | 36 +- doc/interfaces/multidestinationprogress.md | 36 +- doc/interfaces/multidestinationstate.md | 24 +- doc/interfaces/operation.md | 4 +- .../pipesourcetodestinationsresult.md | 4 +- doc/interfaces/progressevent.md | 6 +- doc/interfaces/sourcetransform.md | 558 ++++++++++------- doc/interfaces/sparsereadable.md | 119 +++- doc/interfaces/sparsereaderstate.md | 6 +- doc/interfaces/sparsestreamchunk.md | 4 +- doc/interfaces/sparsewritable.md | 92 ++- doc/interfaces/tmpfileresult.md | 10 +- doc/interfaces/wificonfig.md | 12 +- 69 files changed, 6712 insertions(+), 4115 deletions(-) diff --git a/doc/README.md b/doc/README.md index 30501000..0e1e6a89 100644 --- a/doc/README.md +++ b/doc/README.md @@ -115,6 +115,7 @@ * [ProgressSparseWriteStream](README.md#const-progresssparsewritestream) * [ProgressWritable](README.md#const-progresswritable) * [ProgressWriteStream](README.md#const-progresswritestream) +* [READ_TRIES](README.md#const-read_tries) * [RETRY_BASE_TIMEOUT](README.md#const-retry_base_timeout) * [RWMutex](README.md#rwmutex) * [SCAN_INTERVAL](README.md#const-scan_interval) @@ -125,28 +126,19 @@ * [USBBOOT_RPI_COMPUTE_MODULE_NAMES](README.md#const-usbboot_rpi_compute_module_names) * [WIN32_FIRST_BYTES_TO_KEEP](README.md#const-win32_first_bytes_to_keep) * [XXHASH_SEED](README.md#const-xxhash_seed) -* [close](README.md#const-close) * [debug](README.md#const-debug) -* [fstat](README.md#const-fstat) -* [fsync](README.md#const-fsync) * [getCrc](README.md#const-getcrc) * [getRaspberrypiUsbboot](README.md#const-getraspberrypiusbboot) * [getUnmountDisk](README.md#const-getunmountdisk) * [getXXHash](README.md#const-getxxhash) -* [open](README.md#const-open) * [parseFileIndexAsync](README.md#const-parsefileindexasync) -* [read](README.md#const-read) -* [readFile](README.md#const-readfile) * [speedometer](README.md#speedometer) -* [stat](README.md#const-stat) * [unbzip2Stream](README.md#unbzip2stream) -* [unlink](README.md#const-unlink) -* [write](README.md#const-write) -* [writeFile](README.md#const-writefile) * [zlib](README.md#zlib) ### Functions +* [alignedLockableBufferSlice](README.md#alignedlockablebufferslice) * [asCallback](README.md#ascallback) * [attachMutex](README.md#attachmutex) * [blockmapToBlocks](README.md#blockmaptoblocks) @@ -177,7 +169,6 @@ * [makeClassEmitProgressEvents](README.md#makeclassemitprogressevents) * [matchSupportedExtensions](README.md#matchsupportedextensions) * [nmWifiConfig](README.md#const-nmwificonfig) -* [noop](README.md#noop) * [pad](README.md#const-pad) * [pipeRegularSourceToDestination](README.md#piperegularsourcetodestination) * [pipeSourceToDestinations](README.md#pipesourcetodestinations) @@ -201,7 +192,7 @@ Ƭ **AnyHasher**: *[CRC32Hasher](classes/crc32hasher.md) | Hash | XXHash | XXHash64* -*Defined in [lib/sparse-stream/shared.ts:75](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L75)* +*Defined in [lib/sparse-stream/shared.ts:75](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L75)* ___ @@ -209,7 +200,7 @@ ___ Ƭ **ChecksumType**: *"crc32" | "sha1" | "sha256" | "xxhash32" | "xxhash64"* -*Defined in [lib/sparse-stream/shared.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L26)* +*Defined in [lib/sparse-stream/shared.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L26)* ___ @@ -217,7 +208,7 @@ ___ Ƭ **ConfigureFunction**: *function* -*Defined in [lib/source-destination/configured-source/configured-source.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L45)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L45)* #### Type declaration: @@ -236,7 +227,7 @@ ___ Ƭ **Constructor**: *object* -*Defined in [lib/source-destination/progress.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L25)* +*Defined in [lib/source-destination/progress.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L25)* #### Type declaration: @@ -246,7 +237,7 @@ ___ Ƭ **Name**: *"balena" | "resin"* -*Defined in [lib/source-destination/balena-s3-source.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L28)* +*Defined in [lib/source-destination/balena-s3-source.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L28)* ___ @@ -254,7 +245,7 @@ ___ Ƭ **OnFailFunction**: *function* -*Defined in [lib/multi-write.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L60)* +*Defined in [lib/multi-write.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L60)* #### Type declaration: @@ -273,7 +264,7 @@ ___ Ƭ **OnProgressFunction**: *function* -*Defined in [lib/multi-write.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L65)* +*Defined in [lib/multi-write.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L65)* #### Type declaration: @@ -291,7 +282,7 @@ ___ Ƭ **OperationCommand**: *"configure" | "copy"* -*Defined in [lib/source-destination/configured-source/configure.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L28)* +*Defined in [lib/source-destination/configured-source/configure.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L28)* ___ @@ -299,7 +290,7 @@ ___ Ƭ **WriteStep**: *"flashing" | "verifying" | "finished"* -*Defined in [lib/multi-write.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L34)* +*Defined in [lib/multi-write.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L34)* ___ @@ -307,7 +298,7 @@ ___ Ƭ **XXHash**: *typeof xxhash* -*Defined in [lib/lazy.ts:21](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/lazy.ts#L21)* +*Defined in [lib/lazy.ts:21](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/lazy.ts#L21)* ## Variables @@ -315,7 +306,7 @@ ___ • **BITS**: *64 | 32* = arch === 'x64' || arch === 'aarch64' ? 64 : 32 -*Defined in [lib/source-destination/source-destination.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L45)* +*Defined in [lib/source-destination/source-destination.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L50)* ___ @@ -323,7 +314,7 @@ ___ • **CHUNK_SIZE**: *number* = 1024 ** 2 -*Defined in [lib/constants.ts:19](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/constants.ts#L19)* +*Defined in [lib/constants.ts:19](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/constants.ts#L19)* ___ @@ -331,7 +322,7 @@ ___ • **DEFAULT_ALIGNMENT**: *512* = 512 -*Defined in [lib/constants.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/constants.ts#L23)* +*Defined in [lib/constants.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/constants.ts#L23)* ___ @@ -339,7 +330,7 @@ ___ • **DISKPART_DELAY**: *2000* = 2000 -*Defined in [lib/diskpart.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L27)* +*Defined in [lib/diskpart.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L27)* ___ @@ -347,7 +338,7 @@ ___ • **DISKPART_RETRIES**: *5* = 5 -*Defined in [lib/diskpart.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L28)* +*Defined in [lib/diskpart.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L28)* ___ @@ -355,7 +346,7 @@ ___ • **DriverlessDeviceAdapter**: *undefined | [DriverlessDeviceAdapter$](classes/driverlessdeviceadapter_.md)* = platform === 'win32' ? DriverlessDeviceAdapter$ : undefined -*Defined in [lib/scanner/adapters/driverless.ts:105](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L105)* +*Defined in [lib/scanner/adapters/driverless.ts:105](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L105)* ___ @@ -363,7 +354,7 @@ ___ • **ISIZE_LENGTH**: *4* = 4 -*Defined in [lib/source-destination/gzip.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/gzip.ts#L23)* +*Defined in [lib/source-destination/gzip.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/gzip.ts#L23)* ___ @@ -371,7 +362,7 @@ ___ • **MBR_LAST_PRIMARY_PARTITION**: *4* = 4 -*Defined in [lib/source-destination/configured-source/configure.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L36)* +*Defined in [lib/source-destination/configured-source/configure.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L36)* ___ @@ -386,7 +377,7 @@ ___ 'routeMetric', ] -*Defined in [lib/source-destination/configured-source/operations/configure.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L23)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L23)* ___ @@ -394,7 +385,7 @@ ___ • **NO_MATCHING_FILE_MSG**: *"Can't find a matching file in this zip archive"* = "Can't find a matching file in this zip archive" -*Defined in [lib/constants.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/constants.ts#L20)* +*Defined in [lib/constants.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/constants.ts#L20)* ___ @@ -402,7 +393,7 @@ ___ • **PARTITION_FIELDS**: *string[]* = ['partition', 'to.partition', 'from.partition'] -*Defined in [lib/source-destination/configured-source/configure.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L35)* +*Defined in [lib/source-destination/configured-source/configure.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L35)* ___ @@ -410,7 +401,7 @@ ___ • **PATTERN**: *RegExp‹›* = /PHYSICALDRIVE(\d+)/i -*Defined in [lib/diskpart.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L29)* +*Defined in [lib/diskpart.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L29)* ___ @@ -418,7 +409,7 @@ ___ • **PROGRESS_EMISSION_INTERVAL**: *number* = 1000 / 2 -*Defined in [lib/constants.ts:17](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/constants.ts#L17)* +*Defined in [lib/constants.ts:17](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/constants.ts#L17)* ___ @@ -431,7 +422,7 @@ ___ PROGRESS_EMISSION_INTERVAL, ) -*Defined in [lib/block-read-stream.ts:118](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L118)* +*Defined in [lib/block-read-stream.ts:122](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L122)* ___ @@ -444,7 +435,7 @@ ___ PROGRESS_EMISSION_INTERVAL, ) -*Defined in [lib/block-write-stream.ts:124](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L124)* +*Defined in [lib/block-write-stream.ts:124](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L124)* ___ @@ -457,7 +448,7 @@ ___ PROGRESS_EMISSION_INTERVAL, ) -*Defined in [lib/source-destination/source-destination.ts:58](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L58)* +*Defined in [lib/source-destination/source-destination.ts:81](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L81)* ___ @@ -470,7 +461,7 @@ ___ PROGRESS_EMISSION_INTERVAL, ) -*Defined in [lib/source-destination/file.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L36)* +*Defined in [lib/source-destination/file.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L35)* ___ @@ -483,7 +474,7 @@ ___ PROGRESS_EMISSION_INTERVAL, ) -*Defined in [lib/sparse-stream/sparse-transform-stream.ts:81](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-transform-stream.ts#L81)* +*Defined in [lib/sparse-stream/sparse-transform-stream.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-transform-stream.ts#L85)* ___ @@ -496,7 +487,7 @@ ___ PROGRESS_EMISSION_INTERVAL, ) -*Defined in [lib/sparse-stream/sparse-write-stream.ts:148](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L148)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:148](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L148)* ___ @@ -509,7 +500,7 @@ ___ PROGRESS_EMISSION_INTERVAL, ) -*Defined in [lib/source-destination/progress.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L110)* +*Defined in [lib/source-destination/progress.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L110)* ___ @@ -522,7 +513,15 @@ ___ PROGRESS_EMISSION_INTERVAL, ) -*Defined in [lib/source-destination/file.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L43)* +*Defined in [lib/source-destination/file.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L42)* + +___ + +### `Const` READ_TRIES + +• **READ_TRIES**: *5* = 5 + +*Defined in [lib/source-destination/file.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L49)* ___ @@ -530,7 +529,7 @@ ___ • **RETRY_BASE_TIMEOUT**: *100* = 100 -*Defined in [lib/constants.ts:18](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/constants.ts#L18)* +*Defined in [lib/constants.ts:18](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/constants.ts#L18)* ___ @@ -538,7 +537,7 @@ ___ • **RWMutex**: *[RWMutex](README.md#rwmutex)* -*Defined in [lib/aligned-lockable-buffer.ts:2](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L2)* +*Defined in [lib/aligned-lockable-buffer.ts:2](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L2)* ___ @@ -546,9 +545,9 @@ ___ • **SCAN_INTERVAL**: *1000* = 1000 -*Defined in [lib/scanner/adapters/block-device.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L27)* +*Defined in [lib/scanner/adapters/block-device.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L27)* -*Defined in [lib/scanner/adapters/driverless.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L26)* +*Defined in [lib/scanner/adapters/driverless.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L26)* ___ @@ -556,7 +555,7 @@ ___ • **TMP_DIR**: *string* = tmpdir() -*Defined in [lib/tmp.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/tmp.ts#L25)* +*Defined in [lib/tmp.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/tmp.ts#L24)* ___ @@ -564,7 +563,7 @@ ___ • **TMP_RANDOM_BYTES**: *6* = 6 -*Defined in [lib/tmp.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/tmp.ts#L24)* +*Defined in [lib/tmp.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/tmp.ts#L23)* ___ @@ -572,7 +571,7 @@ ___ • **TRIES**: *5* = 5 -*Defined in [lib/tmp.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/tmp.ts#L26)* +*Defined in [lib/tmp.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/tmp.ts#L25)* ___ @@ -580,7 +579,7 @@ ___ • **UNMOUNT_ON_SUCCESS_TIMEOUT_MS**: *2000* = 2000 -*Defined in [lib/source-destination/block-device.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L42)* +*Defined in [lib/source-destination/block-device.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L42)* **`summary`** Time, in milliseconds, to wait before unmounting on success @@ -598,7 +597,7 @@ ___ 'Linux File-Stor Gadget Media', ] -*Defined in [lib/scanner/adapters/block-device.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L28)* +*Defined in [lib/scanner/adapters/block-device.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L28)* ___ @@ -606,7 +605,7 @@ ___ • **WIN32_FIRST_BYTES_TO_KEEP**: *number* = 64 * 1024 -*Defined in [lib/source-destination/block-device.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L43)* +*Defined in [lib/source-destination/block-device.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L43)* ___ @@ -614,15 +613,7 @@ ___ • **XXHASH_SEED**: *1163150152* = 1163150152 -*Defined in [lib/constants.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/constants.ts#L22)* - -___ - -### `Const` close - -• **close**: *__promisify__* = promisify(fs.close) - -*Defined in [lib/fs.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L20)* +*Defined in [lib/constants.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/constants.ts#L22)* ___ @@ -630,31 +621,15 @@ ___ • **debug**: *IDebugger* = _debug('etcher-sdk:configured-source') -*Defined in [lib/diskpart.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L25)* - -*Defined in [lib/block-write-stream.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L29)* - -*Defined in [lib/scanner/adapters/block-device.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L25)* - -*Defined in [lib/scanner/scanner.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L22)* - -*Defined in [lib/source-destination/configured-source/configured-source.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L43)* - -___ - -### `Const` fstat - -• **fstat**: *__promisify__* = promisify(fs.fstat) +*Defined in [lib/diskpart.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L25)* -*Defined in [lib/fs.ts:21](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L21)* +*Defined in [lib/block-write-stream.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L29)* -___ - -### `Const` fsync +*Defined in [lib/scanner/adapters/block-device.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L25)* -• **fsync**: *__promisify__* = promisify(fs.fsync) +*Defined in [lib/scanner/scanner.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L22)* -*Defined in [lib/fs.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L22)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L43)* ___ @@ -662,7 +637,7 @@ ___ • **getCrc**: *(Anonymous function)* = once(() => require('crc') as typeof import('crc')) -*Defined in [lib/lazy.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/lazy.ts#L39)* +*Defined in [lib/lazy.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/lazy.ts#L39)* ___ @@ -676,7 +651,7 @@ ___ } }) -*Defined in [lib/lazy.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/lazy.ts#L23)* +*Defined in [lib/lazy.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/lazy.ts#L23)* ___ @@ -686,7 +661,7 @@ ___ promisify((require('mountutils') as typeof import('mountutils')).unmountDisk), ) -*Defined in [lib/lazy.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/lazy.ts#L35)* +*Defined in [lib/lazy.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/lazy.ts#L35)* ___ @@ -696,15 +671,7 @@ ___ () => require('xxhash') as typeof import('xxhash'), ) -*Defined in [lib/lazy.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/lazy.ts#L31)* - -___ - -### `Const` open - -• **open**: *__promisify__* = promisify(fs.open) - -*Defined in [lib/fs.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L23)* +*Defined in [lib/lazy.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/lazy.ts#L31)* ___ @@ -712,7 +679,7 @@ ___ • **parseFileIndexAsync**: *function* = promisify(parseFileIndex) -*Defined in [lib/source-destination/xz.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/xz.ts#L24)* +*Defined in [lib/source-destination/xz.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/xz.ts#L24)* #### Type declaration: @@ -726,35 +693,11 @@ Name | Type | ___ -### `Const` read - -• **read**: *__promisify__* = promisify(fs.read) - -*Defined in [lib/fs.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L24)* - -___ - -### `Const` readFile - -• **readFile**: *__promisify__* = promisify(fs.readFile) - -*Defined in [lib/fs.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L25)* - -___ - ### speedometer • **speedometer**: *[speedometer](README.md#speedometer)* -*Defined in [lib/source-destination/progress.ts:21](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L21)* - -___ - -### `Const` stat - -• **stat**: *__promisify__* = promisify(fs.stat) - -*Defined in [lib/fs.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L26)* +*Defined in [lib/source-destination/progress.ts:21](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L21)* ___ @@ -762,47 +705,41 @@ ___ • **unbzip2Stream**: *[unbzip2Stream](README.md#unbzip2stream)* -*Defined in [lib/source-destination/bzip2.ts:18](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/bzip2.ts#L18)* +*Defined in [lib/source-destination/bzip2.ts:18](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/bzip2.ts#L18)* ___ -### `Const` unlink - -• **unlink**: *__promisify__* = promisify(fs.unlink) +### zlib -*Defined in [lib/fs.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L27)* +• **zlib**: *"zlib"* -___ +*Defined in [lib/stream-limiter.ts:18](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/stream-limiter.ts#L18)* -### `Const` write +## Functions -• **write**: *__promisify__* = promisify(fs.write) +### alignedLockableBufferSlice -*Defined in [lib/fs.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L28)* +▸ **alignedLockableBufferSlice**(`this`: [AlignedLockableBuffer](interfaces/alignedlockablebuffer.md), `start?`: undefined | number, `end?`: undefined | number): *[AlignedLockableBuffer](interfaces/alignedlockablebuffer.md)‹›* -___ +*Defined in [lib/aligned-lockable-buffer.ts:11](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L11)* -### `Const` writeFile +**Parameters:** -• **writeFile**: *__promisify__* = promisify(fs.writeFile) +Name | Type | +------ | ------ | +`this` | [AlignedLockableBuffer](interfaces/alignedlockablebuffer.md) | +`start?` | undefined | number | +`end?` | undefined | number | -*Defined in [lib/fs.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/fs.ts#L29)* +**Returns:** *[AlignedLockableBuffer](interfaces/alignedlockablebuffer.md)‹›* ___ -### zlib - -• **zlib**: *"zlib"* - -*Defined in [lib/stream-limiter.ts:18](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/stream-limiter.ts#L18)* - -## Functions - ### asCallback ▸ **asCallback**<**T**>(`promise`: Promise‹T›, `callback`: function): *Promise‹void›* -*Defined in [lib/utils.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/utils.ts#L85)* +*Defined in [lib/utils.ts:98](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/utils.ts#L98)* **Type parameters:** @@ -814,13 +751,13 @@ ___ ▪ **callback**: *function* -▸ (`error`: [Error](classes/notcapable.md#static-error) | void, `value?`: T): *void* +▸ (`error?`: [Error](classes/notcapable.md#static-error) | null, `value?`: T): *void* **Parameters:** Name | Type | ------ | ------ | -`error` | [Error](classes/notcapable.md#static-error) | void | +`error?` | [Error](classes/notcapable.md#static-error) | null | `value?` | T | **Returns:** *Promise‹void›* @@ -829,17 +766,23 @@ ___ ### attachMutex -▸ **attachMutex**(`buf`: [Buffer](interfaces/alignedlockablebuffer.md#buffer), `mutex`: [RWMutex](README.md#rwmutex), `alignment`: number): *[AlignedLockableBuffer](interfaces/alignedlockablebuffer.md)* +▸ **attachMutex**(`buf`: [Buffer](interfaces/alignedlockablebuffer.md#buffer), `alignment`: number, `lock`: function, `rlock`: function): *[AlignedLockableBuffer](interfaces/alignedlockablebuffer.md)* -*Defined in [lib/aligned-lockable-buffer.ts:11](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L11)* +*Defined in [lib/aligned-lockable-buffer.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L20)* **Parameters:** -Name | Type | ------- | ------ | -`buf` | [Buffer](interfaces/alignedlockablebuffer.md#buffer) | -`mutex` | [RWMutex](README.md#rwmutex) | -`alignment` | number | +▪ **buf**: *[Buffer](interfaces/alignedlockablebuffer.md#buffer)* + +▪ **alignment**: *number* + +▪ **lock**: *function* + +▸ (): *Promise‹function›* + +▪ **rlock**: *function* + +▸ (): *Promise‹function›* **Returns:** *[AlignedLockableBuffer](interfaces/alignedlockablebuffer.md)* @@ -849,7 +792,7 @@ ___ ▸ **blockmapToBlocks**(`blockmap`: BlockMap): *[BlocksWithChecksum](interfaces/blockswithchecksum.md)[]* -*Defined in [lib/source-destination/zip.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L51)* +*Defined in [lib/source-destination/zip.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L51)* **Parameters:** @@ -865,7 +808,7 @@ ___ ▸ **blocksLength**(`blocks`: [BlocksWithChecksum](interfaces/blockswithchecksum.md)[]): *number* -*Defined in [lib/sparse-stream/shared.ts:139](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L139)* +*Defined in [lib/sparse-stream/shared.ts:139](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L139)* **Parameters:** @@ -881,7 +824,7 @@ ___ ▸ **blocksVerificationErrorMessage**(`blocksWithChecksum`: [BlocksWithChecksum](interfaces/blockswithchecksum.md), `checksum`: string): *string* -*Defined in [lib/errors.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L37)* +*Defined in [lib/errors.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L37)* **Parameters:** @@ -898,7 +841,7 @@ ___ ▸ **clean**(`device`: string): *Promise‹void›* -*Defined in [lib/diskpart.ts:86](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L86)* +*Defined in [lib/diskpart.ts:86](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L86)* **`summary`** Clean a device's partition tables @@ -921,7 +864,7 @@ ___ ▸ **configure**(`disk`: Disk, `options`: object): *Promise‹void›* -*Defined in [lib/source-destination/configured-source/configure.ts:87](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L87)* +*Defined in [lib/source-destination/configured-source/configure.ts:87](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L87)* **Parameters:** @@ -941,7 +884,7 @@ ___ ▸ **copy**(`sourceFs`: AsyncFsLike, `sourcePath`: string, `destinationFs`: AsyncFsLike, `destinationPath`: string): *Promise‹void›* -*Defined in [lib/source-destination/configured-source/operations/copy.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/copy.ts#L22)* +*Defined in [lib/source-destination/configured-source/operations/copy.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/copy.ts#L22)* **Parameters:** @@ -960,7 +903,7 @@ ___ ▸ **createBuffer**(`size`: number, `alignment`: number): *[AlignedLockableBuffer](interfaces/alignedlockablebuffer.md)* -*Defined in [lib/aligned-lockable-buffer.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L28)* +*Defined in [lib/aligned-lockable-buffer.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L34)* **Parameters:** @@ -977,7 +920,7 @@ ___ ▸ **createHasher**(`checksumType?`: [ChecksumType](README.md#checksumtype)): *undefined | [AnyHasher](README.md#anyhasher)* -*Defined in [lib/sparse-stream/shared.ts:77](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L77)* +*Defined in [lib/sparse-stream/shared.ts:77](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L77)* **Parameters:** @@ -993,7 +936,7 @@ ___ ▸ **createNetworkConfigFiles**(`networks`: any): *object* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L95)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L95)* **Parameters:** @@ -1021,7 +964,7 @@ ___ ▸ **createSparseReaderStateIterator**(`blocks`: [BlocksWithChecksum](interfaces/blockswithchecksum.md)[], `verify`: boolean, `generateChecksums`: boolean): *Iterator‹[SparseReaderState](interfaces/sparsereaderstate.md)›* -*Defined in [lib/sparse-stream/shared.ts:97](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L97)* +*Defined in [lib/sparse-stream/shared.ts:97](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L97)* **Parameters:** @@ -1039,7 +982,7 @@ ___ ▸ **difference**<**T**>(`setA`: Set‹T›, `setB`: Set‹T›): *Set‹T›* -*Defined in [lib/utils.ts:77](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/utils.ts#L77)* +*Defined in [lib/utils.ts:90](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/utils.ts#L90)* **Type parameters:** @@ -1060,7 +1003,7 @@ ___ ▸ **driveKey**(`drive`: $Drive): *string* -*Defined in [lib/scanner/adapters/block-device.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L47)* +*Defined in [lib/scanner/adapters/block-device.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L47)* **Parameters:** @@ -1076,7 +1019,7 @@ ___ ▸ **execFileAsync**(`command`: string, `args`: string[], `options`: ExecFileOptions): *Promise‹[ExecResult](interfaces/execresult.md)›* -*Defined in [lib/diskpart.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L36)* +*Defined in [lib/diskpart.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L36)* **Parameters:** @@ -1094,7 +1037,7 @@ ___ ▸ **execute**(`operation`: any, `disk`: Disk): *Promise‹void›* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:114](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L114)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:114](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L114)* **Parameters:** @@ -1107,7 +1050,7 @@ Name | Type | ▸ **execute**(`operation`: any, `disk`: Disk): *Promise‹void›* -*Defined in [lib/source-destination/configured-source/operations/copy.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/copy.ts#L39)* +*Defined in [lib/source-destination/configured-source/operations/copy.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/copy.ts#L39)* **Parameters:** @@ -1124,7 +1067,7 @@ ___ ▸ **executeOperation**(`operation`: [Operation](interfaces/operation.md), `disk`: Disk): *Promise‹void›* -*Defined in [lib/source-destination/configured-source/configure.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L43)* +*Defined in [lib/source-destination/configured-source/configure.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L43)* **Parameters:** @@ -1141,7 +1084,7 @@ ___ ▸ **getDiskDeviceType**(`disk`: Disk): *Promise‹any›* -*Defined in [lib/source-destination/configured-source/configure.ts:68](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L68)* +*Defined in [lib/source-destination/configured-source/configure.ts:68](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L68)* **Parameters:** @@ -1157,7 +1100,7 @@ ___ ▸ **getEta**(`current`: number, `total`: number, `speed`: number): *number | undefined* -*Defined in [lib/multi-write.ts:72](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L72)* +*Defined in [lib/multi-write.ts:72](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L72)* **Parameters:** @@ -1175,7 +1118,7 @@ ___ ▸ **getFileStreamFromZipStream**(`zipStream`: ReadableStream, `match`: function): *Promise‹ZipStreamEntry›* -*Defined in [lib/zip.ts:21](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/zip.ts#L21)* +*Defined in [lib/zip.ts:21](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/zip.ts#L21)* **Parameters:** @@ -1199,7 +1142,7 @@ ___ ▸ **getPartitionIndex**(`partition`: number | object): *number* -*Defined in [lib/source-destination/configured-source/configure.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L50)* +*Defined in [lib/source-destination/configured-source/configure.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L50)* **Parameters:** @@ -1215,7 +1158,7 @@ ___ ▸ **getRootStream**(`stream`: ReadableStream): *ReadableStream* -*Defined in [lib/source-destination/compressed-source.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L34)* +*Defined in [lib/source-destination/compressed-source.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L34)* **Parameters:** @@ -1231,7 +1174,7 @@ ___ ▸ **isAlignedLockableBuffer**(`buffer`: [Buffer](interfaces/alignedlockablebuffer.md#buffer)): *buffer is AlignedLockableBuffer* -*Defined in [lib/aligned-lockable-buffer.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L39)* +*Defined in [lib/aligned-lockable-buffer.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L47)* **Parameters:** @@ -1247,7 +1190,7 @@ ___ ▸ **isSourceTransform**(`stream`: any): *stream is SourceTransform* -*Defined in [lib/source-destination/compressed-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L30)* +*Defined in [lib/source-destination/compressed-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L30)* **Parameters:** @@ -1263,7 +1206,7 @@ ___ ▸ **isTransientError**(`error`: ErrnoException): *boolean* -*Defined in [lib/errors.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L65)* +*Defined in [lib/errors.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L65)* **`summary`** Determine whether an error is considered a transient occurrence, and the operation should be retried @@ -1286,7 +1229,7 @@ ___ ▸ **isntNull**(`x`: any): *boolean* -*Defined in [lib/source-destination/multi-destination.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L37)* +*Defined in [lib/source-destination/multi-destination.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L37)* **Parameters:** @@ -1302,7 +1245,7 @@ ___ ▸ **looksLikeComputeModule**(`description`: string): *boolean* -*Defined in [lib/scanner/adapters/block-device.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L38)* +*Defined in [lib/scanner/adapters/block-device.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L38)* **Parameters:** @@ -1318,7 +1261,7 @@ ___ ▸ **makeClassEmitProgressEvents**<**T**>(`Cls`: T, `attribute`: string, `positionAttribute`: string, `interval`: number): *(Anonymous class) & T* -*Defined in [lib/source-destination/progress.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L33)* +*Defined in [lib/source-destination/progress.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L33)* **Type parameters:** @@ -1341,7 +1284,7 @@ ___ ▸ **matchSupportedExtensions**(`filename`: string): *boolean* -*Defined in [lib/source-destination/zip.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L66)* +*Defined in [lib/source-destination/zip.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L66)* **Parameters:** @@ -1357,7 +1300,7 @@ ___ ▸ **nmWifiConfig**(`index`: number, `options`: [WifiConfig](interfaces/wificonfig.md)): *string* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L41)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L41)* **Parameters:** @@ -1370,21 +1313,11 @@ Name | Type | ___ -### noop - -▸ **noop**(): *void* - -*Defined in [lib/utils.ts:97](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/utils.ts#L97)* - -**Returns:** *void* - -___ - ### `Const` pad ▸ **pad**(`num`: number): *string* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L110)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L110)* **Parameters:** @@ -1400,7 +1333,7 @@ ___ ▸ **pipeRegularSourceToDestination**(`source`: [SourceDestination](classes/sourcedestination.md), `sourceMetadata`: [Metadata](interfaces/metadata.md), `destination`: [MultiDestination](classes/multidestination.md), `verify`: boolean, `numBuffers`: number, `updateState`: function, `onFail`: function, `onProgress`: function, `_onRootStreamProgress`: function): *Promise‹void›* -*Defined in [lib/multi-write.ts:224](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L224)* +*Defined in [lib/multi-write.ts:224](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L224)* **Parameters:** @@ -1462,7 +1395,7 @@ ___ ▸ **pipeSourceToDestinations**(`source`: [SourceDestination](classes/sourcedestination.md), `destinations`: [SourceDestination](classes/sourcedestination.md)[], `onFail`: [OnFailFunction](README.md#onfailfunction), `onProgress`: [OnProgressFunction](README.md#onprogressfunction), `verify`: boolean, `numBuffers`: number): *Promise‹[PipeSourceToDestinationsResult](interfaces/pipesourcetodestinationsresult.md)›* -*Defined in [lib/multi-write.ts:82](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L82)* +*Defined in [lib/multi-write.ts:82](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L82)* **Parameters:** @@ -1483,7 +1416,7 @@ ___ ▸ **pipeSparseSourceToDestination**(`source`: [SourceDestination](classes/sourcedestination.md), `destination`: [MultiDestination](classes/multidestination.md), `verify`: boolean, `numBuffers`: number, `updateState`: function, `onFail`: function, `onProgress`: function, `_onRootStreamProgress`: function): *Promise‹void›* -*Defined in [lib/multi-write.ts:328](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L328)* +*Defined in [lib/multi-write.ts:328](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L328)* **Parameters:** @@ -1543,7 +1476,7 @@ ___ ▸ **randomFilePath**(): *string* -*Defined in [lib/tmp.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/tmp.ts#L28)* +*Defined in [lib/tmp.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/tmp.ts#L27)* **Returns:** *string* @@ -1553,7 +1486,7 @@ ___ ▸ **runDiskpart**(`commands`: string[]): *Promise‹void›* -*Defined in [lib/diskpart.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L63)* +*Defined in [lib/diskpart.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L63)* **`summary`** Run a diskpart script @@ -1571,7 +1504,7 @@ ___ ▸ **runVerifier**(`verifier`: [Verifier](classes/verifier.md), `onFail`: function, `onProgress`: function): *Promise‹void›* -*Defined in [lib/multi-write.ts:366](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L366)* +*Defined in [lib/multi-write.ts:366](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L366)* **Parameters:** @@ -1605,7 +1538,7 @@ ___ ▸ **sparseStreamToBuffer**(`stream`: ReadableStream): *Promise‹[Buffer](interfaces/alignedlockablebuffer.md#buffer)›* -*Defined in [lib/utils.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/utils.ts#L48)* +*Defined in [lib/utils.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/utils.ts#L51)* **Parameters:** @@ -1621,7 +1554,7 @@ ___ ▸ **streamToBuffer**(`stream`: ReadableStream): *Promise‹[Buffer](interfaces/alignedlockablebuffer.md#buffer)›* -*Defined in [lib/utils.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/utils.ts#L20)* +*Defined in [lib/utils.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/utils.ts#L20)* **Parameters:** @@ -1637,7 +1570,7 @@ ___ ▸ **tmpFile**(`keepOpen`: boolean): *Promise‹[TmpFileResult](interfaces/tmpfileresult.md)›* -*Defined in [lib/tmp.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/tmp.ts#L37)* +*Defined in [lib/tmp.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/tmp.ts#L36)* **Parameters:** @@ -1653,7 +1586,7 @@ ___ ▸ **tmpFileDisposer**(`keepOpen`: boolean): *Disposer‹[TmpFileResult](interfaces/tmpfileresult.md)›* -*Defined in [lib/tmp.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/tmp.ts#L65)* +*Defined in [lib/tmp.ts:64](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/tmp.ts#L64)* **Parameters:** @@ -1669,7 +1602,7 @@ ___ ▸ **verifyOrGenerateChecksum**(`hasher`: [AnyHasher](README.md#anyhasher) | undefined, `blocks`: [BlocksWithChecksum](interfaces/blockswithchecksum.md), `verify`: boolean, `generateChecksums`: boolean): *void* -*Defined in [lib/sparse-stream/shared.ts:123](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L123)* +*Defined in [lib/sparse-stream/shared.ts:123](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L123)* **Parameters:** @@ -1688,16 +1621,16 @@ Name | Type | ### ▪ **ACTIONS**: *object* -*Defined in [lib/source-destination/configured-source/configure.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L38)* +*Defined in [lib/source-destination/configured-source/configure.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L38)* ### configure • **configure**: *execute* = configureAction -*Defined in [lib/source-destination/configured-source/configure.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L39)* +*Defined in [lib/source-destination/configured-source/configure.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L39)* ### copy • **copy**: *execute* = copyAction -*Defined in [lib/source-destination/configured-source/configure.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L40)* +*Defined in [lib/source-destination/configured-source/configure.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L40)* diff --git a/doc/classes/adapter.md b/doc/classes/adapter.md index 25a5b6de..08f22518 100644 --- a/doc/classes/adapter.md +++ b/doc/classes/adapter.md @@ -28,10 +28,12 @@ * [getMaxListeners](adapter.md#getmaxlisteners) * [listenerCount](adapter.md#listenercount) * [listeners](adapter.md#listeners) +* [off](adapter.md#off) * [on](adapter.md#on) * [once](adapter.md#once) * [prependListener](adapter.md#prependlistener) * [prependOnceListener](adapter.md#prependoncelistener) +* [rawListeners](adapter.md#rawlisteners) * [removeAllListeners](adapter.md#removealllisteners) * [removeListener](adapter.md#removelistener) * [setMaxListeners](adapter.md#setmaxlisteners) @@ -47,7 +49,7 @@ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -59,7 +61,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -87,7 +89,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -108,7 +110,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -122,7 +124,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -136,7 +138,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -156,7 +158,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -168,6 +170,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -176,7 +206,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -204,7 +234,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -232,7 +262,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -260,7 +290,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -280,6 +310,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -288,7 +338,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -308,7 +358,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -336,7 +386,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -352,7 +402,7 @@ ___ ▸ **start**(): *void* -*Defined in [lib/scanner/adapters/adapter.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L34)* +*Defined in [lib/scanner/adapters/adapter.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L34)* **Returns:** *void* @@ -362,7 +412,7 @@ ___ ▸ **stop**(): *void* -*Defined in [lib/scanner/adapters/adapter.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L35)* +*Defined in [lib/scanner/adapters/adapter.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L35)* **Returns:** *void* @@ -374,7 +424,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/alignedreadablestate.md b/doc/classes/alignedreadablestate.md index afc94179..bd203eba 100644 --- a/doc/classes/alignedreadablestate.md +++ b/doc/classes/alignedreadablestate.md @@ -30,7 +30,7 @@ \+ **new AlignedReadableState**(`bufferSize`: number, `alignment`: number, `numBuffers`: number): *[AlignedReadableState](alignedreadablestate.md)* -*Defined in [lib/aligned-lockable-buffer.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L47)* +*Defined in [lib/aligned-lockable-buffer.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L55)* **Parameters:** @@ -48,7 +48,7 @@ Name | Type | • **alignment**: *number* -*Defined in [lib/aligned-lockable-buffer.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L51)* +*Defined in [lib/aligned-lockable-buffer.ts:59](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L59)* ___ @@ -56,7 +56,7 @@ ___ • **bufferSize**: *number* -*Defined in [lib/aligned-lockable-buffer.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L50)* +*Defined in [lib/aligned-lockable-buffer.ts:58](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L58)* ___ @@ -64,7 +64,7 @@ ___ • **buffers**: *[AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md)[]* -*Defined in [lib/aligned-lockable-buffer.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L46)* +*Defined in [lib/aligned-lockable-buffer.ts:54](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L54)* ___ @@ -72,7 +72,7 @@ ___ • **currentBufferIndex**: *number* = 0 -*Defined in [lib/aligned-lockable-buffer.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L47)* +*Defined in [lib/aligned-lockable-buffer.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L55)* ___ @@ -80,7 +80,7 @@ ___ • **numBuffers**: *number* -*Defined in [lib/aligned-lockable-buffer.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L52)* +*Defined in [lib/aligned-lockable-buffer.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L60)* ## Methods @@ -88,6 +88,6 @@ ___ ▸ **getCurrentBuffer**(): *[AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md)* -*Defined in [lib/aligned-lockable-buffer.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L57)* +*Defined in [lib/aligned-lockable-buffer.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L65)* **Returns:** *[AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md)* diff --git a/doc/classes/balenas3source.md b/doc/classes/balenas3source.md index f403c2f9..4778560e 100644 --- a/doc/classes/balenas3source.md +++ b/doc/classes/balenas3source.md @@ -59,12 +59,14 @@ * [getUrl](balenas3source.md#private-geturl) * [listenerCount](balenas3source.md#listenercount) * [listeners](balenas3source.md#listeners) +* [off](balenas3source.md#off) * [on](balenas3source.md#on) * [once](balenas3source.md#once) * [open](balenas3source.md#open) * [prepare](balenas3source.md#private-prepare) * [prependListener](balenas3source.md#prependlistener) * [prependOnceListener](balenas3source.md#prependoncelistener) +* [rawListeners](balenas3source.md#rawlisteners) * [read](balenas3source.md#read) * [removeAllListeners](balenas3source.md#removealllisteners) * [removeListener](balenas3source.md#removelistener) @@ -79,7 +81,7 @@ \+ **new BalenaS3Source**(`bucket`: string, `deviceType`: string, `version`: string, `host`: string): *[BalenaS3Source](balenas3source.md)* -*Defined in [lib/source-destination/balena-s3-source.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L35)* +*Defined in [lib/source-destination/balena-s3-source.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L35)* **Parameters:** @@ -98,7 +100,7 @@ Name | Type | Default | • **bucket**: *string* -*Defined in [lib/source-destination/balena-s3-source.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L38)* +*Defined in [lib/source-destination/balena-s3-source.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L38)* ___ @@ -106,7 +108,7 @@ ___ • **deviceType**: *string* -*Defined in [lib/source-destination/balena-s3-source.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L39)* +*Defined in [lib/source-destination/balena-s3-source.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L39)* ___ @@ -114,7 +116,7 @@ ___ • **host**: *string* -*Defined in [lib/source-destination/balena-s3-source.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L41)* +*Defined in [lib/source-destination/balena-s3-source.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L41)* ___ @@ -122,7 +124,7 @@ ___ • **name**: *[Name](../README.md#name)* -*Defined in [lib/source-destination/balena-s3-source.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L35)* +*Defined in [lib/source-destination/balena-s3-source.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L35)* ___ @@ -130,7 +132,7 @@ ___ • **names**: *[Name](../README.md#name)[]* = ['balena', 'resin'] -*Defined in [lib/source-destination/balena-s3-source.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L34)* +*Defined in [lib/source-destination/balena-s3-source.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L34)* ___ @@ -138,7 +140,7 @@ ___ • **rawSource**: *[Http](http.md)* -*Defined in [lib/source-destination/balena-s3-source.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L31)* +*Defined in [lib/source-destination/balena-s3-source.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L31)* ___ @@ -146,7 +148,7 @@ ___ • **ready**: *Promise‹void›* -*Defined in [lib/source-destination/balena-s3-source.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L33)* +*Defined in [lib/source-destination/balena-s3-source.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L33)* ___ @@ -154,7 +156,7 @@ ___ • **version**: *string* -*Defined in [lib/source-destination/balena-s3-source.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L40)* +*Defined in [lib/source-destination/balena-s3-source.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L40)* ___ @@ -162,7 +164,7 @@ ___ • **zipSource**: *[ZipSource](zipsource.md)* -*Defined in [lib/source-destination/balena-s3-source.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L32)* +*Defined in [lib/source-destination/balena-s3-source.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L32)* ___ @@ -172,7 +174,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -193,7 +195,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -203,7 +205,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Methods @@ -213,7 +215,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/balena-s3-source.ts:120](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L120)* +*Defined in [lib/source-destination/balena-s3-source.ts:120](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L120)* **Returns:** *Promise‹void›* @@ -225,7 +227,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/balena-s3-source.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L110)* +*Defined in [lib/source-destination/balena-s3-source.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L110)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -237,7 +239,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/balena-s3-source.ts:115](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L115)* +*Defined in [lib/source-destination/balena-s3-source.ts:115](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L115)* **Returns:** *Promise‹void›* @@ -251,7 +253,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -277,7 +279,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/balena-s3-source.ts:74](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L74)* +*Defined in [lib/source-destination/balena-s3-source.ts:74](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L74)* **Returns:** *Promise‹boolean›* @@ -289,7 +291,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -301,7 +303,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -313,7 +315,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -325,7 +327,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/balena-s3-source.ts:78](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L78)* +*Defined in [lib/source-destination/balena-s3-source.ts:78](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L78)* **Returns:** *Promise‹boolean›* @@ -337,7 +339,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -349,7 +351,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -361,7 +363,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/balena-s3-source.ts:103](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L103)* +*Defined in [lib/source-destination/balena-s3-source.ts:103](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L103)* **Parameters:** @@ -379,7 +381,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -397,7 +399,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -417,7 +419,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -436,7 +438,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -458,7 +460,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -479,7 +481,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -491,7 +493,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -503,7 +505,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -515,7 +517,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -529,7 +531,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -541,7 +543,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -551,7 +553,7 @@ ___ ▸ **getName**(): *Promise‹[Name](../README.md#name)›* -*Defined in [lib/source-destination/balena-s3-source.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L60)* +*Defined in [lib/source-destination/balena-s3-source.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L60)* **Returns:** *Promise‹[Name](../README.md#name)›* @@ -563,7 +565,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -573,7 +575,7 @@ ___ ▸ **getUrl**(`path`: string): *string* -*Defined in [lib/source-destination/balena-s3-source.ts:82](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L82)* +*Defined in [lib/source-destination/balena-s3-source.ts:82](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L82)* **Parameters:** @@ -593,7 +595,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -613,7 +615,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -625,6 +627,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -633,7 +663,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -661,7 +691,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -687,7 +717,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -697,7 +727,7 @@ ___ ▸ **prepare**(): *Promise‹void›* -*Defined in [lib/source-destination/balena-s3-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L51)* +*Defined in [lib/source-destination/balena-s3-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L51)* **Returns:** *Promise‹void›* @@ -711,7 +741,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -739,7 +769,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -759,13 +789,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `sourceOffset`: number): *Promise‹ReadResult›* *Overrides [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/balena-s3-source.ts:88](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/balena-s3-source.ts#L88)* +*Defined in [lib/source-destination/balena-s3-source.ts:88](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/balena-s3-source.ts#L88)* **Parameters:** @@ -788,7 +838,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -808,7 +858,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -836,7 +886,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -854,7 +904,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -875,7 +925,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -894,7 +946,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/blockdevice.md b/doc/classes/blockdevice.md index dae93e31..e905f7b5 100644 --- a/doc/classes/blockdevice.md +++ b/doc/classes/blockdevice.md @@ -23,7 +23,7 @@ * [alignment](blockdevice.md#alignment) * [drive](blockdevice.md#private-drive) * [emitsProgress](blockdevice.md#emitsprogress) -* [fd](blockdevice.md#protected-fd) +* [fileHandle](blockdevice.md#protected-filehandle) * [oDirect](blockdevice.md#odirect) * [oWrite](blockdevice.md#owrite) * [path](blockdevice.md#path) @@ -75,12 +75,14 @@ * [getPartitionTable](blockdevice.md#getpartitiontable) * [listenerCount](blockdevice.md#listenercount) * [listeners](blockdevice.md#listeners) +* [off](blockdevice.md#off) * [offsetIsAligned](blockdevice.md#private-offsetisaligned) * [on](blockdevice.md#on) * [once](blockdevice.md#once) * [open](blockdevice.md#open) * [prependListener](blockdevice.md#prependlistener) * [prependOnceListener](blockdevice.md#prependoncelistener) +* [rawListeners](blockdevice.md#rawlisteners) * [read](blockdevice.md#read) * [removeAllListeners](blockdevice.md#removealllisteners) * [removeListener](blockdevice.md#removelistener) @@ -93,20 +95,22 @@ ### constructor -\+ **new BlockDevice**(`drive`: [DrivelistDrive](../interfaces/drivelistdrive.md), `unmountOnSuccess`: boolean, `oWrite`: boolean, `oDirect`: boolean): *[BlockDevice](blockdevice.md)* +\+ **new BlockDevice**(`__namedParameters`: object): *[BlockDevice](blockdevice.md)* *Overrides [File](file.md).[constructor](file.md#constructor)* -*Defined in [lib/source-destination/block-device.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L47)* +*Defined in [lib/source-destination/block-device.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L50)* **Parameters:** +▪ **__namedParameters**: *object* + Name | Type | Default | ------ | ------ | ------ | -`drive` | [DrivelistDrive](../interfaces/drivelistdrive.md) | - | +`direct` | boolean | true | +`drive` | Drive | - | `unmountOnSuccess` | boolean | false | -`oWrite` | boolean | false | -`oDirect` | boolean | true | +`write` | boolean | false | **Returns:** *[BlockDevice](blockdevice.md)* @@ -116,7 +120,7 @@ Name | Type | Default | • **alignment**: *number* -*Defined in [lib/source-destination/block-device.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L47)* +*Defined in [lib/source-destination/block-device.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L50)* ___ @@ -124,7 +128,7 @@ ___ • **drive**: *[DrivelistDrive](../interfaces/drivelistdrive.md)* -*Defined in [lib/source-destination/block-device.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L50)* +*Defined in [lib/source-destination/block-device.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L46)* ___ @@ -134,17 +138,17 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[emitsProgress](../interfaces/adaptersourcedestination.md#emitsprogress)* -*Defined in [lib/source-destination/block-device.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L46)* +*Defined in [lib/source-destination/block-device.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L49)* ___ -### `Protected` fd +### `Protected` fileHandle -• **fd**: *number* +• **fileHandle**: *fs.FileHandle* -*Inherited from [File](file.md).[fd](file.md#protected-fd)* +*Inherited from [File](file.md).[fileHandle](file.md#protected-filehandle)* -*Defined in [lib/source-destination/file.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L51)* +*Defined in [lib/source-destination/file.ts:54](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L54)* ___ @@ -152,7 +156,7 @@ ___ • **oDirect**: *boolean* -*Defined in [lib/source-destination/block-device.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L53)* +*Defined in [lib/source-destination/block-device.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L48)* ___ @@ -162,7 +166,7 @@ ___ *Inherited from [File](file.md).[oWrite](file.md#owrite)* -*Defined in [lib/source-destination/file.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L53)* +*Defined in [lib/source-destination/file.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L53)* ___ @@ -172,7 +176,7 @@ ___ *Inherited from [File](file.md).[path](file.md#path)* -*Defined in [lib/source-destination/file.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L53)* +*Defined in [lib/source-destination/file.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L52)* ___ @@ -180,7 +184,7 @@ ___ • **unmountOnSuccess**: *boolean* -*Defined in [lib/source-destination/block-device.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L51)* +*Defined in [lib/source-destination/block-device.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L47)* ___ @@ -192,7 +196,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -215,7 +219,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -227,7 +231,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Accessors @@ -235,7 +239,7 @@ ___ • **get description**(): *string* -*Defined in [lib/source-destination/block-device.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L95)* +*Defined in [lib/source-destination/block-device.ts:111](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L111)* **Returns:** *string* @@ -245,7 +249,7 @@ ___ • **get device**(): *string* -*Defined in [lib/source-destination/block-device.ts:87](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L87)* +*Defined in [lib/source-destination/block-device.ts:103](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L103)* **Returns:** *string* @@ -255,7 +259,7 @@ ___ • **get devicePath**(): *string | null* -*Defined in [lib/source-destination/block-device.ts:91](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L91)* +*Defined in [lib/source-destination/block-device.ts:107](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L107)* **Returns:** *string | null* @@ -265,7 +269,7 @@ ___ • **get isSystem**(): *boolean* -*Defined in [lib/source-destination/block-device.ts:79](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L79)* +*Defined in [lib/source-destination/block-device.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L95)* **Returns:** *boolean* @@ -275,7 +279,7 @@ ___ • **get mountpoints**(): *Array‹object›* -*Defined in [lib/source-destination/block-device.ts:99](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L99)* +*Defined in [lib/source-destination/block-device.ts:115](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L115)* **Returns:** *Array‹object›* @@ -285,7 +289,7 @@ ___ • **get raw**(): *string* -*Defined in [lib/source-destination/block-device.ts:83](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L83)* +*Defined in [lib/source-destination/block-device.ts:99](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L99)* **Returns:** *string* @@ -295,7 +299,7 @@ ___ • **get size**(): *number | null* -*Defined in [lib/source-destination/block-device.ts:103](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L103)* +*Defined in [lib/source-destination/block-device.ts:119](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L119)* **Returns:** *number | null* @@ -309,7 +313,7 @@ ___ *Overrides [File](file.md).[_close](file.md#protected-_close)* -*Defined in [lib/source-destination/block-device.ts:158](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L158)* +*Defined in [lib/source-destination/block-device.ts:174](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L174)* **Returns:** *Promise‹void›* @@ -323,7 +327,7 @@ ___ *Overrides [File](file.md).[_getMetadata](file.md#protected-_getmetadata)* -*Defined in [lib/source-destination/block-device.ts:107](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L107)* +*Defined in [lib/source-destination/block-device.ts:123](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L123)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -337,7 +341,7 @@ ___ *Overrides [File](file.md).[_open](file.md#protected-_open)* -*Defined in [lib/source-destination/block-device.ts:149](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L149)* +*Defined in [lib/source-destination/block-device.ts:165](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L165)* **Returns:** *Promise‹void›* @@ -351,7 +355,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -375,7 +379,7 @@ ___ ▸ **alignOffsetAfter**(`offset`: number): *number* -*Defined in [lib/source-destination/block-device.ts:179](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L179)* +*Defined in [lib/source-destination/block-device.ts:195](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L195)* **Parameters:** @@ -391,7 +395,7 @@ ___ ▸ **alignOffsetBefore**(`offset`: number): *number* -*Defined in [lib/source-destination/block-device.ts:175](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L175)* +*Defined in [lib/source-destination/block-device.ts:191](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L191)* **Parameters:** @@ -407,7 +411,7 @@ ___ ▸ **alignedRead**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `sourceOffset`: number): *Promise‹ReadResult›* -*Defined in [lib/source-destination/block-device.ts:183](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L183)* +*Defined in [lib/source-destination/block-device.ts:199](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L199)* **Parameters:** @@ -426,7 +430,7 @@ ___ ▸ **alignedWrite**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `fileOffset`: number): *Promise‹WriteResult›* -*Defined in [lib/source-destination/block-device.ts:216](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L216)* +*Defined in [lib/source-destination/block-device.ts:232](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L232)* **Parameters:** @@ -451,7 +455,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/file.ts:69](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L69)* +*Defined in [lib/source-destination/file.ts:74](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L74)* **Returns:** *Promise‹boolean›* @@ -465,7 +469,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -479,7 +483,7 @@ ___ *Overrides [File](file.md).[canCreateSparseWriteStream](file.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/block-device.ts:121](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L121)* +*Defined in [lib/source-destination/block-device.ts:137](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L137)* **Returns:** *Promise‹boolean›* @@ -493,7 +497,7 @@ ___ *Overrides [File](file.md).[canCreateWriteStream](file.md#cancreatewritestream)* -*Defined in [lib/source-destination/block-device.ts:117](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L117)* +*Defined in [lib/source-destination/block-device.ts:133](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L133)* **Returns:** *Promise‹boolean›* @@ -509,7 +513,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/file.ts:61](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L61)* +*Defined in [lib/source-destination/file.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L66)* **Returns:** *Promise‹boolean›* @@ -523,7 +527,7 @@ ___ *Overrides [File](file.md).[canWrite](file.md#canwrite)* -*Defined in [lib/source-destination/block-device.ts:113](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L113)* +*Defined in [lib/source-destination/block-device.ts:129](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L129)* **Returns:** *Promise‹boolean›* @@ -537,7 +541,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -551,7 +555,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/file.ts:117](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L117)* +*Defined in [lib/source-destination/file.ts:167](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L167)* **Parameters:** @@ -577,7 +581,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -595,7 +599,7 @@ ___ *Overrides [File](file.md).[createSparseWriteStream](file.md#createsparsewritestream)* -*Defined in [lib/source-destination/block-device.ts:137](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L137)* +*Defined in [lib/source-destination/block-device.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L153)* **Parameters:** @@ -617,7 +621,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -636,7 +640,7 @@ ___ *Overrides [File](file.md).[createWriteStream](file.md#createwritestream)* -*Defined in [lib/source-destination/block-device.ts:125](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L125)* +*Defined in [lib/source-destination/block-device.ts:141](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L141)* **Parameters:** @@ -660,7 +664,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -683,7 +687,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -697,7 +701,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/block-device.ts:59](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L59)* +*Defined in [lib/source-destination/block-device.ts:70](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L70)* **Returns:** *undefined | number* @@ -711,7 +715,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -725,7 +729,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -741,7 +745,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -755,7 +759,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -767,7 +771,7 @@ ___ *Overrides [File](file.md).[getOpenFlags](file.md#protected-getopenflags)* -*Defined in [lib/source-destination/block-device.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L65)* +*Defined in [lib/source-destination/block-device.ts:76](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L76)* **Returns:** *number* @@ -781,7 +785,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -797,7 +801,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -819,7 +823,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -831,11 +835,39 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### `Private` offsetIsAligned ▸ **offsetIsAligned**(`offset`: number): *boolean* -*Defined in [lib/source-destination/block-device.ts:171](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L171)* +*Defined in [lib/source-destination/block-device.ts:187](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L187)* **Parameters:** @@ -855,7 +887,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -883,7 +915,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -911,7 +943,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -925,7 +957,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -953,7 +985,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -973,6 +1005,28 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md)* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `sourceOffset`: number): *Promise‹ReadResult›* @@ -981,7 +1035,7 @@ ___ *Overrides [File](file.md).[read](file.md#read)* -*Defined in [lib/source-destination/block-device.ts:203](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L203)* +*Defined in [lib/source-destination/block-device.ts:219](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L219)* **Parameters:** @@ -1006,7 +1060,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -1026,7 +1080,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -1056,7 +1110,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1076,7 +1130,7 @@ ___ *Overrides [File](file.md).[write](file.md#write)* -*Defined in [lib/source-destination/block-device.ts:232](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/block-device.ts#L232)* +*Defined in [lib/source-destination/block-device.ts:248](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/block-device.ts#L248)* **Parameters:** @@ -1099,7 +1153,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -1120,7 +1176,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/blockdeviceadapter.md b/doc/classes/blockdeviceadapter.md index 49b793b7..b40db7fa 100644 --- a/doc/classes/blockdeviceadapter.md +++ b/doc/classes/blockdeviceadapter.md @@ -34,10 +34,12 @@ * [listDrives](blockdeviceadapter.md#private-listdrives) * [listenerCount](blockdeviceadapter.md#listenercount) * [listeners](blockdeviceadapter.md#listeners) +* [off](blockdeviceadapter.md#off) * [on](blockdeviceadapter.md#on) * [once](blockdeviceadapter.md#once) * [prependListener](blockdeviceadapter.md#prependlistener) * [prependOnceListener](blockdeviceadapter.md#prependoncelistener) +* [rawListeners](blockdeviceadapter.md#rawlisteners) * [removeAllListeners](blockdeviceadapter.md#removealllisteners) * [removeListener](blockdeviceadapter.md#removelistener) * [scan](blockdeviceadapter.md#private-scan) @@ -51,21 +53,20 @@ ### constructor -\+ **new BlockDeviceAdapter**(`includeSystemDrives`: function, `unmountOnSuccess`: boolean, `oWrite`: boolean, `oDirect`: boolean): *[BlockDeviceAdapter](blockdeviceadapter.md)* +\+ **new BlockDeviceAdapter**(`__namedParameters`: object): *[BlockDeviceAdapter](blockdeviceadapter.md)* -*Defined in [lib/scanner/adapters/block-device.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L60)* +*Defined in [lib/scanner/adapters/block-device.ts:64](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L64)* **Parameters:** -▪`Default value` **includeSystemDrives**: *function*= () => false +▪ **__namedParameters**: *object* -▸ (): *boolean* - -▪`Default value` **unmountOnSuccess**: *boolean*= false - -▪`Default value` **oWrite**: *boolean*= false - -▪`Default value` **oDirect**: *boolean*= true +Name | Type | Default | +------ | ------ | ------ | +`direct` | boolean | true | +`unmountOnSuccess` | boolean | false | +`write` | boolean | false | +`includeSystemDrives` | | - | **Returns:** *[BlockDeviceAdapter](blockdeviceadapter.md)* @@ -75,7 +76,7 @@ • **drives**: *Map‹string, [BlockDevice](blockdevice.md)›* = new Map() -*Defined in [lib/scanner/adapters/block-device.ts:58](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L58)* +*Defined in [lib/scanner/adapters/block-device.ts:62](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L62)* ___ @@ -83,7 +84,7 @@ ___ • **includeSystemDrives**: *function* -*Defined in [lib/scanner/adapters/block-device.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L63)* +*Defined in [lib/scanner/adapters/block-device.ts:58](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L58)* #### Type declaration: @@ -95,7 +96,7 @@ ___ • **oDirect**: *boolean* -*Defined in [lib/scanner/adapters/block-device.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L66)* +*Defined in [lib/scanner/adapters/block-device.ts:61](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L61)* ___ @@ -103,7 +104,7 @@ ___ • **oWrite**: *boolean* -*Defined in [lib/scanner/adapters/block-device.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L65)* +*Defined in [lib/scanner/adapters/block-device.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L60)* ___ @@ -111,7 +112,7 @@ ___ • **ready**: *boolean* = false -*Defined in [lib/scanner/adapters/block-device.ts:60](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L60)* +*Defined in [lib/scanner/adapters/block-device.ts:64](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L64)* ___ @@ -119,7 +120,7 @@ ___ • **running**: *boolean* = false -*Defined in [lib/scanner/adapters/block-device.ts:59](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L59)* +*Defined in [lib/scanner/adapters/block-device.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L63)* ___ @@ -127,7 +128,7 @@ ___ • **unmountOnSuccess**: *boolean* -*Defined in [lib/scanner/adapters/block-device.ts:64](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L64)* +*Defined in [lib/scanner/adapters/block-device.ts:59](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L59)* ___ @@ -137,7 +138,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -149,7 +150,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -177,7 +178,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -198,7 +199,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -212,7 +213,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -222,7 +223,7 @@ ___ ▸ **listDrives**(): *Promise‹Map‹string, [DrivelistDrive](../interfaces/drivelistdrive.md)››* -*Defined in [lib/scanner/adapters/block-device.ts:117](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L117)* +*Defined in [lib/scanner/adapters/block-device.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L130)* **Returns:** *Promise‹Map‹string, [DrivelistDrive](../interfaces/drivelistdrive.md)››* @@ -236,7 +237,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -256,7 +257,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -268,6 +269,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -276,7 +305,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -304,7 +333,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -332,7 +361,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -360,7 +389,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -380,6 +409,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -388,7 +437,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -408,7 +457,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -432,7 +481,7 @@ ___ ▸ **scan**(): *Promise‹void›* -*Defined in [lib/scanner/adapters/block-device.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L93)* +*Defined in [lib/scanner/adapters/block-device.ts:106](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L106)* **Returns:** *Promise‹void›* @@ -442,7 +491,7 @@ ___ ▸ **scanLoop**(): *Promise‹void›* -*Defined in [lib/scanner/adapters/block-device.ts:82](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L82)* +*Defined in [lib/scanner/adapters/block-device.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L95)* **Returns:** *Promise‹void›* @@ -456,7 +505,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -474,7 +523,7 @@ ___ *Overrides [Adapter](adapter.md).[start](adapter.md#abstract-start)* -*Defined in [lib/scanner/adapters/block-device.ts:71](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L71)* +*Defined in [lib/scanner/adapters/block-device.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L84)* **Returns:** *void* @@ -486,7 +535,7 @@ ___ *Overrides [Adapter](adapter.md).[stop](adapter.md#abstract-stop)* -*Defined in [lib/scanner/adapters/block-device.ts:76](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L76)* +*Defined in [lib/scanner/adapters/block-device.ts:89](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L89)* **Returns:** *void* @@ -498,7 +547,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/blockreadstream.md b/doc/classes/blockreadstream.md index f04d7985..3bccb715 100644 --- a/doc/classes/blockreadstream.md +++ b/doc/classes/blockreadstream.md @@ -26,11 +26,13 @@ * [maxRetries](blockreadstream.md#private-maxretries) * [readable](blockreadstream.md#readable) * [readableHighWaterMark](blockreadstream.md#readablehighwatermark) +* [readableLength](blockreadstream.md#readablelength) * [source](blockreadstream.md#private-source) * [defaultMaxListeners](blockreadstream.md#static-defaultmaxlisteners) ### Methods +* [[Symbol.asyncIterator]](blockreadstream.md#[symbol.asynciterator]) * [_destroy](blockreadstream.md#_destroy) * [_read](blockreadstream.md#_read) * [addListener](blockreadstream.md#addlistener) @@ -41,6 +43,7 @@ * [isPaused](blockreadstream.md#ispaused) * [listenerCount](blockreadstream.md#listenercount) * [listeners](blockreadstream.md#listeners) +* [off](blockreadstream.md#off) * [on](blockreadstream.md#on) * [once](blockreadstream.md#once) * [pause](blockreadstream.md#pause) @@ -48,6 +51,7 @@ * [prependListener](blockreadstream.md#prependlistener) * [prependOnceListener](blockreadstream.md#prependoncelistener) * [push](blockreadstream.md#push) +* [rawListeners](blockreadstream.md#rawlisteners) * [read](blockreadstream.md#read) * [removeAllListeners](blockreadstream.md#removealllisteners) * [removeListener](blockreadstream.md#removelistener) @@ -68,7 +72,7 @@ *Overrides void* -*Defined in [lib/block-read-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L36)* +*Defined in [lib/block-read-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L36)* **Parameters:** @@ -92,7 +96,7 @@ Name | Type | Default | • **alignedReadableState**: *[AlignedReadableState](alignedreadablestate.md)* -*Defined in [lib/block-read-stream.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L33)* +*Defined in [lib/block-read-stream.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L33)* ___ @@ -100,7 +104,7 @@ ___ • **bytesRead**: *number* = 0 -*Defined in [lib/block-read-stream.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L34)* +*Defined in [lib/block-read-stream.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L34)* ___ @@ -108,7 +112,7 @@ ___ • **end**: *number* -*Defined in [lib/block-read-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L35)* +*Defined in [lib/block-read-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L35)* ___ @@ -116,7 +120,7 @@ ___ • **maxRetries**: *number* -*Defined in [lib/block-read-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L36)* +*Defined in [lib/block-read-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L36)* ___ @@ -126,7 +130,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readable](sparsefilterstream.md#readable)* -Defined in node_modules/@types/node/base.d.ts:5422 +Defined in node_modules/@types/node/stream.d.ts:20 ___ @@ -136,7 +140,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readableHighWaterMark](sparsefilterstream.md#readablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5423 +Defined in node_modules/@types/node/stream.d.ts:21 + +___ + +### readableLength + +• **readableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[readableLength](sparsefilterstream.md#readablelength)* + +Defined in node_modules/@types/node/stream.d.ts:22 ___ @@ -144,7 +158,7 @@ ___ • **source**: *[File](file.md)* -*Defined in [lib/block-read-stream.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L32)* +*Defined in [lib/block-read-stream.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L32)* ___ @@ -154,17 +168,29 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹any›* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[[Symbol.asyncIterator]](sparsefilterstream.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/stream.d.ts:95 + +**Returns:** *AsyncIterableIterator‹any›* + +___ + ### _destroy ▸ **_destroy**(`error`: [Error](notcapable.md#static-error) | null, `callback`: function): *void* *Inherited from [SparseReadStream](sparsereadstream.md).[_destroy](sparsereadstream.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5435 +Defined in node_modules/@types/node/stream.d.ts:34 **Parameters:** @@ -172,13 +198,13 @@ Defined in node_modules/@types/node/base.d.ts:5435 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -190,7 +216,7 @@ ___ *Overrides [SparseFilterStream](sparsefilterstream.md).[_read](sparsefilterstream.md#_read)* -*Defined in [lib/block-read-stream.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L92)* +*Defined in [lib/block-read-stream.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L92)* **Returns:** *Promise‹void›* @@ -198,13 +224,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5447 +Defined in node_modules/@types/node/stream.d.ts:46 Event emitter The defined events on documents including: @@ -216,30 +242,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5448 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -254,7 +256,7 @@ Defined in node_modules/@types/node/base.d.ts:5448 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5449 +Defined in node_modules/@types/node/stream.d.ts:47 **Parameters:** @@ -262,13 +264,13 @@ Defined in node_modules/@types/node/base.d.ts:5449 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -278,7 +280,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5450 +Defined in node_modules/@types/node/stream.d.ts:48 **Parameters:** @@ -296,7 +298,7 @@ Defined in node_modules/@types/node/base.d.ts:5450 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5451 +Defined in node_modules/@types/node/stream.d.ts:49 **Parameters:** @@ -314,7 +316,7 @@ Defined in node_modules/@types/node/base.d.ts:5451 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5452 +Defined in node_modules/@types/node/stream.d.ts:50 **Parameters:** @@ -332,44 +334,51 @@ Name | Type | **Returns:** *this* -___ +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* -### destroy +*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* -▸ **destroy**(`error?`: [Error](notcapable.md#static-error)): *void* +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -*Inherited from [SparseReadStream](sparsereadstream.md).[destroy](sparsereadstream.md#destroy)* +Defined in node_modules/@types/node/stream.d.ts:51 -Defined in node_modules/@types/node/base.d.ts:5436 +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`...args` | any[] | -**Returns:** *void* +**Returns:** *this* ___ -### emit - -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* +### destroy -*Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* +▸ **destroy**(`error?`: [Error](notcapable.md#static-error)): *void* -*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[destroy](sparsefilterstream.md#destroy)* -Defined in node_modules/@types/node/base.d.ts:5454 +Defined in node_modules/@types/node/stream.d.ts:35 **Parameters:** Name | Type | ------ | ------ | -`event` | string | symbol | -`...args` | any[] | +`error?` | [Error](notcapable.md#static-error) | -**Returns:** *boolean* +**Returns:** *void* + +___ + +### emit ▸ **emit**(`event`: "close"): *boolean* @@ -377,7 +386,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5455 +Defined in node_modules/@types/node/stream.d.ts:53 **Parameters:** @@ -387,20 +396,20 @@ Name | Type | **Returns:** *boolean* -▸ **emit**(`event`: "data", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "data", `chunk`: any): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5456 +Defined in node_modules/@types/node/stream.d.ts:54 **Parameters:** Name | Type | ------ | ------ | `event` | "data" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *boolean* @@ -410,7 +419,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5457 +Defined in node_modules/@types/node/stream.d.ts:55 **Parameters:** @@ -426,7 +435,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5458 +Defined in node_modules/@types/node/stream.d.ts:56 **Parameters:** @@ -442,7 +451,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5459 +Defined in node_modules/@types/node/stream.d.ts:57 **Parameters:** @@ -453,6 +462,23 @@ Name | Type | **Returns:** *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* + +*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* + +Defined in node_modules/@types/node/stream.d.ts:58 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | +`...args` | any[] | + +**Returns:** *boolean* + ___ ### eventNames @@ -461,7 +487,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -473,7 +499,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -485,7 +511,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[isPaused](sparsefilterstream.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:5430 +Defined in node_modules/@types/node/stream.d.ts:29 **Returns:** *boolean* @@ -497,7 +523,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -515,7 +541,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -527,19 +553,17 @@ Name | Type | ___ -### on - -▸ **on**(`event`: string, `listener`: function): *this* +### off -*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -Defined in node_modules/@types/node/base.d.ts:5461 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -553,13 +577,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5462 +Defined in node_modules/@types/node/stream.d.ts:60 **Parameters:** @@ -577,7 +605,7 @@ Defined in node_modules/@types/node/base.d.ts:5462 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5463 +Defined in node_modules/@types/node/stream.d.ts:61 **Parameters:** @@ -585,13 +613,13 @@ Defined in node_modules/@types/node/base.d.ts:5463 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -601,7 +629,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5464 +Defined in node_modules/@types/node/stream.d.ts:62 **Parameters:** @@ -619,7 +647,7 @@ Defined in node_modules/@types/node/base.d.ts:5464 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5465 +Defined in node_modules/@types/node/stream.d.ts:63 **Parameters:** @@ -637,7 +665,7 @@ Defined in node_modules/@types/node/base.d.ts:5465 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5466 +Defined in node_modules/@types/node/stream.d.ts:64 **Parameters:** @@ -655,21 +683,17 @@ Name | Type | **Returns:** *this* -___ - -### once - -▸ **once**(`event`: string, `listener`: function): *this* +▸ **on**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5468 +Defined in node_modules/@types/node/stream.d.ts:65 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -683,13 +707,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5469 +Defined in node_modules/@types/node/stream.d.ts:67 **Parameters:** @@ -707,7 +735,7 @@ Defined in node_modules/@types/node/base.d.ts:5469 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5470 +Defined in node_modules/@types/node/stream.d.ts:68 **Parameters:** @@ -715,13 +743,13 @@ Defined in node_modules/@types/node/base.d.ts:5470 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -731,7 +759,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5471 +Defined in node_modules/@types/node/stream.d.ts:69 **Parameters:** @@ -749,7 +777,7 @@ Defined in node_modules/@types/node/base.d.ts:5471 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5472 +Defined in node_modules/@types/node/stream.d.ts:70 **Parameters:** @@ -767,7 +795,7 @@ Defined in node_modules/@types/node/base.d.ts:5472 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5473 +Defined in node_modules/@types/node/stream.d.ts:71 **Parameters:** @@ -785,6 +813,30 @@ Name | Type | **Returns:** *this* +▸ **once**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* + +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* + +Defined in node_modules/@types/node/stream.d.ts:72 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### pause @@ -793,7 +845,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[pause](sparsefilterstream.md#pause)* -Defined in node_modules/@types/node/base.d.ts:5428 +Defined in node_modules/@types/node/stream.d.ts:27 **Returns:** *this* @@ -805,7 +857,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:5407 +Defined in node_modules/@types/node/stream.d.ts:5 **Type parameters:** @@ -824,37 +876,13 @@ ___ ### prependListener -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* - -Defined in node_modules/@types/node/base.d.ts:5475 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **prependListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5476 +Defined in node_modules/@types/node/stream.d.ts:74 **Parameters:** @@ -872,7 +900,7 @@ Defined in node_modules/@types/node/base.d.ts:5476 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5477 +Defined in node_modules/@types/node/stream.d.ts:75 **Parameters:** @@ -880,13 +908,13 @@ Defined in node_modules/@types/node/base.d.ts:5477 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -896,7 +924,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5478 +Defined in node_modules/@types/node/stream.d.ts:76 **Parameters:** @@ -914,7 +942,7 @@ Defined in node_modules/@types/node/base.d.ts:5478 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5479 +Defined in node_modules/@types/node/stream.d.ts:77 **Parameters:** @@ -932,7 +960,7 @@ Defined in node_modules/@types/node/base.d.ts:5479 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5480 +Defined in node_modules/@types/node/stream.d.ts:78 **Parameters:** @@ -950,21 +978,17 @@ Name | Type | **Returns:** *this* -___ - -### prependOnceListener - -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5482 +Defined in node_modules/@types/node/stream.d.ts:79 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -978,13 +1002,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5483 +Defined in node_modules/@types/node/stream.d.ts:81 **Parameters:** @@ -1002,7 +1030,7 @@ Defined in node_modules/@types/node/base.d.ts:5483 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5484 +Defined in node_modules/@types/node/stream.d.ts:82 **Parameters:** @@ -1010,13 +1038,13 @@ Defined in node_modules/@types/node/base.d.ts:5484 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1026,7 +1054,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5485 +Defined in node_modules/@types/node/stream.d.ts:83 **Parameters:** @@ -1044,7 +1072,7 @@ Defined in node_modules/@types/node/base.d.ts:5485 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5486 +Defined in node_modules/@types/node/stream.d.ts:84 **Parameters:** @@ -1062,7 +1090,7 @@ Defined in node_modules/@types/node/base.d.ts:5486 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5487 +Defined in node_modules/@types/node/stream.d.ts:85 **Parameters:** @@ -1080,6 +1108,30 @@ Name | Type | **Returns:** *this* +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* + +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* + +Defined in node_modules/@types/node/stream.d.ts:86 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### push @@ -1088,7 +1140,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[push](sparsefilterstream.md#push)* -Defined in node_modules/@types/node/base.d.ts:5434 +Defined in node_modules/@types/node/stream.d.ts:33 **Parameters:** @@ -1101,13 +1153,31 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`size?`: undefined | number): *any* *Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* -Defined in node_modules/@types/node/base.d.ts:5426 +Defined in node_modules/@types/node/stream.d.ts:25 **Parameters:** @@ -1125,7 +1195,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -1139,37 +1209,13 @@ ___ ### removeListener -▸ **removeListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* - -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5489 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5490 +Defined in node_modules/@types/node/stream.d.ts:88 **Parameters:** @@ -1187,7 +1233,7 @@ Defined in node_modules/@types/node/base.d.ts:5490 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5491 +Defined in node_modules/@types/node/stream.d.ts:89 **Parameters:** @@ -1195,13 +1241,13 @@ Defined in node_modules/@types/node/base.d.ts:5491 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1211,7 +1257,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5492 +Defined in node_modules/@types/node/stream.d.ts:90 **Parameters:** @@ -1229,7 +1275,7 @@ Defined in node_modules/@types/node/base.d.ts:5492 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5493 +Defined in node_modules/@types/node/stream.d.ts:91 **Parameters:** @@ -1247,7 +1293,7 @@ Defined in node_modules/@types/node/base.d.ts:5493 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5494 +Defined in node_modules/@types/node/stream.d.ts:92 **Parameters:** @@ -1265,6 +1311,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:93 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### resume @@ -1273,7 +1343,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[resume](sparsefilterstream.md#resume)* -Defined in node_modules/@types/node/base.d.ts:5429 +Defined in node_modules/@types/node/stream.d.ts:28 **Returns:** *this* @@ -1285,7 +1355,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setEncoding](sparsefilterstream.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:5427 +Defined in node_modules/@types/node/stream.d.ts:26 **Parameters:** @@ -1303,7 +1373,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1319,7 +1389,7 @@ ___ ▸ **tryRead**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer)): *Promise‹ReadResult›* -*Defined in [lib/block-read-stream.ts:71](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-read-stream.ts#L71)* +*Defined in [lib/block-read-stream.ts:71](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-read-stream.ts#L71)* **Parameters:** @@ -1333,21 +1403,17 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: NodeJS.WritableStream): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[unpipe](sparsefilterstream.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:5431 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/stream.d.ts:30 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | NodeJS.WritableStream | **Returns:** *this* @@ -1359,7 +1425,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[unshift](sparsefilterstream.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:5432 +Defined in node_modules/@types/node/stream.d.ts:31 **Parameters:** @@ -1377,7 +1443,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[wrap](sparsefilterstream.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:5433 +Defined in node_modules/@types/node/stream.d.ts:32 **Parameters:** @@ -1395,7 +1461,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/blocksverificationerror.md b/doc/classes/blocksverificationerror.md index f4016623..37a74835 100644 --- a/doc/classes/blocksverificationerror.md +++ b/doc/classes/blocksverificationerror.md @@ -29,7 +29,7 @@ \+ **new BlocksVerificationError**(`blocks`: [BlocksWithChecksum](../interfaces/blockswithchecksum.md), `checksum`: string): *[BlocksVerificationError](blocksverificationerror.md)* -*Defined in [lib/errors.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L48)* +*Defined in [lib/errors.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L48)* **Parameters:** @@ -46,7 +46,7 @@ Name | Type | • **blocks**: *[BlocksWithChecksum](../interfaces/blockswithchecksum.md)* -*Defined in [lib/errors.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L50)* +*Defined in [lib/errors.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L50)* ___ @@ -54,7 +54,7 @@ ___ • **checksum**: *string* -*Defined in [lib/errors.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L51)* +*Defined in [lib/errors.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L51)* ___ @@ -64,7 +64,7 @@ ___ *Inherited from [VerificationError](verificationerror.md).[code](verificationerror.md#code)* -*Defined in [lib/errors.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L24)* +*Defined in [lib/errors.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L24)* ___ diff --git a/doc/classes/blocktransformstream.md b/doc/classes/blocktransformstream.md index fcfe9af7..d10c0613 100644 --- a/doc/classes/blocktransformstream.md +++ b/doc/classes/blocktransformstream.md @@ -29,12 +29,15 @@ * [inputBytes](blocktransformstream.md#private-inputbytes) * [readable](blocktransformstream.md#readable) * [readableHighWaterMark](blocktransformstream.md#readablehighwatermark) +* [readableLength](blocktransformstream.md#readablelength) * [writable](blocktransformstream.md#writable) * [writableHighWaterMark](blocktransformstream.md#writablehighwatermark) +* [writableLength](blocktransformstream.md#writablelength) * [defaultMaxListeners](blocktransformstream.md#static-defaultmaxlisteners) ### Methods +* [[Symbol.asyncIterator]](blocktransformstream.md#[symbol.asynciterator]) * [_destroy](blocktransformstream.md#_destroy) * [_final](blocktransformstream.md#_final) * [_flush](blocktransformstream.md#_flush) @@ -52,6 +55,7 @@ * [isPaused](blocktransformstream.md#ispaused) * [listenerCount](blocktransformstream.md#listenercount) * [listeners](blocktransformstream.md#listeners) +* [off](blocktransformstream.md#off) * [on](blocktransformstream.md#on) * [once](blocktransformstream.md#once) * [pause](blocktransformstream.md#pause) @@ -59,6 +63,7 @@ * [prependListener](blocktransformstream.md#prependlistener) * [prependOnceListener](blocktransformstream.md#prependoncelistener) * [push](blocktransformstream.md#push) +* [rawListeners](blocktransformstream.md#rawlisteners) * [read](blocktransformstream.md#read) * [removeAllListeners](blocktransformstream.md#removealllisteners) * [removeListener](blocktransformstream.md#removelistener) @@ -83,7 +88,7 @@ *Overrides [SourceTransform](../interfaces/sourcetransform.md).[constructor](../interfaces/sourcetransform.md#constructor)* -*Defined in [lib/block-transform-stream.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L28)* +*Defined in [lib/block-transform-stream.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L29)* **Parameters:** @@ -103,7 +108,7 @@ Name | Type | Default | • **alignedReadableState**: *[AlignedReadableState](alignedreadablestate.md)* -*Defined in [lib/block-transform-stream.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L26)* +*Defined in [lib/block-transform-stream.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L27)* ___ @@ -111,7 +116,7 @@ ___ • **bytesRead**: *number* = 0 -*Defined in [lib/block-transform-stream.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L23)* +*Defined in [lib/block-transform-stream.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L24)* ___ @@ -119,7 +124,7 @@ ___ • **bytesWritten**: *number* = 0 -*Defined in [lib/block-transform-stream.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L24)* +*Defined in [lib/block-transform-stream.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L25)* ___ @@ -127,7 +132,7 @@ ___ • **chunkSize**: *number* -*Defined in [lib/block-transform-stream.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L25)* +*Defined in [lib/block-transform-stream.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L26)* ___ @@ -135,7 +140,7 @@ ___ • **inputBuffers**: *[Buffer](../interfaces/alignedlockablebuffer.md#buffer)[]* = [] -*Defined in [lib/block-transform-stream.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L27)* +*Defined in [lib/block-transform-stream.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L28)* ___ @@ -143,7 +148,7 @@ ___ • **inputBytes**: *number* = 0 -*Defined in [lib/block-transform-stream.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L28)* +*Defined in [lib/block-transform-stream.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L29)* ___ @@ -153,7 +158,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readable](sparsefilterstream.md#readable)* -Defined in node_modules/@types/node/base.d.ts:5422 +Defined in node_modules/@types/node/stream.d.ts:20 ___ @@ -163,7 +168,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readableHighWaterMark](sparsefilterstream.md#readablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5423 +Defined in node_modules/@types/node/stream.d.ts:21 + +___ + +### readableLength + +• **readableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[readableLength](sparsefilterstream.md#readablelength)* + +Defined in node_modules/@types/node/stream.d.ts:22 ___ @@ -173,7 +188,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writable](sparsefilterstream.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5600 +Defined in node_modules/@types/node/stream.d.ts:209 ___ @@ -183,7 +198,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writableHighWaterMark](sparsefilterstream.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5601 +Defined in node_modules/@types/node/stream.d.ts:210 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[writableLength](sparsefilterstream.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:211 ___ @@ -193,10 +218,22 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹any›* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[[Symbol.asyncIterator]](sparsefilterstream.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/stream.d.ts:95 + +**Returns:** *AsyncIterableIterator‹any›* + +___ + ### _destroy ▸ **_destroy**(`error`: [Error](notcapable.md#static-error) | null, `callback`: function): *void* @@ -205,7 +242,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadStream](sparsereadstream.md).[_destroy](sparsereadstream.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5605 +Defined in node_modules/@types/node/stream.d.ts:215 **Parameters:** @@ -213,13 +250,13 @@ Defined in node_modules/@types/node/base.d.ts:5605 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -227,17 +264,23 @@ ___ ### _final -▸ **_final**(`callback`: Function): *void* +▸ **_final**(`callback`: function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[_final](sparsefilterstream.md#_final)* -Defined in node_modules/@types/node/base.d.ts:5606 +Defined in node_modules/@types/node/stream.d.ts:216 + +**Parameters:** + +▪ **callback**: *function* + +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`callback` | Function | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -245,9 +288,11 @@ ___ ### _flush -▸ **_flush**(`callback`: function): *Promise‹void›* +▸ **_flush**(`callback`: function): *void* -*Defined in [lib/block-transform-stream.ts:86](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L86)* +*Overrides [SparseFilterStream](sparsefilterstream.md).[_flush](sparsefilterstream.md#_flush)* + +*Defined in [lib/block-transform-stream.ts:89](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L89)* **Parameters:** @@ -261,7 +306,7 @@ Name | Type | ------ | ------ | `error?` | [Error](notcapable.md#static-error) | -**Returns:** *Promise‹void›* +**Returns:** *void* ___ @@ -271,7 +316,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_read](sparsefilterstream.md#_read)* -Defined in node_modules/@types/node/base.d.ts:5425 +Defined in node_modules/@types/node/stream.d.ts:24 **Parameters:** @@ -285,11 +330,11 @@ ___ ### _transform -▸ **_transform**(`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_encoding`: string, `callback`: function): *Promise‹void›* +▸ **_transform**(`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_encoding`: string, `callback`: function): *void* *Overrides [SourceTransform](../interfaces/sourcetransform.md).[_transform](../interfaces/sourcetransform.md#_transform)* -*Defined in [lib/block-transform-stream.ts:74](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L74)* +*Defined in [lib/block-transform-stream.ts:78](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L78)* **Parameters:** @@ -307,7 +352,7 @@ Name | Type | ------ | ------ | `error?` | [Error](notcapable.md#static-error) | -**Returns:** *Promise‹void›* +**Returns:** *void* ___ @@ -317,7 +362,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_write](sparsefilterstream.md#_write)* -Defined in node_modules/@types/node/base.d.ts:5603 +Defined in node_modules/@types/node/stream.d.ts:213 **Parameters:** @@ -327,13 +372,13 @@ Defined in node_modules/@types/node/base.d.ts:5603 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -345,7 +390,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_writev](sparsefilterstream.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5604 +Defined in node_modules/@types/node/stream.d.ts:214 **Parameters:** @@ -353,13 +398,13 @@ Defined in node_modules/@types/node/base.d.ts:5604 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -367,13 +412,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5447 +Defined in node_modules/@types/node/stream.d.ts:46 Event emitter The defined events on documents including: @@ -385,30 +430,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5448 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -423,7 +444,7 @@ Defined in node_modules/@types/node/base.d.ts:5448 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5449 +Defined in node_modules/@types/node/stream.d.ts:47 **Parameters:** @@ -431,13 +452,13 @@ Defined in node_modules/@types/node/base.d.ts:5449 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -447,7 +468,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5450 +Defined in node_modules/@types/node/stream.d.ts:48 **Parameters:** @@ -465,7 +486,7 @@ Defined in node_modules/@types/node/base.d.ts:5450 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5451 +Defined in node_modules/@types/node/stream.d.ts:49 **Parameters:** @@ -483,7 +504,7 @@ Defined in node_modules/@types/node/base.d.ts:5451 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5452 +Defined in node_modules/@types/node/stream.d.ts:50 **Parameters:** @@ -501,6 +522,30 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* + +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:51 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### cork @@ -509,7 +554,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[cork](sparsefilterstream.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5613 +Defined in node_modules/@types/node/stream.d.ts:223 **Returns:** *void* @@ -521,9 +566,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[destroy](sparsefilterstream.md#destroy)* -*Overrides [SparseReadStream](sparsereadstream.md).[destroy](sparsereadstream.md#destroy)* - -Defined in node_modules/@types/node/base.d.ts:5625 +Defined in node_modules/@types/node/stream.d.ts:35 **Parameters:** @@ -537,102 +580,102 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* +▸ **emit**(`event`: "close"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5454 +Defined in node_modules/@types/node/stream.d.ts:53 **Parameters:** Name | Type | ------ | ------ | -`event` | string | symbol | -`...args` | any[] | +`event` | "close" | **Returns:** *boolean* -▸ **emit**(`event`: "close"): *boolean* +▸ **emit**(`event`: "data", `chunk`: any): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5455 +Defined in node_modules/@types/node/stream.d.ts:54 **Parameters:** Name | Type | ------ | ------ | -`event` | "close" | +`event` | "data" | +`chunk` | any | **Returns:** *boolean* -▸ **emit**(`event`: "data", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "end"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5456 +Defined in node_modules/@types/node/stream.d.ts:55 **Parameters:** Name | Type | ------ | ------ | -`event` | "data" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`event` | "end" | **Returns:** *boolean* -▸ **emit**(`event`: "end"): *boolean* +▸ **emit**(`event`: "readable"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5457 +Defined in node_modules/@types/node/stream.d.ts:56 **Parameters:** Name | Type | ------ | ------ | -`event` | "end" | +`event` | "readable" | **Returns:** *boolean* -▸ **emit**(`event`: "readable"): *boolean* +▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5458 +Defined in node_modules/@types/node/stream.d.ts:57 **Parameters:** Name | Type | ------ | ------ | -`event` | "readable" | +`event` | "error" | +`err` | [Error](notcapable.md#static-error) | **Returns:** *boolean* -▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5459 +Defined in node_modules/@types/node/stream.d.ts:58 **Parameters:** Name | Type | ------ | ------ | -`event` | "error" | -`err` | [Error](notcapable.md#static-error) | +`event` | string | symbol | +`...args` | any[] | **Returns:** *boolean* @@ -640,40 +683,40 @@ ___ ### end -▸ **end**(`cb?`: Function): *void* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5610 +Defined in node_modules/@types/node/stream.d.ts:220 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5611 +Defined in node_modules/@types/node/stream.d.ts:221 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5612 +Defined in node_modules/@types/node/stream.d.ts:222 **Parameters:** @@ -681,7 +724,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -693,7 +736,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -705,7 +748,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -717,7 +760,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[isPaused](sparsefilterstream.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:5430 +Defined in node_modules/@types/node/stream.d.ts:29 **Returns:** *boolean* @@ -729,7 +772,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -747,7 +790,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -759,19 +802,17 @@ Name | Type | ___ -### on +### off -▸ **on**(`event`: string, `listener`: function): *this* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* - -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -Defined in node_modules/@types/node/base.d.ts:5461 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -785,13 +826,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5462 +Defined in node_modules/@types/node/stream.d.ts:60 **Parameters:** @@ -809,7 +854,7 @@ Defined in node_modules/@types/node/base.d.ts:5462 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5463 +Defined in node_modules/@types/node/stream.d.ts:61 **Parameters:** @@ -817,13 +862,13 @@ Defined in node_modules/@types/node/base.d.ts:5463 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -833,7 +878,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5464 +Defined in node_modules/@types/node/stream.d.ts:62 **Parameters:** @@ -851,7 +896,7 @@ Defined in node_modules/@types/node/base.d.ts:5464 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5465 +Defined in node_modules/@types/node/stream.d.ts:63 **Parameters:** @@ -869,7 +914,7 @@ Defined in node_modules/@types/node/base.d.ts:5465 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5466 +Defined in node_modules/@types/node/stream.d.ts:64 **Parameters:** @@ -887,21 +932,17 @@ Name | Type | **Returns:** *this* -___ - -### once - -▸ **once**(`event`: string, `listener`: function): *this* +▸ **on**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5468 +Defined in node_modules/@types/node/stream.d.ts:65 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -915,13 +956,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5469 +Defined in node_modules/@types/node/stream.d.ts:67 **Parameters:** @@ -939,7 +984,7 @@ Defined in node_modules/@types/node/base.d.ts:5469 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5470 +Defined in node_modules/@types/node/stream.d.ts:68 **Parameters:** @@ -947,13 +992,13 @@ Defined in node_modules/@types/node/base.d.ts:5470 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -963,7 +1008,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5471 +Defined in node_modules/@types/node/stream.d.ts:69 **Parameters:** @@ -981,7 +1026,7 @@ Defined in node_modules/@types/node/base.d.ts:5471 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5472 +Defined in node_modules/@types/node/stream.d.ts:70 **Parameters:** @@ -999,7 +1044,7 @@ Defined in node_modules/@types/node/base.d.ts:5472 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5473 +Defined in node_modules/@types/node/stream.d.ts:71 **Parameters:** @@ -1017,6 +1062,30 @@ Name | Type | **Returns:** *this* +▸ **once**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* + +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* + +Defined in node_modules/@types/node/stream.d.ts:72 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### pause @@ -1025,7 +1094,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[pause](sparsefilterstream.md#pause)* -Defined in node_modules/@types/node/base.d.ts:5428 +Defined in node_modules/@types/node/stream.d.ts:27 **Returns:** *this* @@ -1037,7 +1106,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:5407 +Defined in node_modules/@types/node/stream.d.ts:5 **Type parameters:** @@ -1056,37 +1125,13 @@ ___ ### prependListener -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* - -Defined in node_modules/@types/node/base.d.ts:5475 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **prependListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5476 +Defined in node_modules/@types/node/stream.d.ts:74 **Parameters:** @@ -1104,7 +1149,7 @@ Defined in node_modules/@types/node/base.d.ts:5476 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5477 +Defined in node_modules/@types/node/stream.d.ts:75 **Parameters:** @@ -1112,13 +1157,13 @@ Defined in node_modules/@types/node/base.d.ts:5477 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1128,7 +1173,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5478 +Defined in node_modules/@types/node/stream.d.ts:76 **Parameters:** @@ -1146,7 +1191,7 @@ Defined in node_modules/@types/node/base.d.ts:5478 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5479 +Defined in node_modules/@types/node/stream.d.ts:77 **Parameters:** @@ -1164,7 +1209,7 @@ Defined in node_modules/@types/node/base.d.ts:5479 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5480 +Defined in node_modules/@types/node/stream.d.ts:78 **Parameters:** @@ -1182,21 +1227,17 @@ Name | Type | **Returns:** *this* -___ +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -### prependOnceListener - -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5482 +Defined in node_modules/@types/node/stream.d.ts:79 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1210,13 +1251,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5483 +Defined in node_modules/@types/node/stream.d.ts:81 **Parameters:** @@ -1234,7 +1279,7 @@ Defined in node_modules/@types/node/base.d.ts:5483 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5484 +Defined in node_modules/@types/node/stream.d.ts:82 **Parameters:** @@ -1242,13 +1287,13 @@ Defined in node_modules/@types/node/base.d.ts:5484 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1258,7 +1303,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5485 +Defined in node_modules/@types/node/stream.d.ts:83 **Parameters:** @@ -1276,7 +1321,7 @@ Defined in node_modules/@types/node/base.d.ts:5485 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5486 +Defined in node_modules/@types/node/stream.d.ts:84 **Parameters:** @@ -1294,7 +1339,7 @@ Defined in node_modules/@types/node/base.d.ts:5486 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5487 +Defined in node_modules/@types/node/stream.d.ts:85 **Parameters:** @@ -1312,6 +1357,30 @@ Name | Type | **Returns:** *this* +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* + +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* + +Defined in node_modules/@types/node/stream.d.ts:86 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### push @@ -1320,7 +1389,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[push](sparsefilterstream.md#push)* -Defined in node_modules/@types/node/base.d.ts:5434 +Defined in node_modules/@types/node/stream.d.ts:33 **Parameters:** @@ -1333,13 +1402,31 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`size?`: undefined | number): *any* *Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* -Defined in node_modules/@types/node/base.d.ts:5426 +Defined in node_modules/@types/node/stream.d.ts:25 **Parameters:** @@ -1357,7 +1444,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -1371,37 +1458,13 @@ ___ ### removeListener -▸ **removeListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* - -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5489 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5490 +Defined in node_modules/@types/node/stream.d.ts:88 **Parameters:** @@ -1419,7 +1482,7 @@ Defined in node_modules/@types/node/base.d.ts:5490 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5491 +Defined in node_modules/@types/node/stream.d.ts:89 **Parameters:** @@ -1427,13 +1490,13 @@ Defined in node_modules/@types/node/base.d.ts:5491 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1443,7 +1506,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5492 +Defined in node_modules/@types/node/stream.d.ts:90 **Parameters:** @@ -1461,7 +1524,7 @@ Defined in node_modules/@types/node/base.d.ts:5492 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5493 +Defined in node_modules/@types/node/stream.d.ts:91 **Parameters:** @@ -1479,7 +1542,7 @@ Defined in node_modules/@types/node/base.d.ts:5493 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5494 +Defined in node_modules/@types/node/stream.d.ts:92 **Parameters:** @@ -1497,6 +1560,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:93 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### resume @@ -1505,7 +1592,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[resume](sparsefilterstream.md#resume)* -Defined in node_modules/@types/node/base.d.ts:5429 +Defined in node_modules/@types/node/stream.d.ts:28 **Returns:** *this* @@ -1517,7 +1604,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setDefaultEncoding](sparsefilterstream.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5609 +Defined in node_modules/@types/node/stream.d.ts:219 **Parameters:** @@ -1535,7 +1622,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setEncoding](sparsefilterstream.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:5427 +Defined in node_modules/@types/node/stream.d.ts:26 **Parameters:** @@ -1553,7 +1640,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1571,7 +1658,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[uncork](sparsefilterstream.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5614 +Defined in node_modules/@types/node/stream.d.ts:224 **Returns:** *void* @@ -1579,21 +1666,17 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: NodeJS.WritableStream): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[unpipe](sparsefilterstream.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:5431 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/stream.d.ts:30 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | NodeJS.WritableStream | **Returns:** *this* @@ -1605,7 +1688,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[unshift](sparsefilterstream.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:5432 +Defined in node_modules/@types/node/stream.d.ts:31 **Parameters:** @@ -1623,7 +1706,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[wrap](sparsefilterstream.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:5433 +Defined in node_modules/@types/node/stream.d.ts:32 **Parameters:** @@ -1637,26 +1720,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5607 +Defined in node_modules/@types/node/stream.d.ts:217 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5608 +Defined in node_modules/@types/node/stream.d.ts:218 **Parameters:** @@ -1664,7 +1747,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1674,7 +1757,7 @@ ___ ▸ **writeBuffers**(`flush`: boolean): *Promise‹void›* -*Defined in [lib/block-transform-stream.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L48)* +*Defined in [lib/block-transform-stream.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L49)* **Parameters:** @@ -1690,7 +1773,7 @@ ___ ▸ **alignIfNeeded**(`stream`: ReadableStream, `alignment?`: undefined | number, `numBuffers?`: undefined | number): *ReadableStream‹› | [BlockTransformStream](blocktransformstream.md)‹›* -*Defined in [lib/block-transform-stream.ts:91](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-transform-stream.ts#L91)* +*Defined in [lib/block-transform-stream.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-transform-stream.ts#L93)* **Parameters:** @@ -1710,7 +1793,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/blockwritestream.md b/doc/classes/blockwritestream.md index 0af0a1ab..b0945d00 100644 --- a/doc/classes/blockwritestream.md +++ b/doc/classes/blockwritestream.md @@ -28,6 +28,7 @@ * [position](blockwritestream.md#private-position) * [writable](blockwritestream.md#writable) * [writableHighWaterMark](blockwritestream.md#writablehighwatermark) +* [writableLength](blockwritestream.md#writablelength) * [defaultMaxListeners](blockwritestream.md#static-defaultmaxlisteners) ### Methods @@ -47,11 +48,13 @@ * [getMaxListeners](blockwritestream.md#getmaxlisteners) * [listenerCount](blockwritestream.md#listenercount) * [listeners](blockwritestream.md#listeners) +* [off](blockwritestream.md#off) * [on](blockwritestream.md#on) * [once](blockwritestream.md#once) * [pipe](blockwritestream.md#pipe) * [prependListener](blockwritestream.md#prependlistener) * [prependOnceListener](blockwritestream.md#prependoncelistener) +* [rawListeners](blockwritestream.md#rawlisteners) * [removeAllListeners](blockwritestream.md#removealllisteners) * [removeListener](blockwritestream.md#removelistener) * [setDefaultEncoding](blockwritestream.md#setdefaultencoding) @@ -69,7 +72,7 @@ *Overrides [CountingWritable](countingwritable.md).[constructor](countingwritable.md#constructor)* -*Defined in [lib/block-write-stream.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L37)* +*Defined in [lib/block-write-stream.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L37)* **Parameters:** @@ -90,7 +93,7 @@ Name | Type | Default | • **bytesWritten**: *number* = 0 -*Defined in [lib/block-write-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L35)* +*Defined in [lib/block-write-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L35)* ___ @@ -98,7 +101,7 @@ ___ • **delayFirstBuffer**: *boolean* -*Defined in [lib/block-write-stream.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L33)* +*Defined in [lib/block-write-stream.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L33)* ___ @@ -106,7 +109,7 @@ ___ • **destination**: *[BlockDevice](blockdevice.md)* -*Defined in [lib/block-write-stream.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L32)* +*Defined in [lib/block-write-stream.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L32)* ___ @@ -114,7 +117,7 @@ ___ • **firstBuffer**? : *[Buffer](../interfaces/alignedlockablebuffer.md#buffer)* -*Defined in [lib/block-write-stream.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L37)* +*Defined in [lib/block-write-stream.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L37)* ___ @@ -122,7 +125,7 @@ ___ • **maxRetries**: *number* -*Defined in [lib/block-write-stream.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L34)* +*Defined in [lib/block-write-stream.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L34)* ___ @@ -130,7 +133,7 @@ ___ • **position**: *number* = 0 -*Defined in [lib/block-write-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L36)* +*Defined in [lib/block-write-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L36)* ___ @@ -140,7 +143,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[writable](countingwritable.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5508 +Defined in node_modules/@types/node/stream.d.ts:109 ___ @@ -150,7 +153,17 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[writableHighWaterMark](countingwritable.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5509 +Defined in node_modules/@types/node/stream.d.ts:110 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [CountingWritable](countingwritable.md).[writableLength](countingwritable.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:111 ___ @@ -160,7 +173,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -168,7 +181,7 @@ Defined in node_modules/@types/node/base.d.ts:896 ▸ **__final**(): *Promise‹void›* -*Defined in [lib/block-write-stream.ts:103](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L103)* +*Defined in [lib/block-write-stream.ts:103](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L103)* **Returns:** *Promise‹void›* @@ -178,7 +191,7 @@ ___ ▸ **__write**(`buffer`: [AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md)): *Promise‹void›* -*Defined in [lib/block-write-stream.ts:76](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L76)* +*Defined in [lib/block-write-stream.ts:76](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L76)* **Parameters:** @@ -196,7 +209,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[_destroy](countingwritable.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5513 +Defined in node_modules/@types/node/stream.d.ts:115 **Parameters:** @@ -204,13 +217,13 @@ Defined in node_modules/@types/node/base.d.ts:5513 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -222,7 +235,7 @@ ___ *Overrides [CountingWritable](countingwritable.md).[_final](countingwritable.md#_final)* -*Defined in [lib/block-write-stream.ts:119](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L119)* +*Defined in [lib/block-write-stream.ts:119](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L119)* **`summary`** Write buffered data before a stream ends, called by stream internals @@ -230,13 +243,13 @@ ___ ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error) | void): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | void | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -248,7 +261,7 @@ ___ *Overrides void* -*Defined in [lib/block-write-stream.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L95)* +*Defined in [lib/block-write-stream.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L95)* **Parameters:** @@ -276,7 +289,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[_writev](countingwritable.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5512 +Defined in node_modules/@types/node/stream.d.ts:114 **Parameters:** @@ -284,13 +297,13 @@ Defined in node_modules/@types/node/base.d.ts:5512 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -298,13 +311,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5535 +Defined in node_modules/@types/node/stream.d.ts:137 Event emitter The defined events on documents including: @@ -317,30 +330,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5536 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -355,7 +344,7 @@ Defined in node_modules/@types/node/base.d.ts:5536 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5537 +Defined in node_modules/@types/node/stream.d.ts:138 **Parameters:** @@ -373,7 +362,7 @@ Defined in node_modules/@types/node/base.d.ts:5537 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5538 +Defined in node_modules/@types/node/stream.d.ts:139 **Parameters:** @@ -397,7 +386,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5539 +Defined in node_modules/@types/node/stream.d.ts:140 **Parameters:** @@ -415,7 +404,7 @@ Defined in node_modules/@types/node/base.d.ts:5539 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5540 +Defined in node_modules/@types/node/stream.d.ts:141 **Parameters:** @@ -439,7 +428,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5541 +Defined in node_modules/@types/node/stream.d.ts:142 **Parameters:** @@ -457,6 +446,30 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* + +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:143 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### cork @@ -465,7 +478,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[cork](countingwritable.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5521 +Defined in node_modules/@types/node/stream.d.ts:123 **Returns:** *void* @@ -477,7 +490,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[destroy](countingwritable.md#destroy)* -Defined in node_modules/@types/node/base.d.ts:5523 +Defined in node_modules/@types/node/stream.d.ts:125 **Parameters:** @@ -491,30 +504,13 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* - -*Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* - -*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* - -Defined in node_modules/@types/node/base.d.ts:5543 - -**Parameters:** - -Name | Type | ------- | ------ | -`event` | string | symbol | -`...args` | any[] | - -**Returns:** *boolean* - ▸ **emit**(`event`: "close"): *boolean* *Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5544 +Defined in node_modules/@types/node/stream.d.ts:145 **Parameters:** @@ -524,20 +520,19 @@ Name | Type | **Returns:** *boolean* -▸ **emit**(`event`: "drain", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "drain"): *boolean* *Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5545 +Defined in node_modules/@types/node/stream.d.ts:146 **Parameters:** Name | Type | ------ | ------ | `event` | "drain" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | **Returns:** *boolean* @@ -547,7 +542,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5546 +Defined in node_modules/@types/node/stream.d.ts:147 **Parameters:** @@ -564,7 +559,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5547 +Defined in node_modules/@types/node/stream.d.ts:148 **Parameters:** @@ -580,7 +575,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5548 +Defined in node_modules/@types/node/stream.d.ts:149 **Parameters:** @@ -597,7 +592,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5549 +Defined in node_modules/@types/node/stream.d.ts:150 **Parameters:** @@ -608,44 +603,61 @@ Name | Type | **Returns:** *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* + +*Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* + +*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* + +Defined in node_modules/@types/node/stream.d.ts:151 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | +`...args` | any[] | + +**Returns:** *boolean* + ___ ### end -▸ **end**(`cb?`: Function): *void* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5518 +Defined in node_modules/@types/node/stream.d.ts:120 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5519 +Defined in node_modules/@types/node/stream.d.ts:121 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5520 +Defined in node_modules/@types/node/stream.d.ts:122 **Parameters:** @@ -653,7 +665,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -665,7 +677,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -677,7 +689,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -689,7 +701,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -707,7 +719,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -719,19 +731,17 @@ Name | Type | ___ -### on +### off -▸ **on**(`event`: string, `listener`: function): *this* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* - -Defined in node_modules/@types/node/base.d.ts:5551 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -745,13 +755,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5552 +Defined in node_modules/@types/node/stream.d.ts:153 **Parameters:** @@ -769,7 +783,7 @@ Defined in node_modules/@types/node/base.d.ts:5552 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5553 +Defined in node_modules/@types/node/stream.d.ts:154 **Parameters:** @@ -787,7 +801,7 @@ Defined in node_modules/@types/node/base.d.ts:5553 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5554 +Defined in node_modules/@types/node/stream.d.ts:155 **Parameters:** @@ -811,7 +825,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5555 +Defined in node_modules/@types/node/stream.d.ts:156 **Parameters:** @@ -829,7 +843,7 @@ Defined in node_modules/@types/node/base.d.ts:5555 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5556 +Defined in node_modules/@types/node/stream.d.ts:157 **Parameters:** @@ -853,7 +867,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5557 +Defined in node_modules/@types/node/stream.d.ts:158 **Parameters:** @@ -871,21 +885,17 @@ Name | Type | **Returns:** *this* -___ - -### once - -▸ **once**(`event`: string, `listener`: function): *this* +▸ **on**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* +*Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5559 +Defined in node_modules/@types/node/stream.d.ts:159 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -899,13 +909,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5560 +Defined in node_modules/@types/node/stream.d.ts:161 **Parameters:** @@ -923,7 +937,7 @@ Defined in node_modules/@types/node/base.d.ts:5560 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5561 +Defined in node_modules/@types/node/stream.d.ts:162 **Parameters:** @@ -941,7 +955,7 @@ Defined in node_modules/@types/node/base.d.ts:5561 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5562 +Defined in node_modules/@types/node/stream.d.ts:163 **Parameters:** @@ -965,7 +979,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5563 +Defined in node_modules/@types/node/stream.d.ts:164 **Parameters:** @@ -983,7 +997,7 @@ Defined in node_modules/@types/node/base.d.ts:5563 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5564 +Defined in node_modules/@types/node/stream.d.ts:165 **Parameters:** @@ -1007,7 +1021,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5565 +Defined in node_modules/@types/node/stream.d.ts:166 **Parameters:** @@ -1025,56 +1039,56 @@ Name | Type | **Returns:** *this* -___ +▸ **once**(`event`: string | symbol, `listener`: function): *this* -### pipe +*Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* -▸ **pipe**<**T**>(`destination`: T, `options?`: undefined | object): *T* +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -*Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* +Defined in node_modules/@types/node/stream.d.ts:167 -Defined in node_modules/@types/node/base.d.ts:5407 +**Parameters:** -**Type parameters:** +▪ **event**: *string | symbol* -▪ **T**: *WritableStream* +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* **Parameters:** Name | Type | ------ | ------ | -`destination` | T | -`options?` | undefined | object | +`...args` | any[] | -**Returns:** *T* +**Returns:** *this* ___ -### prependListener - -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[prependListener](countingwritable.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* +### pipe -Defined in node_modules/@types/node/base.d.ts:5567 +▸ **pipe**<**T**>(`destination`: T, `options?`: undefined | object): *T* -**Parameters:** +*Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -▪ **event**: *string* +Defined in node_modules/@types/node/stream.d.ts:5 -▪ **listener**: *function* +**Type parameters:** -▸ (...`args`: any[]): *void* +▪ **T**: *WritableStream* **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`destination` | T | +`options?` | undefined | object | -**Returns:** *this* +**Returns:** *T* + +___ + +### prependListener ▸ **prependListener**(`event`: "close", `listener`: function): *this* @@ -1082,7 +1096,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5568 +Defined in node_modules/@types/node/stream.d.ts:169 **Parameters:** @@ -1100,7 +1114,7 @@ Defined in node_modules/@types/node/base.d.ts:5568 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5569 +Defined in node_modules/@types/node/stream.d.ts:170 **Parameters:** @@ -1118,7 +1132,7 @@ Defined in node_modules/@types/node/base.d.ts:5569 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5570 +Defined in node_modules/@types/node/stream.d.ts:171 **Parameters:** @@ -1142,7 +1156,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5571 +Defined in node_modules/@types/node/stream.d.ts:172 **Parameters:** @@ -1160,7 +1174,7 @@ Defined in node_modules/@types/node/base.d.ts:5571 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5572 +Defined in node_modules/@types/node/stream.d.ts:173 **Parameters:** @@ -1184,7 +1198,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5573 +Defined in node_modules/@types/node/stream.d.ts:174 **Parameters:** @@ -1202,21 +1216,17 @@ Name | Type | **Returns:** *this* -___ - -### prependOnceListener +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* +*Inherited from [CountingWritable](countingwritable.md).[prependListener](countingwritable.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5575 +Defined in node_modules/@types/node/stream.d.ts:175 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1230,13 +1240,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5576 +Defined in node_modules/@types/node/stream.d.ts:177 **Parameters:** @@ -1254,7 +1268,7 @@ Defined in node_modules/@types/node/base.d.ts:5576 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5577 +Defined in node_modules/@types/node/stream.d.ts:178 **Parameters:** @@ -1272,7 +1286,7 @@ Defined in node_modules/@types/node/base.d.ts:5577 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5578 +Defined in node_modules/@types/node/stream.d.ts:179 **Parameters:** @@ -1296,7 +1310,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5579 +Defined in node_modules/@types/node/stream.d.ts:180 **Parameters:** @@ -1314,7 +1328,7 @@ Defined in node_modules/@types/node/base.d.ts:5579 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5580 +Defined in node_modules/@types/node/stream.d.ts:181 **Parameters:** @@ -1338,7 +1352,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5581 +Defined in node_modules/@types/node/stream.d.ts:182 **Parameters:** @@ -1356,59 +1370,77 @@ Name | Type | **Returns:** *this* -___ +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* -### removeAllListeners +*Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* -▸ **removeAllListeners**(`event?`: string | symbol): *this* +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* +Defined in node_modules/@types/node/stream.d.ts:183 -Defined in node_modules/@types/node/base.d.ts:904 +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* **Parameters:** Name | Type | ------ | ------ | -`event?` | string | symbol | +`...args` | any[] | **Returns:** *this* ___ -### removeListener - -▸ **removeListener**(`event`: string, `listener`: function): *this* +### rawListeners -*Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* +▸ **rawListeners**(`event`: string | symbol): *Function[]* -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* -Defined in node_modules/@types/node/base.d.ts:5583 +Defined in node_modules/@types/node/events.d.ts:31 **Parameters:** -▪ **event**: *string* +Name | Type | +------ | ------ | +`event` | string | symbol | -▪ **listener**: *function* +**Returns:** *Function[]* -▸ (...`args`: any[]): *void* +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`: string | symbol): *this* + +*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* + +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`event?` | string | symbol | **Returns:** *this* +___ + +### removeListener + ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5584 +Defined in node_modules/@types/node/stream.d.ts:185 **Parameters:** @@ -1426,7 +1458,7 @@ Defined in node_modules/@types/node/base.d.ts:5584 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5585 +Defined in node_modules/@types/node/stream.d.ts:186 **Parameters:** @@ -1444,7 +1476,7 @@ Defined in node_modules/@types/node/base.d.ts:5585 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5586 +Defined in node_modules/@types/node/stream.d.ts:187 **Parameters:** @@ -1468,7 +1500,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5587 +Defined in node_modules/@types/node/stream.d.ts:188 **Parameters:** @@ -1486,7 +1518,7 @@ Defined in node_modules/@types/node/base.d.ts:5587 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5588 +Defined in node_modules/@types/node/stream.d.ts:189 **Parameters:** @@ -1510,7 +1542,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5589 +Defined in node_modules/@types/node/stream.d.ts:190 **Parameters:** @@ -1528,6 +1560,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:191 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### setDefaultEncoding @@ -1536,7 +1592,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setDefaultEncoding](countingwritable.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5517 +Defined in node_modules/@types/node/stream.d.ts:119 **Parameters:** @@ -1554,7 +1610,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1572,7 +1628,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[uncork](countingwritable.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5522 +Defined in node_modules/@types/node/stream.d.ts:124 **Returns:** *void* @@ -1580,26 +1636,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [CountingWritable](countingwritable.md).[write](countingwritable.md#write)* -Defined in node_modules/@types/node/base.d.ts:5515 +Defined in node_modules/@types/node/stream.d.ts:117 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [CountingWritable](countingwritable.md).[write](countingwritable.md#write)* -Defined in node_modules/@types/node/base.d.ts:5516 +Defined in node_modules/@types/node/stream.d.ts:118 **Parameters:** @@ -1607,7 +1663,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1617,7 +1673,7 @@ ___ ▸ **writeBuffer**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `position`: number): *Promise‹void›* -*Defined in [lib/block-write-stream.ts:56](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/block-write-stream.ts#L56)* +*Defined in [lib/block-write-stream.ts:56](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/block-write-stream.ts#L56)* **Parameters:** @@ -1636,7 +1692,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/bzip2source.md b/doc/classes/bzip2source.md index a312d775..0770cedb 100644 --- a/doc/classes/bzip2source.md +++ b/doc/classes/bzip2source.md @@ -53,11 +53,13 @@ * [getSize](bzip2source.md#protected-getsize) * [listenerCount](bzip2source.md#listenercount) * [listeners](bzip2source.md#listeners) +* [off](bzip2source.md#off) * [on](bzip2source.md#on) * [once](bzip2source.md#once) * [open](bzip2source.md#open) * [prependListener](bzip2source.md#prependlistener) * [prependOnceListener](bzip2source.md#prependoncelistener) +* [rawListeners](bzip2source.md#rawlisteners) * [read](bzip2source.md#read) * [removeAllListeners](bzip2source.md#removealllisteners) * [removeListener](bzip2source.md#removelistener) @@ -74,7 +76,7 @@ *Inherited from [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* **Parameters:** @@ -92,7 +94,7 @@ Name | Type | *Inherited from [CompressedSource](compressedsource.md).[isSizeEstimated](compressedsource.md#protected-issizeestimated)* -*Defined in [lib/source-destination/compressed-source.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L45)* +*Defined in [lib/source-destination/compressed-source.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L45)* ___ @@ -102,7 +104,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -112,7 +114,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -133,7 +135,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -143,7 +145,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/bzip2.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/bzip2.ts#L24)* +*Defined in [lib/source-destination/bzip2.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/bzip2.ts#L24)* ___ @@ -153,7 +155,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -165,7 +167,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L30)* +*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L30)* **Returns:** *Promise‹void›* @@ -179,7 +181,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/compressed-source.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L85)* +*Defined in [lib/source-destination/compressed-source.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L85)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -193,7 +195,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L26)* +*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L26)* **Returns:** *Promise‹void›* @@ -207,7 +209,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -235,7 +237,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/compressed-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L51)* +*Defined in [lib/source-destination/compressed-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L51)* **Returns:** *Promise‹boolean›* @@ -247,7 +249,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -259,7 +261,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -271,7 +273,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -283,7 +285,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -295,7 +297,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -307,7 +309,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -321,7 +323,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/compressed-source.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L55)* +*Defined in [lib/source-destination/compressed-source.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L55)* **Parameters:** @@ -343,7 +345,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -361,7 +363,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -381,7 +383,7 @@ ___ *Overrides [CompressedSource](compressedsource.md).[createTransform](compressedsource.md#protected-abstract-createtransform)* -*Defined in [lib/source-destination/bzip2.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/bzip2.ts#L26)* +*Defined in [lib/source-destination/bzip2.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/bzip2.ts#L26)* **Returns:** *Transform* @@ -393,7 +395,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -412,7 +414,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -434,7 +436,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -455,7 +457,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -467,7 +469,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -479,7 +481,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -491,7 +493,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -505,7 +507,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -517,7 +519,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -529,7 +531,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -541,7 +543,7 @@ ___ *Inherited from [CompressedSource](compressedsource.md).[getSize](compressedsource.md#protected-getsize)* -*Defined in [lib/source-destination/compressed-source.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L47)* +*Defined in [lib/source-destination/compressed-source.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L47)* **Returns:** *Promise‹number | undefined›* @@ -555,7 +557,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -575,7 +577,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -587,6 +589,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -595,7 +625,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -623,7 +653,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -649,7 +679,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -663,7 +693,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -691,7 +721,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -711,13 +741,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -740,7 +790,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -760,7 +810,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -788,7 +838,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -806,7 +856,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -827,7 +877,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -846,7 +898,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/checksumverificationerror.md b/doc/classes/checksumverificationerror.md index 13cf8760..eec9941c 100644 --- a/doc/classes/checksumverificationerror.md +++ b/doc/classes/checksumverificationerror.md @@ -29,7 +29,7 @@ \+ **new ChecksumVerificationError**(`message`: string, `checksum`: string, `expectedChecksum`: string): *[ChecksumVerificationError](checksumverificationerror.md)* -*Defined in [lib/errors.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L27)* +*Defined in [lib/errors.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L27)* **Parameters:** @@ -47,7 +47,7 @@ Name | Type | • **checksum**: *string* -*Defined in [lib/errors.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L30)* +*Defined in [lib/errors.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L30)* ___ @@ -57,7 +57,7 @@ ___ *Inherited from [VerificationError](verificationerror.md).[code](verificationerror.md#code)* -*Defined in [lib/errors.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L24)* +*Defined in [lib/errors.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L24)* ___ @@ -65,7 +65,7 @@ ___ • **expectedChecksum**: *string* -*Defined in [lib/errors.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L31)* +*Defined in [lib/errors.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L31)* ___ diff --git a/doc/classes/compressedsource.md b/doc/classes/compressedsource.md index 5763729c..cbb52c86 100644 --- a/doc/classes/compressedsource.md +++ b/doc/classes/compressedsource.md @@ -59,11 +59,13 @@ * [getSize](compressedsource.md#protected-getsize) * [listenerCount](compressedsource.md#listenercount) * [listeners](compressedsource.md#listeners) +* [off](compressedsource.md#off) * [on](compressedsource.md#on) * [once](compressedsource.md#once) * [open](compressedsource.md#open) * [prependListener](compressedsource.md#prependlistener) * [prependOnceListener](compressedsource.md#prependoncelistener) +* [rawListeners](compressedsource.md#rawlisteners) * [read](compressedsource.md#read) * [removeAllListeners](compressedsource.md#removealllisteners) * [removeListener](compressedsource.md#removelistener) @@ -80,7 +82,7 @@ *Inherited from [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* **Parameters:** @@ -96,7 +98,7 @@ Name | Type | • **isSizeEstimated**: *boolean* = false -*Defined in [lib/source-destination/compressed-source.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L45)* +*Defined in [lib/source-destination/compressed-source.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L45)* ___ @@ -106,7 +108,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -116,7 +118,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -137,7 +139,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -147,7 +149,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ___ @@ -157,7 +159,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -169,7 +171,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L30)* +*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L30)* **Returns:** *Promise‹void›* @@ -181,7 +183,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/compressed-source.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L85)* +*Defined in [lib/source-destination/compressed-source.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L85)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -195,7 +197,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L26)* +*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L26)* **Returns:** *Promise‹void›* @@ -209,7 +211,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -235,7 +237,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/compressed-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L51)* +*Defined in [lib/source-destination/compressed-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L51)* **Returns:** *Promise‹boolean›* @@ -247,7 +249,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -259,7 +261,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -271,7 +273,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -283,7 +285,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -295,7 +297,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -307,7 +309,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -319,7 +321,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/compressed-source.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L55)* +*Defined in [lib/source-destination/compressed-source.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L55)* **Parameters:** @@ -341,7 +343,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -359,7 +361,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -377,7 +379,7 @@ ___ ▸ **createTransform**(): *Transform* -*Defined in [lib/source-destination/compressed-source.ts:44](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L44)* +*Defined in [lib/source-destination/compressed-source.ts:44](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L44)* **Returns:** *Transform* @@ -389,7 +391,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -408,7 +410,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -430,7 +432,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -451,7 +453,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -463,7 +465,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -475,7 +477,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -487,7 +489,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -501,7 +503,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -513,7 +515,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -525,7 +527,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -535,7 +537,7 @@ ___ ▸ **getSize**(): *Promise‹number | undefined›* -*Defined in [lib/source-destination/compressed-source.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L47)* +*Defined in [lib/source-destination/compressed-source.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L47)* **Returns:** *Promise‹number | undefined›* @@ -549,7 +551,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -569,7 +571,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -581,6 +583,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -589,7 +619,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -617,7 +647,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -643,7 +673,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -657,7 +687,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -685,7 +715,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -705,13 +735,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -734,7 +784,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -754,7 +804,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -782,7 +832,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -800,7 +850,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -821,7 +871,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -840,7 +892,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/configuredsource.md b/doc/classes/configuredsource.md index e44fe9ae..3423b2e4 100644 --- a/doc/classes/configuredsource.md +++ b/doc/classes/configuredsource.md @@ -18,7 +18,7 @@ * [checksumType](configuredsource.md#private-checksumtype) * [chunkSize](configuredsource.md#private-chunksize) -* [config](configuredsource.md#private-optional-config) +* [config](configuredsource.md#private-config) * [configure](configuredsource.md#private-optional-configure) * [createStreamFromDisk](configuredsource.md#private-createstreamfromdisk) * [disk](configuredsource.md#private-disk) @@ -60,11 +60,13 @@ * [getPartitionTable](configuredsource.md#getpartitiontable) * [listenerCount](configuredsource.md#listenercount) * [listeners](configuredsource.md#listeners) +* [off](configuredsource.md#off) * [on](configuredsource.md#on) * [once](configuredsource.md#once) * [open](configuredsource.md#open) * [prependListener](configuredsource.md#prependlistener) * [prependOnceListener](configuredsource.md#prependoncelistener) +* [rawListeners](configuredsource.md#rawlisteners) * [read](configuredsource.md#read) * [removeAllListeners](configuredsource.md#removealllisteners) * [removeListener](configuredsource.md#removelistener) @@ -78,23 +80,25 @@ ### constructor -\+ **new ConfiguredSource**(`source`: [SourceDestination](sourcedestination.md), `shouldTrimPartitions`: boolean, `createStreamFromDisk`: boolean, `configure?`: [ConfigureFunction](../README.md#configurefunction) | "legacy", `config?`: any, `checksumType`: [ChecksumType](../README.md#checksumtype), `chunkSize`: number): *[ConfiguredSource](configuredsource.md)* +\+ **new ConfiguredSource**(`__namedParameters`: object): *[ConfiguredSource](configuredsource.md)* *Overrides [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:91](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L91)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:96](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L96)* **Parameters:** +▪ **__namedParameters**: *object* + Name | Type | Default | ------ | ------ | ------ | -`source` | [SourceDestination](sourcedestination.md) | - | -`shouldTrimPartitions` | boolean | - | -`createStreamFromDisk` | boolean | - | -`configure?` | [ConfigureFunction](../README.md#configurefunction) | "legacy" | - | -`config?` | any | - | -`checksumType` | [ChecksumType](../README.md#checksumtype) | "xxhash64" | +`checksumType` | "crc32" | "sha1" | "sha256" | "xxhash32" | "xxhash64" | "xxhash64" | `chunkSize` | number | CHUNK_SIZE | +`config` | any | - | +`configure` | undefined | function | "legacy" | - | +`createStreamFromDisk` | boolean | - | +`shouldTrimPartitions` | boolean | - | +`source` | [SourceDestination](sourcedestination.md)‹› | - | **Returns:** *[ConfiguredSource](configuredsource.md)* @@ -104,7 +108,7 @@ Name | Type | Default | • **checksumType**: *[ChecksumType](../README.md#checksumtype)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:100](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L100)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L93)* ___ @@ -112,15 +116,15 @@ ___ • **chunkSize**: *number* -*Defined in [lib/source-destination/configured-source/configured-source.ts:101](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L101)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:94](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L94)* ___ -### `Private` `Optional` config +### `Private` config -• **config**? : *any* +• **config**: *any* -*Defined in [lib/source-destination/configured-source/configured-source.ts:99](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L99)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L92)* ___ @@ -128,7 +132,7 @@ ___ • **configure**? : *[ConfigureFunction](../README.md#configurefunction)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:91](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L91)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:96](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L96)* ___ @@ -136,7 +140,7 @@ ___ • **createStreamFromDisk**: *boolean* -*Defined in [lib/source-destination/configured-source/configured-source.ts:97](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L97)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:91](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L91)* ___ @@ -144,7 +148,7 @@ ___ • **disk**: *[SourceDisk](sourcedisk.md)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:90](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L90)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L95)* ___ @@ -152,7 +156,7 @@ ___ • **shouldTrimPartitions**: *boolean* -*Defined in [lib/source-destination/configured-source/configured-source.ts:96](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L96)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:90](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L90)* ___ @@ -162,7 +166,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -172,7 +176,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -193,7 +197,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -203,7 +207,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ___ @@ -213,7 +217,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -223,7 +227,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_close](sourcesource.md#protected-_close)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:277](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L277)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:294](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L294)* **Returns:** *Promise‹void›* @@ -235,7 +239,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:221](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L221)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:238](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L238)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -247,7 +251,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_open](sourcesource.md#protected-_open)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:266](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L266)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:283](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L283)* **Returns:** *Promise‹void›* @@ -261,7 +265,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -287,7 +291,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:135](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L135)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:152](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L152)* **Returns:** *Promise‹boolean›* @@ -299,7 +303,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:139](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L139)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:156](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L156)* **Returns:** *Promise‹boolean›* @@ -311,7 +315,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -323,7 +327,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -335,7 +339,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:131](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L131)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:148](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L148)* **Returns:** *Promise‹boolean›* @@ -347,7 +351,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -359,7 +363,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -371,7 +375,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:152](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L152)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:169](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L169)* **Parameters:** @@ -389,7 +393,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:199](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L199)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:216](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L216)* **Parameters:** @@ -409,7 +413,7 @@ ___ ▸ **createSparseReadStreamFromDisk**(`generateChecksums`: boolean, `alignment?`: undefined | number, `numBuffers`: number): *Promise‹[SparseReadStream](sparsereadstream.md)›* -*Defined in [lib/source-destination/configured-source/configured-source.ts:164](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L164)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:181](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L181)* **Parameters:** @@ -427,7 +431,7 @@ ___ ▸ **createSparseReadStreamFromStream**(`generateChecksums`: boolean, `alignment?`: undefined | number, `numBuffers`: number): *Promise‹[SparseFilterStream](sparsefilterstream.md)›* -*Defined in [lib/source-destination/configured-source/configured-source.ts:180](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L180)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:197](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L197)* **Parameters:** @@ -447,7 +451,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -467,7 +471,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -486,7 +490,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -508,7 +512,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -529,7 +533,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -541,7 +545,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -553,7 +557,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:112](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L112)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:129](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L129)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -563,7 +567,7 @@ ___ ▸ **getBlocksWithChecksumType**(`generateChecksums`: boolean): *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* -*Defined in [lib/source-destination/configured-source/configured-source.ts:118](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L118)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:135](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L135)* **Parameters:** @@ -581,7 +585,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -595,7 +599,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -607,7 +611,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -619,7 +623,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -633,7 +637,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -653,7 +657,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -665,6 +669,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -673,7 +705,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -701,7 +733,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -727,7 +759,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -741,7 +773,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -769,7 +801,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -789,13 +821,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `sourceOffset`: number): *Promise‹ReadResult›* *Overrides [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:143](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L143)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:160](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L160)* **Parameters:** @@ -818,7 +870,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -838,7 +890,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -866,7 +918,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -882,7 +934,7 @@ ___ ▸ **trimPartitions**(): *Promise‹void›* -*Defined in [lib/source-destination/configured-source/configured-source.ts:228](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L228)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:245](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L245)* **Returns:** *Promise‹void›* @@ -894,7 +946,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -915,7 +967,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -934,7 +988,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/countinghashstream.md b/doc/classes/countinghashstream.md index 4e9b646e..8393b545 100644 --- a/doc/classes/countinghashstream.md +++ b/doc/classes/countinghashstream.md @@ -24,14 +24,19 @@ * [bytesWritten](countinghashstream.md#byteswritten) * [readable](countinghashstream.md#readable) * [readableHighWaterMark](countinghashstream.md#readablehighwatermark) +* [readableLength](countinghashstream.md#readablelength) * [writable](countinghashstream.md#writable) * [writableHighWaterMark](countinghashstream.md#writablehighwatermark) +* [writableLength](countinghashstream.md#writablelength) * [defaultMaxListeners](countinghashstream.md#static-defaultmaxlisteners) ### Methods +* [[Symbol.asyncIterator]](countinghashstream.md#[symbol.asynciterator]) +* [__transform](countinghashstream.md#__transform) * [_destroy](countinghashstream.md#_destroy) * [_final](countinghashstream.md#_final) +* [_flush](countinghashstream.md#_flush) * [_read](countinghashstream.md#_read) * [_transform](countinghashstream.md#_transform) * [_write](countinghashstream.md#_write) @@ -46,6 +51,7 @@ * [isPaused](countinghashstream.md#ispaused) * [listenerCount](countinghashstream.md#listenercount) * [listeners](countinghashstream.md#listeners) +* [off](countinghashstream.md#off) * [on](countinghashstream.md#on) * [once](countinghashstream.md#once) * [pause](countinghashstream.md#pause) @@ -53,6 +59,7 @@ * [prependListener](countinghashstream.md#prependlistener) * [prependOnceListener](countinghashstream.md#prependoncelistener) * [push](countinghashstream.md#push) +* [rawListeners](countinghashstream.md#rawlisteners) * [read](countinghashstream.md#read) * [removeAllListeners](countinghashstream.md#removealllisteners) * [removeListener](countinghashstream.md#removelistener) @@ -77,7 +84,7 @@ *Overrides [SourceTransform](../interfaces/sourcetransform.md).[constructor](../interfaces/sourcetransform.md#constructor)* -*Defined in [typings/xxhash/index.d.ts:12](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/typings/xxhash/index.d.ts#L12)* +*Defined in [typings/xxhash/index.d.ts:12](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/typings/xxhash/index.d.ts#L12)* **Parameters:** @@ -95,7 +102,7 @@ Name | Type | • **bytesWritten**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L48)* +*Defined in [lib/source-destination/source-destination.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L53)* ___ @@ -105,7 +112,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readable](sparsefilterstream.md#readable)* -Defined in node_modules/@types/node/base.d.ts:5422 +Defined in node_modules/@types/node/stream.d.ts:20 ___ @@ -115,7 +122,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readableHighWaterMark](sparsefilterstream.md#readablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5423 +Defined in node_modules/@types/node/stream.d.ts:21 + +___ + +### readableLength + +• **readableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[readableLength](sparsefilterstream.md#readablelength)* + +Defined in node_modules/@types/node/stream.d.ts:22 ___ @@ -125,7 +142,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writable](sparsefilterstream.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5600 +Defined in node_modules/@types/node/stream.d.ts:209 ___ @@ -135,7 +152,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writableHighWaterMark](sparsefilterstream.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5601 +Defined in node_modules/@types/node/stream.d.ts:210 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[writableLength](sparsefilterstream.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:211 ___ @@ -145,10 +172,39 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹any›* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[[Symbol.asyncIterator]](sparsefilterstream.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/stream.d.ts:95 + +**Returns:** *AsyncIterableIterator‹any›* + +___ + +### __transform + +▸ **__transform**(`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | [AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md), `encoding`: string): *Promise‹void›* + +*Defined in [lib/source-destination/source-destination.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L55)* + +**Parameters:** + +Name | Type | +------ | ------ | +`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | [AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md) | +`encoding` | string | + +**Returns:** *Promise‹void›* + +___ + ### _destroy ▸ **_destroy**(`error`: [Error](notcapable.md#static-error) | null, `callback`: function): *void* @@ -157,7 +213,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadStream](sparsereadstream.md).[_destroy](sparsereadstream.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5605 +Defined in node_modules/@types/node/stream.d.ts:215 **Parameters:** @@ -165,13 +221,13 @@ Defined in node_modules/@types/node/base.d.ts:5605 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -179,17 +235,41 @@ ___ ### _final -▸ **_final**(`callback`: Function): *void* +▸ **_final**(`callback`: function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[_final](sparsefilterstream.md#_final)* -Defined in node_modules/@types/node/base.d.ts:5606 +Defined in node_modules/@types/node/stream.d.ts:216 + +**Parameters:** + +▪ **callback**: *function* + +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`callback` | Function | +`error?` | [Error](notcapable.md#static-error) | null | + +**Returns:** *void* + +___ + +### _flush + +▸ **_flush**(`callback`: TransformCallback): *void* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[_flush](sparsefilterstream.md#_flush)* + +Defined in node_modules/@types/node/stream.d.ts:242 + +**Parameters:** + +Name | Type | +------ | ------ | +`callback` | TransformCallback | **Returns:** *void* @@ -201,7 +281,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_read](sparsefilterstream.md#_read)* -Defined in node_modules/@types/node/base.d.ts:5425 +Defined in node_modules/@types/node/stream.d.ts:24 **Parameters:** @@ -215,21 +295,27 @@ ___ ### _transform -▸ **_transform**(`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `encoding`: string, `callback`: function): *void* +▸ **_transform**(`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | [AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md), `encoding`: string, `callback`: function): *void* *Overrides [SourceTransform](../interfaces/sourcetransform.md).[_transform](../interfaces/sourcetransform.md#_transform)* -*Defined in [lib/source-destination/source-destination.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L50)* +*Defined in [lib/source-destination/source-destination.ts:72](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L72)* **Parameters:** -▪ **chunk**: *[Buffer](../interfaces/alignedlockablebuffer.md#buffer)* +▪ **chunk**: *[Buffer](../interfaces/alignedlockablebuffer.md#buffer) | [AlignedLockableBuffer](../interfaces/alignedlockablebuffer.md)* ▪ **encoding**: *string* ▪ **callback**: *function* -▸ (): *void* +▸ (`error?`: [Error](notcapable.md#static-error)): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`error?` | [Error](notcapable.md#static-error) | **Returns:** *void* @@ -241,7 +327,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_write](sparsefilterstream.md#_write)* -Defined in node_modules/@types/node/base.d.ts:5603 +Defined in node_modules/@types/node/stream.d.ts:213 **Parameters:** @@ -251,13 +337,13 @@ Defined in node_modules/@types/node/base.d.ts:5603 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -269,7 +355,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_writev](sparsefilterstream.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5604 +Defined in node_modules/@types/node/stream.d.ts:214 **Parameters:** @@ -277,13 +363,13 @@ Defined in node_modules/@types/node/base.d.ts:5604 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -291,13 +377,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5447 +Defined in node_modules/@types/node/stream.d.ts:46 Event emitter The defined events on documents including: @@ -309,30 +395,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5448 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -347,7 +409,7 @@ Defined in node_modules/@types/node/base.d.ts:5448 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5449 +Defined in node_modules/@types/node/stream.d.ts:47 **Parameters:** @@ -355,13 +417,13 @@ Defined in node_modules/@types/node/base.d.ts:5449 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -371,7 +433,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5450 +Defined in node_modules/@types/node/stream.d.ts:48 **Parameters:** @@ -389,7 +451,7 @@ Defined in node_modules/@types/node/base.d.ts:5450 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5451 +Defined in node_modules/@types/node/stream.d.ts:49 **Parameters:** @@ -407,7 +469,7 @@ Defined in node_modules/@types/node/base.d.ts:5451 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5452 +Defined in node_modules/@types/node/stream.d.ts:50 **Parameters:** @@ -425,6 +487,30 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* + +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:51 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### cork @@ -433,7 +519,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[cork](sparsefilterstream.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5613 +Defined in node_modules/@types/node/stream.d.ts:223 **Returns:** *void* @@ -445,9 +531,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[destroy](sparsefilterstream.md#destroy)* -*Overrides [SparseReadStream](sparsereadstream.md).[destroy](sparsereadstream.md#destroy)* - -Defined in node_modules/@types/node/base.d.ts:5625 +Defined in node_modules/@types/node/stream.d.ts:35 **Parameters:** @@ -461,102 +545,102 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* +▸ **emit**(`event`: "close"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5454 +Defined in node_modules/@types/node/stream.d.ts:53 **Parameters:** Name | Type | ------ | ------ | -`event` | string | symbol | -`...args` | any[] | +`event` | "close" | **Returns:** *boolean* -▸ **emit**(`event`: "close"): *boolean* +▸ **emit**(`event`: "data", `chunk`: any): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5455 +Defined in node_modules/@types/node/stream.d.ts:54 **Parameters:** Name | Type | ------ | ------ | -`event` | "close" | +`event` | "data" | +`chunk` | any | **Returns:** *boolean* -▸ **emit**(`event`: "data", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "end"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5456 +Defined in node_modules/@types/node/stream.d.ts:55 **Parameters:** Name | Type | ------ | ------ | -`event` | "data" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`event` | "end" | **Returns:** *boolean* -▸ **emit**(`event`: "end"): *boolean* +▸ **emit**(`event`: "readable"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5457 +Defined in node_modules/@types/node/stream.d.ts:56 **Parameters:** Name | Type | ------ | ------ | -`event` | "end" | +`event` | "readable" | **Returns:** *boolean* -▸ **emit**(`event`: "readable"): *boolean* +▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5458 +Defined in node_modules/@types/node/stream.d.ts:57 **Parameters:** Name | Type | ------ | ------ | -`event` | "readable" | +`event` | "error" | +`err` | [Error](notcapable.md#static-error) | **Returns:** *boolean* -▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5459 +Defined in node_modules/@types/node/stream.d.ts:58 **Parameters:** Name | Type | ------ | ------ | -`event` | "error" | -`err` | [Error](notcapable.md#static-error) | +`event` | string | symbol | +`...args` | any[] | **Returns:** *boolean* @@ -564,40 +648,40 @@ ___ ### end -▸ **end**(`cb?`: Function): *void* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5610 +Defined in node_modules/@types/node/stream.d.ts:220 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5611 +Defined in node_modules/@types/node/stream.d.ts:221 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5612 +Defined in node_modules/@types/node/stream.d.ts:222 **Parameters:** @@ -605,7 +689,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -617,7 +701,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -629,7 +713,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -641,7 +725,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[isPaused](sparsefilterstream.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:5430 +Defined in node_modules/@types/node/stream.d.ts:29 **Returns:** *boolean* @@ -653,7 +737,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -671,7 +755,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -683,19 +767,17 @@ Name | Type | ___ -### on +### off -▸ **on**(`event`: string, `listener`: function): *this* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* - -Defined in node_modules/@types/node/base.d.ts:5461 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -709,13 +791,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5462 +Defined in node_modules/@types/node/stream.d.ts:60 **Parameters:** @@ -733,7 +819,7 @@ Defined in node_modules/@types/node/base.d.ts:5462 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5463 +Defined in node_modules/@types/node/stream.d.ts:61 **Parameters:** @@ -741,13 +827,13 @@ Defined in node_modules/@types/node/base.d.ts:5463 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -757,7 +843,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5464 +Defined in node_modules/@types/node/stream.d.ts:62 **Parameters:** @@ -775,7 +861,7 @@ Defined in node_modules/@types/node/base.d.ts:5464 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5465 +Defined in node_modules/@types/node/stream.d.ts:63 **Parameters:** @@ -793,7 +879,7 @@ Defined in node_modules/@types/node/base.d.ts:5465 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5466 +Defined in node_modules/@types/node/stream.d.ts:64 **Parameters:** @@ -811,21 +897,17 @@ Name | Type | **Returns:** *this* -___ +▸ **on**(`event`: string | symbol, `listener`: function): *this* -### once - -▸ **once**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5468 +Defined in node_modules/@types/node/stream.d.ts:65 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -839,13 +921,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5469 +Defined in node_modules/@types/node/stream.d.ts:67 **Parameters:** @@ -863,7 +949,7 @@ Defined in node_modules/@types/node/base.d.ts:5469 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5470 +Defined in node_modules/@types/node/stream.d.ts:68 **Parameters:** @@ -871,13 +957,13 @@ Defined in node_modules/@types/node/base.d.ts:5470 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -887,7 +973,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5471 +Defined in node_modules/@types/node/stream.d.ts:69 **Parameters:** @@ -905,7 +991,7 @@ Defined in node_modules/@types/node/base.d.ts:5471 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5472 +Defined in node_modules/@types/node/stream.d.ts:70 **Parameters:** @@ -923,7 +1009,7 @@ Defined in node_modules/@types/node/base.d.ts:5472 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5473 +Defined in node_modules/@types/node/stream.d.ts:71 **Parameters:** @@ -941,6 +1027,30 @@ Name | Type | **Returns:** *this* +▸ **once**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* + +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* + +Defined in node_modules/@types/node/stream.d.ts:72 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### pause @@ -949,7 +1059,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[pause](sparsefilterstream.md#pause)* -Defined in node_modules/@types/node/base.d.ts:5428 +Defined in node_modules/@types/node/stream.d.ts:27 **Returns:** *this* @@ -961,7 +1071,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:5407 +Defined in node_modules/@types/node/stream.d.ts:5 **Type parameters:** @@ -980,37 +1090,13 @@ ___ ### prependListener -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* - -Defined in node_modules/@types/node/base.d.ts:5475 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **prependListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5476 +Defined in node_modules/@types/node/stream.d.ts:74 **Parameters:** @@ -1028,7 +1114,7 @@ Defined in node_modules/@types/node/base.d.ts:5476 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5477 +Defined in node_modules/@types/node/stream.d.ts:75 **Parameters:** @@ -1036,13 +1122,13 @@ Defined in node_modules/@types/node/base.d.ts:5477 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1052,7 +1138,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5478 +Defined in node_modules/@types/node/stream.d.ts:76 **Parameters:** @@ -1070,7 +1156,7 @@ Defined in node_modules/@types/node/base.d.ts:5478 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5479 +Defined in node_modules/@types/node/stream.d.ts:77 **Parameters:** @@ -1088,7 +1174,7 @@ Defined in node_modules/@types/node/base.d.ts:5479 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5480 +Defined in node_modules/@types/node/stream.d.ts:78 **Parameters:** @@ -1106,21 +1192,17 @@ Name | Type | **Returns:** *this* -___ +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -### prependOnceListener - -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5482 +Defined in node_modules/@types/node/stream.d.ts:79 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1134,13 +1216,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5483 +Defined in node_modules/@types/node/stream.d.ts:81 **Parameters:** @@ -1158,7 +1244,7 @@ Defined in node_modules/@types/node/base.d.ts:5483 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5484 +Defined in node_modules/@types/node/stream.d.ts:82 **Parameters:** @@ -1166,13 +1252,13 @@ Defined in node_modules/@types/node/base.d.ts:5484 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1182,7 +1268,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5485 +Defined in node_modules/@types/node/stream.d.ts:83 **Parameters:** @@ -1200,7 +1286,7 @@ Defined in node_modules/@types/node/base.d.ts:5485 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5486 +Defined in node_modules/@types/node/stream.d.ts:84 **Parameters:** @@ -1218,7 +1304,7 @@ Defined in node_modules/@types/node/base.d.ts:5486 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5487 +Defined in node_modules/@types/node/stream.d.ts:85 **Parameters:** @@ -1236,6 +1322,30 @@ Name | Type | **Returns:** *this* +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* + +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* + +Defined in node_modules/@types/node/stream.d.ts:86 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### push @@ -1244,7 +1354,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[push](sparsefilterstream.md#push)* -Defined in node_modules/@types/node/base.d.ts:5434 +Defined in node_modules/@types/node/stream.d.ts:33 **Parameters:** @@ -1257,13 +1367,31 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`size?`: undefined | number): *any* *Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* -Defined in node_modules/@types/node/base.d.ts:5426 +Defined in node_modules/@types/node/stream.d.ts:25 **Parameters:** @@ -1281,7 +1409,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -1295,37 +1423,13 @@ ___ ### removeListener -▸ **removeListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* - -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5489 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5490 +Defined in node_modules/@types/node/stream.d.ts:88 **Parameters:** @@ -1343,7 +1447,7 @@ Defined in node_modules/@types/node/base.d.ts:5490 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5491 +Defined in node_modules/@types/node/stream.d.ts:89 **Parameters:** @@ -1351,13 +1455,13 @@ Defined in node_modules/@types/node/base.d.ts:5491 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1367,7 +1471,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5492 +Defined in node_modules/@types/node/stream.d.ts:90 **Parameters:** @@ -1385,7 +1489,7 @@ Defined in node_modules/@types/node/base.d.ts:5492 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5493 +Defined in node_modules/@types/node/stream.d.ts:91 **Parameters:** @@ -1403,7 +1507,7 @@ Defined in node_modules/@types/node/base.d.ts:5493 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5494 +Defined in node_modules/@types/node/stream.d.ts:92 **Parameters:** @@ -1421,6 +1525,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:93 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### resume @@ -1429,7 +1557,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[resume](sparsefilterstream.md#resume)* -Defined in node_modules/@types/node/base.d.ts:5429 +Defined in node_modules/@types/node/stream.d.ts:28 **Returns:** *this* @@ -1441,7 +1569,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setDefaultEncoding](sparsefilterstream.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5609 +Defined in node_modules/@types/node/stream.d.ts:219 **Parameters:** @@ -1459,7 +1587,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setEncoding](sparsefilterstream.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:5427 +Defined in node_modules/@types/node/stream.d.ts:26 **Parameters:** @@ -1477,7 +1605,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1495,7 +1623,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[uncork](sparsefilterstream.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5614 +Defined in node_modules/@types/node/stream.d.ts:224 **Returns:** *void* @@ -1503,21 +1631,17 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: NodeJS.WritableStream): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[unpipe](sparsefilterstream.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:5431 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/stream.d.ts:30 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | NodeJS.WritableStream | **Returns:** *this* @@ -1529,7 +1653,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[unshift](sparsefilterstream.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:5432 +Defined in node_modules/@types/node/stream.d.ts:31 **Parameters:** @@ -1547,7 +1671,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[wrap](sparsefilterstream.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:5433 +Defined in node_modules/@types/node/stream.d.ts:32 **Parameters:** @@ -1561,26 +1685,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5607 +Defined in node_modules/@types/node/stream.d.ts:217 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5608 +Defined in node_modules/@types/node/stream.d.ts:218 **Parameters:** @@ -1588,7 +1712,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1600,7 +1724,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/countingwritable.md b/doc/classes/countingwritable.md index 0e59c20f..a744458c 100644 --- a/doc/classes/countingwritable.md +++ b/doc/classes/countingwritable.md @@ -24,6 +24,7 @@ * [position](countingwritable.md#position) * [writable](countingwritable.md#writable) * [writableHighWaterMark](countingwritable.md#writablehighwatermark) +* [writableLength](countingwritable.md#writablelength) * [defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners) ### Methods @@ -41,11 +42,13 @@ * [getMaxListeners](countingwritable.md#getmaxlisteners) * [listenerCount](countingwritable.md#listenercount) * [listeners](countingwritable.md#listeners) +* [off](countingwritable.md#off) * [on](countingwritable.md#on) * [once](countingwritable.md#once) * [pipe](countingwritable.md#pipe) * [prependListener](countingwritable.md#prependlistener) * [prependOnceListener](countingwritable.md#prependoncelistener) +* [rawListeners](countingwritable.md#rawlisteners) * [removeAllListeners](countingwritable.md#removealllisteners) * [removeListener](countingwritable.md#removelistener) * [setDefaultEncoding](countingwritable.md#setdefaultencoding) @@ -62,7 +65,7 @@ *Inherited from [CountingWritable](countingwritable.md).[constructor](countingwritable.md#constructor)* -Defined in node_modules/@types/node/base.d.ts:5509 +Defined in node_modules/@types/node/stream.d.ts:111 **Parameters:** @@ -78,7 +81,7 @@ Name | Type | • **bytesWritten**: *number* = 0 -*Defined in [lib/source-destination/progress.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L92)* +*Defined in [lib/source-destination/progress.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L92)* ___ @@ -86,7 +89,7 @@ ___ • **position**: *number | undefined* -*Defined in [lib/source-destination/progress.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L93)* +*Defined in [lib/source-destination/progress.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L93)* ___ @@ -96,7 +99,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[writable](countingwritable.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5508 +Defined in node_modules/@types/node/stream.d.ts:109 ___ @@ -106,7 +109,17 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[writableHighWaterMark](countingwritable.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5509 +Defined in node_modules/@types/node/stream.d.ts:110 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [CountingWritable](countingwritable.md).[writableLength](countingwritable.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:111 ___ @@ -116,7 +129,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -126,7 +139,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Inherited from [CountingWritable](countingwritable.md).[_destroy](countingwritable.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5513 +Defined in node_modules/@types/node/stream.d.ts:115 **Parameters:** @@ -134,13 +147,13 @@ Defined in node_modules/@types/node/base.d.ts:5513 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -148,17 +161,23 @@ ___ ### _final -▸ **_final**(`callback`: Function): *void* +▸ **_final**(`callback`: function): *void* *Inherited from [CountingWritable](countingwritable.md).[_final](countingwritable.md#_final)* -Defined in node_modules/@types/node/base.d.ts:5514 +Defined in node_modules/@types/node/stream.d.ts:116 + +**Parameters:** + +▪ **callback**: *function* + +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`callback` | Function | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -170,7 +189,7 @@ ___ *Overrides void* -*Defined in [lib/source-destination/progress.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L95)* +*Defined in [lib/source-destination/progress.ts:95](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L95)* **Parameters:** @@ -198,7 +217,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[_writev](countingwritable.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5512 +Defined in node_modules/@types/node/stream.d.ts:114 **Parameters:** @@ -206,13 +225,13 @@ Defined in node_modules/@types/node/base.d.ts:5512 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -220,13 +239,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5535 +Defined in node_modules/@types/node/stream.d.ts:137 Event emitter The defined events on documents including: @@ -239,30 +258,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5536 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -277,7 +272,7 @@ Defined in node_modules/@types/node/base.d.ts:5536 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5537 +Defined in node_modules/@types/node/stream.d.ts:138 **Parameters:** @@ -295,7 +290,7 @@ Defined in node_modules/@types/node/base.d.ts:5537 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5538 +Defined in node_modules/@types/node/stream.d.ts:139 **Parameters:** @@ -319,7 +314,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5539 +Defined in node_modules/@types/node/stream.d.ts:140 **Parameters:** @@ -337,7 +332,7 @@ Defined in node_modules/@types/node/base.d.ts:5539 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5540 +Defined in node_modules/@types/node/stream.d.ts:141 **Parameters:** @@ -361,7 +356,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5541 +Defined in node_modules/@types/node/stream.d.ts:142 **Parameters:** @@ -379,6 +374,30 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* + +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:143 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### cork @@ -387,7 +406,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[cork](countingwritable.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5521 +Defined in node_modules/@types/node/stream.d.ts:123 **Returns:** *void* @@ -399,7 +418,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[destroy](countingwritable.md#destroy)* -Defined in node_modules/@types/node/base.d.ts:5523 +Defined in node_modules/@types/node/stream.d.ts:125 **Parameters:** @@ -413,30 +432,13 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* - -*Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* - -*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* - -Defined in node_modules/@types/node/base.d.ts:5543 - -**Parameters:** - -Name | Type | ------- | ------ | -`event` | string | symbol | -`...args` | any[] | - -**Returns:** *boolean* - ▸ **emit**(`event`: "close"): *boolean* *Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5544 +Defined in node_modules/@types/node/stream.d.ts:145 **Parameters:** @@ -446,20 +448,19 @@ Name | Type | **Returns:** *boolean* -▸ **emit**(`event`: "drain", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "drain"): *boolean* *Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5545 +Defined in node_modules/@types/node/stream.d.ts:146 **Parameters:** Name | Type | ------ | ------ | `event` | "drain" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | **Returns:** *boolean* @@ -469,7 +470,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5546 +Defined in node_modules/@types/node/stream.d.ts:147 **Parameters:** @@ -486,7 +487,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5547 +Defined in node_modules/@types/node/stream.d.ts:148 **Parameters:** @@ -502,7 +503,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5548 +Defined in node_modules/@types/node/stream.d.ts:149 **Parameters:** @@ -519,7 +520,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5549 +Defined in node_modules/@types/node/stream.d.ts:150 **Parameters:** @@ -530,44 +531,61 @@ Name | Type | **Returns:** *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* + +*Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* + +*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* + +Defined in node_modules/@types/node/stream.d.ts:151 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | +`...args` | any[] | + +**Returns:** *boolean* + ___ ### end -▸ **end**(`cb?`: Function): *void* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5518 +Defined in node_modules/@types/node/stream.d.ts:120 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5519 +Defined in node_modules/@types/node/stream.d.ts:121 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5520 +Defined in node_modules/@types/node/stream.d.ts:122 **Parameters:** @@ -575,7 +593,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -587,7 +605,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -599,7 +617,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -611,7 +629,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -629,7 +647,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -641,19 +659,17 @@ Name | Type | ___ -### on - -▸ **on**(`event`: string, `listener`: function): *this* +### off -*Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -Defined in node_modules/@types/node/base.d.ts:5551 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -667,13 +683,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5552 +Defined in node_modules/@types/node/stream.d.ts:153 **Parameters:** @@ -691,7 +711,7 @@ Defined in node_modules/@types/node/base.d.ts:5552 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5553 +Defined in node_modules/@types/node/stream.d.ts:154 **Parameters:** @@ -709,7 +729,7 @@ Defined in node_modules/@types/node/base.d.ts:5553 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5554 +Defined in node_modules/@types/node/stream.d.ts:155 **Parameters:** @@ -733,7 +753,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5555 +Defined in node_modules/@types/node/stream.d.ts:156 **Parameters:** @@ -751,7 +771,7 @@ Defined in node_modules/@types/node/base.d.ts:5555 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5556 +Defined in node_modules/@types/node/stream.d.ts:157 **Parameters:** @@ -775,7 +795,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5557 +Defined in node_modules/@types/node/stream.d.ts:158 **Parameters:** @@ -793,21 +813,17 @@ Name | Type | **Returns:** *this* -___ +▸ **on**(`event`: string | symbol, `listener`: function): *this* -### once - -▸ **once**(`event`: string, `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* +*Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5559 +Defined in node_modules/@types/node/stream.d.ts:159 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -821,13 +837,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5560 +Defined in node_modules/@types/node/stream.d.ts:161 **Parameters:** @@ -845,7 +865,7 @@ Defined in node_modules/@types/node/base.d.ts:5560 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5561 +Defined in node_modules/@types/node/stream.d.ts:162 **Parameters:** @@ -863,7 +883,7 @@ Defined in node_modules/@types/node/base.d.ts:5561 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5562 +Defined in node_modules/@types/node/stream.d.ts:163 **Parameters:** @@ -887,7 +907,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5563 +Defined in node_modules/@types/node/stream.d.ts:164 **Parameters:** @@ -905,7 +925,7 @@ Defined in node_modules/@types/node/base.d.ts:5563 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5564 +Defined in node_modules/@types/node/stream.d.ts:165 **Parameters:** @@ -929,7 +949,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5565 +Defined in node_modules/@types/node/stream.d.ts:166 **Parameters:** @@ -947,56 +967,56 @@ Name | Type | **Returns:** *this* -___ +▸ **once**(`event`: string | symbol, `listener`: function): *this* -### pipe +*Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* -▸ **pipe**<**T**>(`destination`: T, `options?`: undefined | object): *T* +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -*Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* +Defined in node_modules/@types/node/stream.d.ts:167 -Defined in node_modules/@types/node/base.d.ts:5407 +**Parameters:** -**Type parameters:** +▪ **event**: *string | symbol* -▪ **T**: *WritableStream* +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* **Parameters:** Name | Type | ------ | ------ | -`destination` | T | -`options?` | undefined | object | +`...args` | any[] | -**Returns:** *T* +**Returns:** *this* ___ -### prependListener - -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[prependListener](countingwritable.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* +### pipe -Defined in node_modules/@types/node/base.d.ts:5567 +▸ **pipe**<**T**>(`destination`: T, `options?`: undefined | object): *T* -**Parameters:** +*Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -▪ **event**: *string* +Defined in node_modules/@types/node/stream.d.ts:5 -▪ **listener**: *function* +**Type parameters:** -▸ (...`args`: any[]): *void* +▪ **T**: *WritableStream* **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`destination` | T | +`options?` | undefined | object | -**Returns:** *this* +**Returns:** *T* + +___ + +### prependListener ▸ **prependListener**(`event`: "close", `listener`: function): *this* @@ -1004,7 +1024,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5568 +Defined in node_modules/@types/node/stream.d.ts:169 **Parameters:** @@ -1022,7 +1042,7 @@ Defined in node_modules/@types/node/base.d.ts:5568 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5569 +Defined in node_modules/@types/node/stream.d.ts:170 **Parameters:** @@ -1040,7 +1060,7 @@ Defined in node_modules/@types/node/base.d.ts:5569 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5570 +Defined in node_modules/@types/node/stream.d.ts:171 **Parameters:** @@ -1064,7 +1084,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5571 +Defined in node_modules/@types/node/stream.d.ts:172 **Parameters:** @@ -1082,7 +1102,7 @@ Defined in node_modules/@types/node/base.d.ts:5571 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5572 +Defined in node_modules/@types/node/stream.d.ts:173 **Parameters:** @@ -1106,7 +1126,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5573 +Defined in node_modules/@types/node/stream.d.ts:174 **Parameters:** @@ -1124,21 +1144,17 @@ Name | Type | **Returns:** *this* -___ - -### prependOnceListener - -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* +*Inherited from [CountingWritable](countingwritable.md).[prependListener](countingwritable.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5575 +Defined in node_modules/@types/node/stream.d.ts:175 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1152,13 +1168,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5576 +Defined in node_modules/@types/node/stream.d.ts:177 **Parameters:** @@ -1176,7 +1196,7 @@ Defined in node_modules/@types/node/base.d.ts:5576 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5577 +Defined in node_modules/@types/node/stream.d.ts:178 **Parameters:** @@ -1194,7 +1214,7 @@ Defined in node_modules/@types/node/base.d.ts:5577 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5578 +Defined in node_modules/@types/node/stream.d.ts:179 **Parameters:** @@ -1218,7 +1238,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5579 +Defined in node_modules/@types/node/stream.d.ts:180 **Parameters:** @@ -1236,7 +1256,7 @@ Defined in node_modules/@types/node/base.d.ts:5579 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5580 +Defined in node_modules/@types/node/stream.d.ts:181 **Parameters:** @@ -1260,7 +1280,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5581 +Defined in node_modules/@types/node/stream.d.ts:182 **Parameters:** @@ -1278,59 +1298,77 @@ Name | Type | **Returns:** *this* -___ +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* -### removeAllListeners +*Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* -▸ **removeAllListeners**(`event?`: string | symbol): *this* +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* +Defined in node_modules/@types/node/stream.d.ts:183 + +**Parameters:** + +▪ **event**: *string | symbol* -Defined in node_modules/@types/node/base.d.ts:904 +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* **Parameters:** Name | Type | ------ | ------ | -`event?` | string | symbol | +`...args` | any[] | **Returns:** *this* ___ -### removeListener +### rawListeners -▸ **removeListener**(`event`: string, `listener`: function): *this* +▸ **rawListeners**(`event`: string | symbol): *Function[]* -*Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5583 +Defined in node_modules/@types/node/events.d.ts:31 **Parameters:** -▪ **event**: *string* +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* -▪ **listener**: *function* +___ -▸ (...`args`: any[]): *void* +### removeAllListeners + +▸ **removeAllListeners**(`event?`: string | symbol): *this* + +*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* + +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`event?` | string | symbol | **Returns:** *this* +___ + +### removeListener + ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5584 +Defined in node_modules/@types/node/stream.d.ts:185 **Parameters:** @@ -1348,7 +1386,7 @@ Defined in node_modules/@types/node/base.d.ts:5584 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5585 +Defined in node_modules/@types/node/stream.d.ts:186 **Parameters:** @@ -1366,7 +1404,7 @@ Defined in node_modules/@types/node/base.d.ts:5585 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5586 +Defined in node_modules/@types/node/stream.d.ts:187 **Parameters:** @@ -1390,7 +1428,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5587 +Defined in node_modules/@types/node/stream.d.ts:188 **Parameters:** @@ -1408,7 +1446,7 @@ Defined in node_modules/@types/node/base.d.ts:5587 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5588 +Defined in node_modules/@types/node/stream.d.ts:189 **Parameters:** @@ -1432,7 +1470,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5589 +Defined in node_modules/@types/node/stream.d.ts:190 **Parameters:** @@ -1450,6 +1488,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:191 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### setDefaultEncoding @@ -1458,7 +1520,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setDefaultEncoding](countingwritable.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5517 +Defined in node_modules/@types/node/stream.d.ts:119 **Parameters:** @@ -1476,7 +1538,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1494,7 +1556,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[uncork](countingwritable.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5522 +Defined in node_modules/@types/node/stream.d.ts:124 **Returns:** *void* @@ -1502,26 +1564,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [CountingWritable](countingwritable.md).[write](countingwritable.md#write)* -Defined in node_modules/@types/node/base.d.ts:5515 +Defined in node_modules/@types/node/stream.d.ts:117 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [CountingWritable](countingwritable.md).[write](countingwritable.md#write)* -Defined in node_modules/@types/node/base.d.ts:5516 +Defined in node_modules/@types/node/stream.d.ts:118 **Parameters:** @@ -1529,7 +1591,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1541,7 +1603,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/crc32hasher.md b/doc/classes/crc32hasher.md index e840c5d7..9be3a07a 100644 --- a/doc/classes/crc32hasher.md +++ b/doc/classes/crc32hasher.md @@ -24,7 +24,7 @@ • **crc32**: *crc32* = getCrc().crc32 -*Defined in [lib/sparse-stream/shared.ts:64](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L64)* +*Defined in [lib/sparse-stream/shared.ts:64](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L64)* ___ @@ -32,7 +32,7 @@ ___ • **value**: *number* -*Defined in [lib/sparse-stream/shared.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L63)* +*Defined in [lib/sparse-stream/shared.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L63)* ## Methods @@ -40,7 +40,7 @@ ___ ▸ **digest**(`_encoding`: "hex"): *string* -*Defined in [lib/sparse-stream/shared.ts:70](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L70)* +*Defined in [lib/sparse-stream/shared.ts:70](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L70)* **Parameters:** @@ -56,7 +56,7 @@ ___ ▸ **update**(`data`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer)): *void* -*Defined in [lib/sparse-stream/shared.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L66)* +*Defined in [lib/sparse-stream/shared.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L66)* **Parameters:** diff --git a/doc/classes/dmgsource.md b/doc/classes/dmgsource.md index 6d41351d..8c0d8bcc 100644 --- a/doc/classes/dmgsource.md +++ b/doc/classes/dmgsource.md @@ -52,11 +52,13 @@ * [getPartitionTable](dmgsource.md#getpartitiontable) * [listenerCount](dmgsource.md#listenercount) * [listeners](dmgsource.md#listeners) +* [off](dmgsource.md#off) * [on](dmgsource.md#on) * [once](dmgsource.md#once) * [open](dmgsource.md#open) * [prependListener](dmgsource.md#prependlistener) * [prependOnceListener](dmgsource.md#prependoncelistener) +* [rawListeners](dmgsource.md#rawlisteners) * [read](dmgsource.md#read) * [removeAllListeners](dmgsource.md#removealllisteners) * [removeListener](dmgsource.md#removelistener) @@ -73,7 +75,7 @@ *Overrides [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/dmg.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L52)* +*Defined in [lib/source-destination/dmg.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L52)* **Parameters:** @@ -89,7 +91,7 @@ Name | Type | • **image**: *UDIFImage* -*Defined in [lib/source-destination/dmg.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L52)* +*Defined in [lib/source-destination/dmg.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L52)* ___ @@ -99,7 +101,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -109,7 +111,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -130,7 +132,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -144,7 +146,7 @@ ___ BLOCK.LZFSE, ] -*Defined in [lib/source-destination/dmg.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L43)* +*Defined in [lib/source-destination/dmg.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L43)* ___ @@ -154,7 +156,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/dmg.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L51)* +*Defined in [lib/source-destination/dmg.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L51)* ___ @@ -164,7 +166,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/dmg.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L50)* +*Defined in [lib/source-destination/dmg.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L50)* ## Methods @@ -174,7 +176,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_close](sourcesource.md#protected-_close)* -*Defined in [lib/source-destination/dmg.ts:159](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L159)* +*Defined in [lib/source-destination/dmg.ts:160](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L160)* **Returns:** *Promise‹void›* @@ -186,7 +188,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/dmg.ts:146](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L146)* +*Defined in [lib/source-destination/dmg.ts:147](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L147)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -198,7 +200,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_open](sourcesource.md#protected-_open)* -*Defined in [lib/source-destination/dmg.ts:154](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L154)* +*Defined in [lib/source-destination/dmg.ts:155](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L155)* **Returns:** *Promise‹void›* @@ -212,7 +214,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -238,7 +240,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/dmg.ts:59](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L59)* +*Defined in [lib/source-destination/dmg.ts:59](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L59)* **Returns:** *Promise‹boolean›* @@ -250,7 +252,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/dmg.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L63)* +*Defined in [lib/source-destination/dmg.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L63)* **Returns:** *Promise‹boolean›* @@ -262,7 +264,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -274,7 +276,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -286,7 +288,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -298,7 +300,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -310,7 +312,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -322,7 +324,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/dmg.ts:67](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L67)* +*Defined in [lib/source-destination/dmg.ts:67](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L67)* **Parameters:** @@ -345,7 +347,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/dmg.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L84)* +*Defined in [lib/source-destination/dmg.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L84)* **Parameters:** @@ -366,7 +368,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -386,7 +388,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -405,7 +407,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -427,7 +429,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -448,7 +450,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -460,7 +462,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -472,7 +474,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/dmg.ts:106](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/dmg.ts#L106)* +*Defined in [lib/source-destination/dmg.ts:107](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/dmg.ts#L107)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -484,7 +486,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -498,7 +500,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -510,7 +512,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -522,7 +524,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -536,7 +538,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -556,7 +558,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -568,6 +570,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -576,7 +606,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -604,7 +634,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -630,7 +660,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -644,7 +674,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -672,7 +702,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -692,13 +722,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -721,7 +771,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -741,7 +791,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -769,7 +819,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -787,7 +837,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -808,7 +858,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -827,7 +879,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/driverlessdevice.md b/doc/classes/driverlessdevice.md index 89f84939..8453c4f6 100644 --- a/doc/classes/driverlessdevice.md +++ b/doc/classes/driverlessdevice.md @@ -62,11 +62,13 @@ * [getPartitionTable](driverlessdevice.md#getpartitiontable) * [listenerCount](driverlessdevice.md#listenercount) * [listeners](driverlessdevice.md#listeners) +* [off](driverlessdevice.md#off) * [on](driverlessdevice.md#on) * [once](driverlessdevice.md#once) * [open](driverlessdevice.md#open) * [prependListener](driverlessdevice.md#prependlistener) * [prependOnceListener](driverlessdevice.md#prependoncelistener) +* [rawListeners](driverlessdevice.md#rawlisteners) * [read](driverlessdevice.md#read) * [removeAllListeners](driverlessdevice.md#removealllisteners) * [removeListener](driverlessdevice.md#removelistener) @@ -81,7 +83,7 @@ \+ **new DriverlessDevice**(`driverlessDevice`: WinUsbDriverlessDevice): *[DriverlessDevice](driverlessdevice.md)* -*Defined in [lib/source-destination/driverless.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L33)* +*Defined in [lib/source-destination/driverless.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L33)* **Parameters:** @@ -97,7 +99,7 @@ Name | Type | • **accessible**: *boolean* = false -*Defined in [lib/source-destination/driverless.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L24)* +*Defined in [lib/source-destination/driverless.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L24)* ___ @@ -107,7 +109,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[description](../interfaces/adaptersourcedestination.md#description)* -*Defined in [lib/source-destination/driverless.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L33)* +*Defined in [lib/source-destination/driverless.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L33)* ___ @@ -117,7 +119,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[device](../interfaces/adaptersourcedestination.md#device)* -*Defined in [lib/source-destination/driverless.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L26)* +*Defined in [lib/source-destination/driverless.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L26)* ___ @@ -125,7 +127,7 @@ ___ • **deviceDescriptor**: *object* -*Defined in [lib/source-destination/driverless.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L32)* +*Defined in [lib/source-destination/driverless.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L32)* #### Type declaration: @@ -141,7 +143,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[devicePath](../interfaces/adaptersourcedestination.md#devicepath)* -*Defined in [lib/source-destination/driverless.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L27)* +*Defined in [lib/source-destination/driverless.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L27)* ___ @@ -151,7 +153,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[emitsProgress](../interfaces/adaptersourcedestination.md#emitsprogress)* -*Defined in [lib/source-destination/driverless.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L31)* +*Defined in [lib/source-destination/driverless.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L31)* ___ @@ -161,7 +163,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[isSystem](../interfaces/adaptersourcedestination.md#issystem)* -*Defined in [lib/source-destination/driverless.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L28)* +*Defined in [lib/source-destination/driverless.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L28)* ___ @@ -171,7 +173,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[mountpoints](../interfaces/adaptersourcedestination.md#mountpoints)* -*Defined in [lib/source-destination/driverless.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L29)* +*Defined in [lib/source-destination/driverless.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L29)* ___ @@ -181,7 +183,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[raw](../interfaces/adaptersourcedestination.md#raw)* -*Defined in [lib/source-destination/driverless.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L25)* +*Defined in [lib/source-destination/driverless.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L25)* ___ @@ -191,7 +193,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[size](../interfaces/adaptersourcedestination.md#size)* -*Defined in [lib/source-destination/driverless.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/driverless.ts#L30)* +*Defined in [lib/source-destination/driverless.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/driverless.ts#L30)* ___ @@ -203,7 +205,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -226,7 +228,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -238,7 +240,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Methods @@ -250,7 +252,7 @@ ___ *Inherited from [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-destination.ts:379](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L379)* +*Defined in [lib/source-destination/source-destination.ts:402](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L402)* **Returns:** *Promise‹void›* @@ -264,7 +266,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L311)* +*Defined in [lib/source-destination/source-destination.ts:334](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L334)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -278,7 +280,7 @@ ___ *Inherited from [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-destination.ts:375](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L375)* +*Defined in [lib/source-destination/source-destination.ts:398](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L398)* **Returns:** *Promise‹void›* @@ -292,7 +294,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -320,7 +322,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/source-destination.ts:288](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L288)* +*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L311)* **Returns:** *Promise‹boolean›* @@ -334,7 +336,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -348,7 +350,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -362,7 +364,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -376,7 +378,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -390,7 +392,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -404,7 +406,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -418,7 +420,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/source-destination.ts:333](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L333)* +*Defined in [lib/source-destination/source-destination.ts:356](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L356)* **Parameters:** @@ -438,7 +440,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -456,7 +458,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -478,7 +480,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -497,7 +499,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -521,7 +523,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -544,7 +546,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -558,7 +560,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -572,7 +574,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -586,7 +588,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -602,7 +604,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -616,7 +618,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -630,7 +632,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -646,7 +648,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -668,7 +670,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -680,6 +682,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -688,7 +718,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -716,7 +746,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -744,7 +774,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -758,7 +788,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -786,7 +816,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -806,6 +836,28 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md)* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* @@ -814,7 +866,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -839,7 +891,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -859,7 +911,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -889,7 +941,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -909,7 +961,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -932,7 +984,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -953,7 +1007,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/driverlessdeviceadapter_.md b/doc/classes/driverlessdeviceadapter_.md index ccd7d4b0..210693b5 100644 --- a/doc/classes/driverlessdeviceadapter_.md +++ b/doc/classes/driverlessdeviceadapter_.md @@ -27,10 +27,12 @@ * [listDrives](driverlessdeviceadapter_.md#private-listdrives) * [listenerCount](driverlessdeviceadapter_.md#listenercount) * [listeners](driverlessdeviceadapter_.md#listeners) +* [off](driverlessdeviceadapter_.md#off) * [on](driverlessdeviceadapter_.md#on) * [once](driverlessdeviceadapter_.md#once) * [prependListener](driverlessdeviceadapter_.md#prependlistener) * [prependOnceListener](driverlessdeviceadapter_.md#prependoncelistener) +* [rawListeners](driverlessdeviceadapter_.md#rawlisteners) * [removeAllListeners](driverlessdeviceadapter_.md#removealllisteners) * [removeListener](driverlessdeviceadapter_.md#removelistener) * [scan](driverlessdeviceadapter_.md#private-scan) @@ -46,7 +48,7 @@ • **drives**: *Map‹string, [DriverlessDevice](driverlessdevice.md)›* = new Map() -*Defined in [lib/scanner/adapters/driverless.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L30)* +*Defined in [lib/scanner/adapters/driverless.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L30)* ___ @@ -54,7 +56,7 @@ ___ • **listDriverlessDevices**: *any* -*Defined in [lib/scanner/adapters/driverless.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L33)* +*Defined in [lib/scanner/adapters/driverless.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L33)* ___ @@ -62,7 +64,7 @@ ___ • **ready**: *boolean* = false -*Defined in [lib/scanner/adapters/driverless.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L32)* +*Defined in [lib/scanner/adapters/driverless.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L32)* ___ @@ -70,7 +72,7 @@ ___ • **running**: *boolean* = false -*Defined in [lib/scanner/adapters/driverless.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L31)* +*Defined in [lib/scanner/adapters/driverless.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L31)* ___ @@ -80,7 +82,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -92,7 +94,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -120,7 +122,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -141,7 +143,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -155,7 +157,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -165,7 +167,7 @@ ___ ▸ **listDrives**(): *Map‹string, WinUsbDriverlessDevice›* -*Defined in [lib/scanner/adapters/driverless.ts:88](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L88)* +*Defined in [lib/scanner/adapters/driverless.ts:88](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L88)* **Returns:** *Map‹string, WinUsbDriverlessDevice›* @@ -179,7 +181,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -199,7 +201,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -211,6 +213,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -219,7 +249,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -247,7 +277,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -275,7 +305,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -303,7 +333,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -323,6 +353,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -331,7 +381,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -351,7 +401,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -375,7 +425,7 @@ ___ ▸ **scan**(): *void* -*Defined in [lib/scanner/adapters/driverless.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L63)* +*Defined in [lib/scanner/adapters/driverless.ts:63](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L63)* **Returns:** *void* @@ -385,7 +435,7 @@ ___ ▸ **scanLoop**(): *Promise‹void›* -*Defined in [lib/scanner/adapters/driverless.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L46)* +*Defined in [lib/scanner/adapters/driverless.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L46)* **Returns:** *Promise‹void›* @@ -399,7 +449,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -417,7 +467,7 @@ ___ *Overrides [Adapter](adapter.md).[start](adapter.md#abstract-start)* -*Defined in [lib/scanner/adapters/driverless.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L35)* +*Defined in [lib/scanner/adapters/driverless.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L35)* **Returns:** *void* @@ -429,7 +479,7 @@ ___ *Overrides [Adapter](adapter.md).[stop](adapter.md#abstract-stop)* -*Defined in [lib/scanner/adapters/driverless.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/driverless.ts#L40)* +*Defined in [lib/scanner/adapters/driverless.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/driverless.ts#L40)* **Returns:** *void* @@ -441,7 +491,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/file.md b/doc/classes/file.md index 5d829809..17876e00 100644 --- a/doc/classes/file.md +++ b/doc/classes/file.md @@ -18,7 +18,7 @@ ### Properties -* [fd](file.md#protected-fd) +* [fileHandle](file.md#protected-filehandle) * [oWrite](file.md#owrite) * [path](file.md#path) * [defaultMaxListeners](file.md#static-defaultmaxlisteners) @@ -54,11 +54,13 @@ * [getPartitionTable](file.md#getpartitiontable) * [listenerCount](file.md#listenercount) * [listeners](file.md#listeners) +* [off](file.md#off) * [on](file.md#on) * [once](file.md#once) * [open](file.md#open) * [prependListener](file.md#prependlistener) * [prependOnceListener](file.md#prependoncelistener) +* [rawListeners](file.md#rawlisteners) * [read](file.md#read) * [removeAllListeners](file.md#removealllisteners) * [removeListener](file.md#removelistener) @@ -72,26 +74,28 @@ ### constructor -\+ **new File**(`path`: string, `oWrite`: boolean): *[File](file.md)* +\+ **new File**(`__namedParameters`: object): *[File](file.md)* -*Defined in [lib/source-destination/file.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L51)* +*Defined in [lib/source-destination/file.ts:54](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L54)* **Parameters:** +▪ **__namedParameters**: *object* + Name | Type | Default | ------ | ------ | ------ | `path` | string | - | -`oWrite` | boolean | false | +`write` | boolean | false | **Returns:** *[File](file.md)* ## Properties -### `Protected` fd +### `Protected` fileHandle -• **fd**: *number* +• **fileHandle**: *fs.FileHandle* -*Defined in [lib/source-destination/file.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L51)* +*Defined in [lib/source-destination/file.ts:54](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L54)* ___ @@ -99,7 +103,7 @@ ___ • **oWrite**: *boolean* -*Defined in [lib/source-destination/file.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L53)* +*Defined in [lib/source-destination/file.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L53)* ___ @@ -107,7 +111,7 @@ ___ • **path**: *string* -*Defined in [lib/source-destination/file.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L53)* +*Defined in [lib/source-destination/file.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L52)* ___ @@ -117,7 +121,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -138,7 +142,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -148,7 +152,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Methods @@ -158,7 +162,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/file.ts:184](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L184)* +*Defined in [lib/source-destination/file.ts:234](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L234)* **Returns:** *Promise‹void›* @@ -170,7 +174,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/file.ts:81](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L81)* +*Defined in [lib/source-destination/file.ts:86](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L86)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -182,7 +186,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/file.ts:180](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L180)* +*Defined in [lib/source-destination/file.ts:230](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L230)* **Returns:** *Promise‹void›* @@ -196,7 +200,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -222,7 +226,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/file.ts:69](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L69)* +*Defined in [lib/source-destination/file.ts:74](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L74)* **Returns:** *Promise‹boolean›* @@ -234,7 +238,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -246,7 +250,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/file.ts:77](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L77)* +*Defined in [lib/source-destination/file.ts:82](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L82)* **Returns:** *Promise‹boolean›* @@ -258,7 +262,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/file.ts:73](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L73)* +*Defined in [lib/source-destination/file.ts:78](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L78)* **Returns:** *Promise‹boolean›* @@ -270,7 +274,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/file.ts:61](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L61)* +*Defined in [lib/source-destination/file.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L66)* **Returns:** *Promise‹boolean›* @@ -282,7 +286,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/file.ts:65](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L65)* +*Defined in [lib/source-destination/file.ts:70](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L70)* **Returns:** *Promise‹boolean›* @@ -294,7 +298,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -306,7 +310,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/file.ts:117](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L117)* +*Defined in [lib/source-destination/file.ts:167](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L167)* **Parameters:** @@ -330,7 +334,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -348,7 +352,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/file.ts:169](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L169)* +*Defined in [lib/source-destination/file.ts:219](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L219)* **Parameters:** @@ -368,7 +372,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -387,7 +391,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/file.ts:155](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L155)* +*Defined in [lib/source-destination/file.ts:205](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L205)* **Parameters:** @@ -409,7 +413,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -430,7 +434,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -442,7 +446,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -454,7 +458,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -466,7 +470,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -480,7 +484,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -492,7 +496,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -502,7 +506,7 @@ ___ ▸ **getOpenFlags**(): *number* -*Defined in [lib/source-destination/file.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L57)* +*Defined in [lib/source-destination/file.ts:62](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L62)* **Returns:** *number* @@ -514,7 +518,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -528,7 +532,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -548,7 +552,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -560,6 +564,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -568,7 +600,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -596,7 +628,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -622,7 +654,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -636,7 +668,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -664,7 +696,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -684,13 +716,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `sourceOffset`: number): *Promise‹ReadResult›* *Overrides [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/file.ts:88](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L88)* +*Defined in [lib/source-destination/file.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L93)* **Parameters:** @@ -713,7 +765,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -733,7 +785,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -761,7 +813,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -777,7 +829,7 @@ ___ ▸ **streamOptions**(`start?`: undefined | number, `end?`: undefined | number): *object* -*Defined in [lib/source-destination/file.ts:106](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L106)* +*Defined in [lib/source-destination/file.ts:156](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L156)* **Parameters:** @@ -792,7 +844,7 @@ Name | Type | * **end**: *undefined | number* -* **fd**: *number* = this.fd +* **fd**: *number* = this.fileHandle.fd * **highWaterMark**: *number* = CHUNK_SIZE @@ -806,7 +858,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/file.ts:97](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/file.ts#L97)* +*Defined in [lib/source-destination/file.ts:142](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/file.ts#L142)* **Parameters:** @@ -827,7 +879,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -846,7 +900,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/gzipsource.md b/doc/classes/gzipsource.md index e06efd38..cccb6e84 100644 --- a/doc/classes/gzipsource.md +++ b/doc/classes/gzipsource.md @@ -53,11 +53,13 @@ * [getSize](gzipsource.md#protected-getsize) * [listenerCount](gzipsource.md#listenercount) * [listeners](gzipsource.md#listeners) +* [off](gzipsource.md#off) * [on](gzipsource.md#on) * [once](gzipsource.md#once) * [open](gzipsource.md#open) * [prependListener](gzipsource.md#prependlistener) * [prependOnceListener](gzipsource.md#prependoncelistener) +* [rawListeners](gzipsource.md#rawlisteners) * [read](gzipsource.md#read) * [removeAllListeners](gzipsource.md#removealllisteners) * [removeListener](gzipsource.md#removelistener) @@ -74,7 +76,7 @@ *Inherited from [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* **Parameters:** @@ -92,7 +94,7 @@ Name | Type | *Overrides [CompressedSource](compressedsource.md).[isSizeEstimated](compressedsource.md#protected-issizeestimated)* -*Defined in [lib/source-destination/gzip.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/gzip.ts#L27)* +*Defined in [lib/source-destination/gzip.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/gzip.ts#L27)* ___ @@ -102,7 +104,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -112,7 +114,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -133,7 +135,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -143,7 +145,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/gzip.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/gzip.ts#L26)* +*Defined in [lib/source-destination/gzip.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/gzip.ts#L26)* ___ @@ -153,7 +155,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -165,7 +167,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L30)* +*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L30)* **Returns:** *Promise‹void›* @@ -179,7 +181,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/compressed-source.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L85)* +*Defined in [lib/source-destination/compressed-source.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L85)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -193,7 +195,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L26)* +*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L26)* **Returns:** *Promise‹void›* @@ -207,7 +209,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -235,7 +237,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/compressed-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L51)* +*Defined in [lib/source-destination/compressed-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L51)* **Returns:** *Promise‹boolean›* @@ -247,7 +249,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -259,7 +261,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -271,7 +273,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -283,7 +285,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -295,7 +297,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -307,7 +309,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -321,7 +323,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/compressed-source.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L55)* +*Defined in [lib/source-destination/compressed-source.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L55)* **Parameters:** @@ -343,7 +345,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -361,7 +363,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -381,7 +383,7 @@ ___ *Overrides [CompressedSource](compressedsource.md).[createTransform](compressedsource.md#protected-abstract-createtransform)* -*Defined in [lib/source-destination/gzip.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/gzip.ts#L29)* +*Defined in [lib/source-destination/gzip.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/gzip.ts#L29)* **Returns:** *Transform* @@ -393,7 +395,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -412,7 +414,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -434,7 +436,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -455,7 +457,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -467,7 +469,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -479,7 +481,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -491,7 +493,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -505,7 +507,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -517,7 +519,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -529,7 +531,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -541,7 +543,7 @@ ___ *Overrides [CompressedSource](compressedsource.md).[getSize](compressedsource.md#protected-getsize)* -*Defined in [lib/source-destination/gzip.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/gzip.ts#L33)* +*Defined in [lib/source-destination/gzip.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/gzip.ts#L33)* **Returns:** *Promise‹number | undefined›* @@ -555,7 +557,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -575,7 +577,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -587,6 +589,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -595,7 +625,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -623,7 +653,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -649,7 +679,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -663,7 +693,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -691,7 +721,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -711,13 +741,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -740,7 +790,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -760,7 +810,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -788,7 +838,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -806,7 +856,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -827,7 +877,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -846,7 +898,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/http.md b/doc/classes/http.md index ed614d98..72bea188 100644 --- a/doc/classes/http.md +++ b/doc/classes/http.md @@ -55,11 +55,13 @@ * [getRange](http.md#private-getrange) * [listenerCount](http.md#listenercount) * [listeners](http.md#listeners) +* [off](http.md#off) * [on](http.md#on) * [once](http.md#once) * [open](http.md#open) * [prependListener](http.md#prependlistener) * [prependOnceListener](http.md#prependoncelistener) +* [rawListeners](http.md#rawlisteners) * [read](http.md#read) * [removeAllListeners](http.md#removealllisteners) * [removeListener](http.md#removelistener) @@ -74,7 +76,7 @@ \+ **new Http**(`url`: string): *[Http](http.md)* -*Defined in [lib/source-destination/http.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L39)* +*Defined in [lib/source-destination/http.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L39)* **Parameters:** @@ -90,7 +92,7 @@ Name | Type | • **acceptsRange**: *boolean* -*Defined in [lib/source-destination/http.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L37)* +*Defined in [lib/source-destination/http.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L37)* ___ @@ -98,7 +100,7 @@ ___ • **error**: *[Error](notcapable.md#static-error)* -*Defined in [lib/source-destination/http.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L39)* +*Defined in [lib/source-destination/http.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L39)* ___ @@ -106,7 +108,7 @@ ___ • **ready**: *Promise‹void›* -*Defined in [lib/source-destination/http.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L38)* +*Defined in [lib/source-destination/http.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L38)* ___ @@ -114,7 +116,7 @@ ___ • **size**: *number* -*Defined in [lib/source-destination/http.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L36)* +*Defined in [lib/source-destination/http.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L36)* ___ @@ -122,7 +124,7 @@ ___ • **url**: *string* -*Defined in [lib/source-destination/http.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L41)* +*Defined in [lib/source-destination/http.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L41)* ___ @@ -132,7 +134,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -153,7 +155,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -163,7 +165,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Methods @@ -173,7 +175,7 @@ ___ *Inherited from [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-destination.ts:379](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L379)* +*Defined in [lib/source-destination/source-destination.ts:402](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L402)* **Returns:** *Promise‹void›* @@ -185,7 +187,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/http.ts:68](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L68)* +*Defined in [lib/source-destination/http.ts:68](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L68)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -197,7 +199,7 @@ ___ *Inherited from [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-destination.ts:375](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L375)* +*Defined in [lib/source-destination/source-destination.ts:398](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L398)* **Returns:** *Promise‹void›* @@ -211,7 +213,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -237,7 +239,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/http.ts:64](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L64)* +*Defined in [lib/source-destination/http.ts:64](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L64)* **Returns:** *Promise‹boolean›* @@ -249,7 +251,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -261,7 +263,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -273,7 +275,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -285,7 +287,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/http.ts:56](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L56)* +*Defined in [lib/source-destination/http.ts:56](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L56)* **Returns:** *Promise‹boolean›* @@ -297,7 +299,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -309,7 +311,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -321,7 +323,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/http.ts:113](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L113)* +*Defined in [lib/source-destination/http.ts:113](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L113)* **Parameters:** @@ -343,7 +345,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -361,7 +363,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -381,7 +383,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -400,7 +402,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -422,7 +424,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -443,7 +445,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -455,7 +457,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -467,7 +469,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -477,7 +479,7 @@ ___ ▸ **getInfo**(): *Promise‹void›* -*Defined in [lib/source-destination/http.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L46)* +*Defined in [lib/source-destination/http.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L46)* **Returns:** *Promise‹void›* @@ -489,7 +491,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -503,7 +505,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -515,7 +517,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -527,7 +529,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -537,7 +539,7 @@ ___ ▸ **getRange**(`start`: number, `end?`: undefined | number): *string* -*Defined in [lib/source-destination/http.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L84)* +*Defined in [lib/source-destination/http.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L84)* **Parameters:** @@ -558,7 +560,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -578,7 +580,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -590,6 +592,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -598,7 +628,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -626,7 +656,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -652,7 +682,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -666,7 +696,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -694,7 +724,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -714,13 +744,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `sourceOffset`: number): *Promise‹ReadResult›* *Overrides [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/http.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/http.ts#L93)* +*Defined in [lib/source-destination/http.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/http.ts#L93)* **Parameters:** @@ -743,7 +793,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -763,7 +813,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -791,7 +841,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -809,7 +859,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -830,7 +880,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -849,7 +901,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/multidestination.md b/doc/classes/multidestination.md index 06fc480d..d5c9a870 100644 --- a/doc/classes/multidestination.md +++ b/doc/classes/multidestination.md @@ -57,11 +57,13 @@ * [getPartitionTable](multidestination.md#getpartitiontable) * [listenerCount](multidestination.md#listenercount) * [listeners](multidestination.md#listeners) +* [off](multidestination.md#off) * [on](multidestination.md#on) * [once](multidestination.md#once) * [open](multidestination.md#open) * [prependListener](multidestination.md#prependlistener) * [prependOnceListener](multidestination.md#prependoncelistener) +* [rawListeners](multidestination.md#rawlisteners) * [read](multidestination.md#read) * [removeAllListeners](multidestination.md#removealllisteners) * [removeListener](multidestination.md#removelistener) @@ -76,7 +78,7 @@ \+ **new MultiDestination**(`destinations`: [SourceDestination](sourcedestination.md)[]): *[MultiDestination](multidestination.md)* -*Defined in [lib/source-destination/multi-destination.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L110)* +*Defined in [lib/source-destination/multi-destination.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L110)* **Parameters:** @@ -92,7 +94,7 @@ Name | Type | • **destinations**: *Set‹[SourceDestination](sourcedestination.md)›* = new Set() -*Defined in [lib/source-destination/multi-destination.ts:109](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L109)* +*Defined in [lib/source-destination/multi-destination.ts:109](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L109)* ___ @@ -100,7 +102,7 @@ ___ • **erroredDestinations**: *Set‹[SourceDestination](sourcedestination.md)›* = new Set() -*Defined in [lib/source-destination/multi-destination.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L110)* +*Defined in [lib/source-destination/multi-destination.ts:110](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L110)* ___ @@ -110,7 +112,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -131,7 +133,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -141,7 +143,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Accessors @@ -149,7 +151,7 @@ ___ • **get activeDestinations**(): *Set‹[SourceDestination](sourcedestination.md)›* -*Defined in [lib/source-destination/multi-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L153)* +*Defined in [lib/source-destination/multi-destination.ts:154](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L154)* **Returns:** *Set‹[SourceDestination](sourcedestination.md)›* @@ -161,7 +163,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/multi-destination.ts:354](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L354)* +*Defined in [lib/source-destination/multi-destination.ts:367](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L367)* **Returns:** *Promise‹void›* @@ -173,7 +175,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L311)* +*Defined in [lib/source-destination/source-destination.ts:334](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L334)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -185,7 +187,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/multi-destination.ts:344](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L344)* +*Defined in [lib/source-destination/multi-destination.ts:357](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L357)* **Returns:** *Promise‹void›* @@ -199,7 +201,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -223,7 +225,7 @@ ___ ▸ **can**(`methodName`: "canRead" | "canWrite" | "canCreateReadStream" | "canCreateSparseReadStream" | "canCreateWriteStream" | "canCreateSparseWriteStream"): *Promise‹boolean›* -*Defined in [lib/source-destination/multi-destination.ts:157](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L157)* +*Defined in [lib/source-destination/multi-destination.ts:158](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L158)* **Parameters:** @@ -241,7 +243,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/multi-destination.ts:184](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L184)* +*Defined in [lib/source-destination/multi-destination.ts:185](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L185)* **Returns:** *Promise‹boolean›* @@ -253,7 +255,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/multi-destination.ts:188](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L188)* +*Defined in [lib/source-destination/multi-destination.ts:189](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L189)* **Returns:** *Promise‹boolean›* @@ -265,7 +267,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/multi-destination.ts:196](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L196)* +*Defined in [lib/source-destination/multi-destination.ts:197](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L197)* **Returns:** *Promise‹boolean›* @@ -277,7 +279,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/multi-destination.ts:192](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L192)* +*Defined in [lib/source-destination/multi-destination.ts:193](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L193)* **Returns:** *Promise‹boolean›* @@ -289,7 +291,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/multi-destination.ts:176](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L176)* +*Defined in [lib/source-destination/multi-destination.ts:177](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L177)* **Returns:** *Promise‹boolean›* @@ -301,7 +303,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/multi-destination.ts:180](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L180)* +*Defined in [lib/source-destination/multi-destination.ts:181](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L181)* **Returns:** *Promise‹boolean›* @@ -313,7 +315,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -325,7 +327,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/multi-destination.ts:237](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L237)* +*Defined in [lib/source-destination/multi-destination.ts:238](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L238)* **Parameters:** @@ -343,7 +345,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/multi-destination.ts:246](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L246)* +*Defined in [lib/source-destination/multi-destination.ts:247](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L247)* **Parameters:** @@ -357,17 +359,17 @@ ___ ### createSparseWriteStream -▸ **createSparseWriteStream**(...`args`: any[]): *Promise‹[SparseWritable](../interfaces/sparsewritable.md)›* +▸ **createSparseWriteStream**(...`args`: Parameters‹SourceDestination["createSparseWriteStream"]›): *Promise‹[SparseWritable](../interfaces/sparsewritable.md)›* *Overrides [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/multi-destination.ts:331](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L331)* +*Defined in [lib/source-destination/multi-destination.ts:344](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L344)* **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`...args` | Parameters‹SourceDestination["createSparseWriteStream"]› | **Returns:** *Promise‹[SparseWritable](../interfaces/sparsewritable.md)›* @@ -375,18 +377,31 @@ ___ ### `Private` createStream -▸ **createStream**(`methodName`: "createWriteStream" | "createSparseWriteStream", ...`args`: any[]): *Promise‹PassThrough‹››* +▸ **createStream**(`methodName`: "createWriteStream", ...`args`: Parameters‹SourceDestination["createWriteStream"]›): *Promise‹WritableStream›* -*Defined in [lib/source-destination/multi-destination.ts:255](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L255)* +*Defined in [lib/source-destination/multi-destination.ts:256](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L256)* **Parameters:** Name | Type | ------ | ------ | -`methodName` | "createWriteStream" | "createSparseWriteStream" | -`...args` | any[] | +`methodName` | "createWriteStream" | +`...args` | Parameters‹SourceDestination["createWriteStream"]› | + +**Returns:** *Promise‹WritableStream›* -**Returns:** *Promise‹PassThrough‹››* +▸ **createStream**(`methodName`: "createSparseWriteStream", ...`args`: Parameters‹SourceDestination["createSparseWriteStream"]›): *Promise‹[SparseWritable](../interfaces/sparsewritable.md)›* + +*Defined in [lib/source-destination/multi-destination.ts:261](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L261)* + +**Parameters:** + +Name | Type | +------ | ------ | +`methodName` | "createSparseWriteStream" | +`...args` | Parameters‹SourceDestination["createSparseWriteStream"]› | + +**Returns:** *Promise‹[SparseWritable](../interfaces/sparsewritable.md)›* ___ @@ -396,7 +411,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/multi-destination.ts:337](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L337)* +*Defined in [lib/source-destination/multi-destination.ts:350](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L350)* **Parameters:** @@ -411,17 +426,17 @@ ___ ### createWriteStream -▸ **createWriteStream**(...`args`: any[]): *Promise‹WritableStream›* +▸ **createWriteStream**(...`args`: Parameters‹SourceDestination["createWriteStream"]›): *Promise‹WritableStream›* *Overrides [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/multi-destination.ts:325](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L325)* +*Defined in [lib/source-destination/multi-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L338)* **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`...args` | Parameters‹SourceDestination["createWriteStream"]› | **Returns:** *Promise‹WritableStream›* @@ -431,7 +446,7 @@ ___ ▸ **destinationError**(`destination`: [SourceDestination](sourcedestination.md), `error`: [Error](notcapable.md#static-error), `stream?`: EventEmitter): *void* -*Defined in [lib/source-destination/multi-destination.ts:134](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L134)* +*Defined in [lib/source-destination/multi-destination.ts:135](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L135)* **Parameters:** @@ -453,7 +468,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -474,7 +489,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -486,7 +501,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/multi-destination.ts:122](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L122)* +*Defined in [lib/source-destination/multi-destination.ts:122](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L122)* **Returns:** *number | undefined* @@ -498,7 +513,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -510,7 +525,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -524,7 +539,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -536,7 +551,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -548,7 +563,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -562,7 +577,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -582,7 +597,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -594,6 +609,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -602,7 +645,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -630,7 +673,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -656,7 +699,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -670,7 +713,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -698,7 +741,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -718,13 +761,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `sourceOffset`: number): *Promise‹ReadResult›* *Overrides [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/multi-destination.ts:200](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L200)* +*Defined in [lib/source-destination/multi-destination.ts:201](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L201)* **Parameters:** @@ -747,7 +810,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -767,7 +830,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -795,7 +858,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -813,7 +876,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/multi-destination.ts:215](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L215)* +*Defined in [lib/source-destination/multi-destination.ts:216](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L216)* **Parameters:** @@ -834,7 +897,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -853,7 +918,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/multidestinationerror.md b/doc/classes/multidestinationerror.md index 68cab0f3..5f641099 100644 --- a/doc/classes/multidestinationerror.md +++ b/doc/classes/multidestinationerror.md @@ -29,7 +29,7 @@ \+ **new MultiDestinationError**(`error`: [Error](notcapable.md#static-error), `destination`: [SourceDestination](sourcedestination.md)): *[MultiDestinationError](multidestinationerror.md)* -*Defined in [lib/source-destination/multi-destination.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L41)* +*Defined in [lib/source-destination/multi-destination.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L41)* **Parameters:** @@ -46,7 +46,7 @@ Name | Type | • **destination**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/source-destination/multi-destination.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L42)* +*Defined in [lib/source-destination/multi-destination.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L42)* ___ @@ -54,7 +54,7 @@ ___ • **error**: *[Error](notcapable.md#static-error)* -*Defined in [lib/source-destination/multi-destination.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L42)* +*Defined in [lib/source-destination/multi-destination.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L42)* ___ diff --git a/doc/classes/multidestinationverifier.md b/doc/classes/multidestinationverifier.md index 116bee9c..2fe1e49c 100644 --- a/doc/classes/multidestinationverifier.md +++ b/doc/classes/multidestinationverifier.md @@ -30,11 +30,13 @@ * [handleEventsAndPipe](multidestinationverifier.md#protected-handleeventsandpipe) * [listenerCount](multidestinationverifier.md#listenercount) * [listeners](multidestinationverifier.md#listeners) +* [off](multidestinationverifier.md#off) * [on](multidestinationverifier.md#on) * [once](multidestinationverifier.md#once) * [oneVerifierFinished](multidestinationverifier.md#private-oneverifierfinished) * [prependListener](multidestinationverifier.md#prependlistener) * [prependOnceListener](multidestinationverifier.md#prependoncelistener) +* [rawListeners](multidestinationverifier.md#rawlisteners) * [removeAllListeners](multidestinationverifier.md#removealllisteners) * [removeListener](multidestinationverifier.md#removelistener) * [run](multidestinationverifier.md#run) @@ -51,7 +53,7 @@ \+ **new MultiDestinationVerifier**(`source`: [MultiDestination](multidestination.md), `checksumOrBlocks`: string | [BlocksWithChecksum](../interfaces/blockswithchecksum.md)[], `size?`: undefined | number): *[MultiDestinationVerifier](multidestinationverifier.md)* -*Defined in [lib/source-destination/multi-destination.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L49)* +*Defined in [lib/source-destination/multi-destination.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L49)* **Parameters:** @@ -69,7 +71,7 @@ Name | Type | • **timer**: *Timer* -*Defined in [lib/source-destination/multi-destination.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L49)* +*Defined in [lib/source-destination/multi-destination.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L49)* ___ @@ -77,7 +79,7 @@ ___ • **verifiers**: *Set‹[Verifier](verifier.md)›* = new Set() -*Defined in [lib/source-destination/multi-destination.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L48)* +*Defined in [lib/source-destination/multi-destination.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L48)* ___ @@ -87,7 +89,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -99,7 +101,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -127,7 +129,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -144,7 +146,7 @@ ___ ▸ **emitProgress**(): *void* -*Defined in [lib/source-destination/multi-destination.ts:82](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L82)* +*Defined in [lib/source-destination/multi-destination.ts:82](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L82)* **Returns:** *void* @@ -158,7 +160,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -172,7 +174,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -184,7 +186,7 @@ ___ *Inherited from [Verifier](verifier.md).[handleEventsAndPipe](verifier.md#protected-handleeventsandpipe)* -*Defined in [lib/source-destination/source-destination.ts:134](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L134)* +*Defined in [lib/source-destination/source-destination.ts:157](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L157)* **Parameters:** @@ -205,7 +207,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -225,7 +227,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -237,6 +239,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -245,7 +275,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -273,7 +303,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -297,7 +327,7 @@ ___ ▸ **oneVerifierFinished**(`verifier`: [Verifier](verifier.md)): *void* -*Defined in [lib/source-destination/multi-destination.ts:70](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L70)* +*Defined in [lib/source-destination/multi-destination.ts:70](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L70)* **Parameters:** @@ -317,7 +347,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -345,7 +375,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -365,6 +395,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -373,7 +423,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -393,7 +443,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -419,7 +469,7 @@ ___ *Overrides [Verifier](verifier.md).[run](verifier.md#abstract-run)* -*Defined in [lib/source-destination/multi-destination.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/multi-destination.ts#L92)* +*Defined in [lib/source-destination/multi-destination.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/multi-destination.ts#L92)* **Returns:** *Promise‹void›* @@ -433,7 +483,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -451,7 +501,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -470,22 +522,22 @@ Name | Type | *Inherited from [Verifier](verifier.md).[progress](verifier.md#progress)* -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### bytes • **bytes**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### position • **position**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### speed • **speed**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* diff --git a/doc/classes/randomaccesszipsource.md b/doc/classes/randomaccesszipsource.md index eca42d82..c6b01e3b 100644 --- a/doc/classes/randomaccesszipsource.md +++ b/doc/classes/randomaccesszipsource.md @@ -62,11 +62,13 @@ * [init](randomaccesszipsource.md#private-init) * [listenerCount](randomaccesszipsource.md#listenercount) * [listeners](randomaccesszipsource.md#listeners) +* [off](randomaccesszipsource.md#off) * [on](randomaccesszipsource.md#on) * [once](randomaccesszipsource.md#once) * [open](randomaccesszipsource.md#open) * [prependListener](randomaccesszipsource.md#prependlistener) * [prependOnceListener](randomaccesszipsource.md#prependoncelistener) +* [rawListeners](randomaccesszipsource.md#rawlisteners) * [read](randomaccesszipsource.md#read) * [removeAllListeners](randomaccesszipsource.md#removealllisteners) * [removeListener](randomaccesszipsource.md#removelistener) @@ -83,7 +85,7 @@ *Overrides [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/zip.ts:166](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L166)* +*Defined in [lib/source-destination/zip.ts:166](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L166)* **Parameters:** @@ -107,7 +109,7 @@ Name | Type | • **entries**: *Entry[]* = [] -*Defined in [lib/source-destination/zip.ts:166](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L166)* +*Defined in [lib/source-destination/zip.ts:166](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L166)* ___ @@ -115,7 +117,7 @@ ___ • **match**: *function* -*Defined in [lib/source-destination/zip.ts:170](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L170)* +*Defined in [lib/source-destination/zip.ts:170](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L170)* #### Type declaration: @@ -133,7 +135,7 @@ ___ • **ready**: *Promise‹void›* -*Defined in [lib/source-destination/zip.ts:165](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L165)* +*Defined in [lib/source-destination/zip.ts:165](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L165)* ___ @@ -143,7 +145,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -151,7 +153,7 @@ ___ • **zip**: *ZipFile* -*Defined in [lib/source-destination/zip.ts:164](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L164)* +*Defined in [lib/source-destination/zip.ts:164](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L164)* ___ @@ -161,7 +163,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -182,7 +184,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -199,7 +201,7 @@ ___ 'version', ] -*Defined in [lib/source-destination/zip.ts:154](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L154)* +*Defined in [lib/source-destination/zip.ts:154](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L154)* ___ @@ -209,7 +211,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ___ @@ -219,7 +221,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -231,7 +233,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L30)* +*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L30)* **Returns:** *Promise‹void›* @@ -243,7 +245,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/zip.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L324)* +*Defined in [lib/source-destination/zip.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L324)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -255,7 +257,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_open](sourcesource.md#protected-_open)* -*Defined in [lib/source-destination/zip.ts:231](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L231)* +*Defined in [lib/source-destination/zip.ts:231](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L231)* **Returns:** *Promise‹void›* @@ -269,7 +271,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -295,7 +297,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/zip.ts:202](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L202)* +*Defined in [lib/source-destination/zip.ts:202](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L202)* **Returns:** *Promise‹boolean›* @@ -307,7 +309,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/zip.ts:206](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L206)* +*Defined in [lib/source-destination/zip.ts:206](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L206)* **Returns:** *Promise‹boolean›* @@ -319,7 +321,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -331,7 +333,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -343,7 +345,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -355,7 +357,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -367,7 +369,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -379,7 +381,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/zip.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L275)* +*Defined in [lib/source-destination/zip.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L275)* **Parameters:** @@ -402,7 +404,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/zip.ts:301](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L301)* +*Defined in [lib/source-destination/zip.ts:301](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L301)* **Parameters:** @@ -424,7 +426,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -444,7 +446,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -463,7 +465,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -485,7 +487,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -506,7 +508,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -518,7 +520,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -530,7 +532,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -540,7 +542,7 @@ ___ ▸ **getEntries**(): *Promise‹Entry[]›* -*Defined in [lib/source-destination/zip.ts:211](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L211)* +*Defined in [lib/source-destination/zip.ts:211](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L211)* **Returns:** *Promise‹Entry[]›* @@ -550,7 +552,7 @@ ___ ▸ **getEntryByName**(`name`: string): *Promise‹Entry | undefined›* -*Defined in [lib/source-destination/zip.ts:237](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L237)* +*Defined in [lib/source-destination/zip.ts:237](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L237)* **Parameters:** @@ -566,7 +568,7 @@ ___ ▸ **getImageEntry**(): *Promise‹Entry›* -*Defined in [lib/source-destination/zip.ts:216](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L216)* +*Defined in [lib/source-destination/zip.ts:216](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L216)* **Returns:** *Promise‹Entry›* @@ -578,7 +580,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -588,7 +590,7 @@ ___ ▸ **getJson**(`name`: string): *Promise‹any›* -*Defined in [lib/source-destination/zip.ts:268](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L268)* +*Defined in [lib/source-destination/zip.ts:268](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L268)* **Parameters:** @@ -608,7 +610,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -620,7 +622,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -632,7 +634,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -642,7 +644,7 @@ ___ ▸ **getStream**(`name`: string): *Promise‹ReadableStream | undefined›* -*Defined in [lib/source-destination/zip.ts:246](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L246)* +*Defined in [lib/source-destination/zip.ts:246](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L246)* **Parameters:** @@ -658,7 +660,7 @@ ___ ▸ **getString**(`name`: string): *Promise‹string | undefined›* -*Defined in [lib/source-destination/zip.ts:260](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L260)* +*Defined in [lib/source-destination/zip.ts:260](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L260)* **Parameters:** @@ -674,7 +676,7 @@ ___ ▸ **init**(): *Promise‹void›* -*Defined in [lib/source-destination/zip.ts:176](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L176)* +*Defined in [lib/source-destination/zip.ts:176](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L176)* **Returns:** *Promise‹void›* @@ -688,7 +690,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -708,7 +710,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -720,6 +722,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -728,7 +758,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -756,7 +786,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -782,7 +812,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -796,7 +826,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -824,7 +854,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -844,13 +874,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -873,7 +923,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -893,7 +943,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -921,7 +971,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -939,7 +989,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -960,7 +1010,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -979,7 +1031,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/scanner.md b/doc/classes/scanner.md index a120bdd2..5084c0d5 100644 --- a/doc/classes/scanner.md +++ b/doc/classes/scanner.md @@ -29,12 +29,14 @@ * [getMaxListeners](scanner.md#getmaxlisteners) * [listenerCount](scanner.md#listenercount) * [listeners](scanner.md#listeners) +* [off](scanner.md#off) * [on](scanner.md#on) * [onAttach](scanner.md#private-onattach) * [onDetach](scanner.md#private-ondetach) * [once](scanner.md#once) * [prependListener](scanner.md#prependlistener) * [prependOnceListener](scanner.md#prependoncelistener) +* [rawListeners](scanner.md#rawlisteners) * [removeAllListeners](scanner.md#removealllisteners) * [removeListener](scanner.md#removelistener) * [setMaxListeners](scanner.md#setmaxlisteners) @@ -48,7 +50,7 @@ \+ **new Scanner**(`adapters`: [Adapter](adapter.md)[]): *[Scanner](scanner.md)* -*Defined in [lib/scanner/scanner.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L25)* +*Defined in [lib/scanner/scanner.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L25)* **Parameters:** @@ -64,7 +66,7 @@ Name | Type | • **adapters**: *[Adapter](adapter.md)[]* -*Defined in [lib/scanner/scanner.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L27)* +*Defined in [lib/scanner/scanner.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L27)* ___ @@ -72,7 +74,7 @@ ___ • **drives**: *Set‹[AdapterSourceDestination](../interfaces/adaptersourcedestination.md)›* = new Set() -*Defined in [lib/scanner/scanner.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L25)* +*Defined in [lib/scanner/scanner.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L25)* ___ @@ -82,7 +84,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -94,7 +96,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -122,7 +124,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -143,7 +145,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -153,7 +155,7 @@ ___ ▸ **getBy**(`field`: "raw" | "device" | "devicePath", `value`: string): *[AdapterSourceDestination](../interfaces/adaptersourcedestination.md) | undefined* -*Defined in [lib/scanner/scanner.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L46)* +*Defined in [lib/scanner/scanner.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L46)* **Parameters:** @@ -174,7 +176,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -188,7 +190,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -208,7 +210,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -220,6 +222,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -228,7 +258,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -252,7 +282,7 @@ ___ ▸ **onAttach**(`drive`: [AdapterSourceDestination](../interfaces/adaptersourcedestination.md)): *void* -*Defined in [lib/scanner/scanner.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L36)* +*Defined in [lib/scanner/scanner.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L36)* **Parameters:** @@ -268,7 +298,7 @@ ___ ▸ **onDetach**(`drive`: [AdapterSourceDestination](../interfaces/adaptersourcedestination.md)): *void* -*Defined in [lib/scanner/scanner.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L41)* +*Defined in [lib/scanner/scanner.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L41)* **Parameters:** @@ -288,7 +318,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -316,7 +346,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -344,7 +374,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -364,6 +394,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -372,7 +422,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -392,7 +442,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -420,7 +470,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -436,7 +486,7 @@ ___ ▸ **start**(): *Promise‹void›* -*Defined in [lib/scanner/scanner.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L57)* +*Defined in [lib/scanner/scanner.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L57)* **Returns:** *Promise‹void›* @@ -446,7 +496,7 @@ ___ ▸ **stop**(): *void* -*Defined in [lib/scanner/scanner.ts:74](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/scanner.ts#L74)* +*Defined in [lib/scanner/scanner.ts:74](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/scanner.ts#L74)* **Returns:** *void* @@ -458,7 +508,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/singleusestreamsource.md b/doc/classes/singleusestreamsource.md index 80720efe..981d6482 100644 --- a/doc/classes/singleusestreamsource.md +++ b/doc/classes/singleusestreamsource.md @@ -50,11 +50,13 @@ * [getPartitionTable](singleusestreamsource.md#getpartitiontable) * [listenerCount](singleusestreamsource.md#listenercount) * [listeners](singleusestreamsource.md#listeners) +* [off](singleusestreamsource.md#off) * [on](singleusestreamsource.md#on) * [once](singleusestreamsource.md#once) * [open](singleusestreamsource.md#open) * [prependListener](singleusestreamsource.md#prependlistener) * [prependOnceListener](singleusestreamsource.md#prependoncelistener) +* [rawListeners](singleusestreamsource.md#rawlisteners) * [read](singleusestreamsource.md#read) * [removeAllListeners](singleusestreamsource.md#removealllisteners) * [removeListener](singleusestreamsource.md#removelistener) @@ -69,7 +71,7 @@ \+ **new SingleUseStreamSource**(`stream`: ReadableStream): *[SingleUseStreamSource](singleusestreamsource.md)* -*Defined in [lib/source-destination/single-use-stream-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/single-use-stream-source.ts#L26)* +*Defined in [lib/source-destination/single-use-stream-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/single-use-stream-source.ts#L26)* **Parameters:** @@ -85,7 +87,7 @@ Name | Type | • **stream**: *ReadableStream* -*Defined in [lib/source-destination/single-use-stream-source.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/single-use-stream-source.ts#L28)* +*Defined in [lib/source-destination/single-use-stream-source.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/single-use-stream-source.ts#L28)* ___ @@ -93,7 +95,7 @@ ___ • **used**: *boolean* = false -*Defined in [lib/source-destination/single-use-stream-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/single-use-stream-source.ts#L26)* +*Defined in [lib/source-destination/single-use-stream-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/single-use-stream-source.ts#L26)* ___ @@ -103,7 +105,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -124,7 +126,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -134,7 +136,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Methods @@ -144,7 +146,7 @@ ___ *Inherited from [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-destination.ts:379](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L379)* +*Defined in [lib/source-destination/source-destination.ts:402](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L402)* **Returns:** *Promise‹void›* @@ -156,7 +158,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L311)* +*Defined in [lib/source-destination/source-destination.ts:334](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L334)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -168,7 +170,7 @@ ___ *Inherited from [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-destination.ts:375](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L375)* +*Defined in [lib/source-destination/source-destination.ts:398](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L398)* **Returns:** *Promise‹void›* @@ -182,7 +184,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -208,7 +210,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/single-use-stream-source.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/single-use-stream-source.ts#L32)* +*Defined in [lib/source-destination/single-use-stream-source.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/single-use-stream-source.ts#L32)* **Returns:** *Promise‹boolean›* @@ -220,7 +222,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -232,7 +234,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -244,7 +246,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -256,7 +258,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -268,7 +270,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -280,7 +282,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -292,7 +294,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/single-use-stream-source.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/single-use-stream-source.ts#L36)* +*Defined in [lib/source-destination/single-use-stream-source.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/single-use-stream-source.ts#L36)* **Parameters:** @@ -313,7 +315,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -331,7 +333,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -351,7 +353,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -370,7 +372,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -392,7 +394,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -413,7 +415,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -425,7 +427,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -437,7 +439,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -449,7 +451,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -463,7 +465,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -475,7 +477,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -487,7 +489,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -501,7 +503,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -521,7 +523,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -533,6 +535,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -541,7 +571,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -569,7 +599,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -595,7 +625,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -609,7 +639,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -637,7 +667,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -657,13 +687,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -686,7 +736,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -706,7 +756,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -734,7 +784,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -752,7 +802,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -773,7 +823,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -792,7 +844,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/sourcedestination.md b/doc/classes/sourcedestination.md index bc6edf90..bcd023d9 100644 --- a/doc/classes/sourcedestination.md +++ b/doc/classes/sourcedestination.md @@ -68,11 +68,13 @@ * [getPartitionTable](sourcedestination.md#getpartitiontable) * [listenerCount](sourcedestination.md#listenercount) * [listeners](sourcedestination.md#listeners) +* [off](sourcedestination.md#off) * [on](sourcedestination.md#on) * [once](sourcedestination.md#once) * [open](sourcedestination.md#open) * [prependListener](sourcedestination.md#prependlistener) * [prependOnceListener](sourcedestination.md#prependoncelistener) +* [rawListeners](sourcedestination.md#rawlisteners) * [read](sourcedestination.md#read) * [removeAllListeners](sourcedestination.md#removealllisteners) * [removeListener](sourcedestination.md#removelistener) @@ -87,7 +89,7 @@ • **isOpen**: *boolean* = false -*Defined in [lib/source-destination/source-destination.ts:268](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L268)* +*Defined in [lib/source-destination/source-destination.ts:291](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L291)* ___ @@ -95,7 +97,7 @@ ___ • **metadata**: *[Metadata](../interfaces/metadata.md)* -*Defined in [lib/source-destination/source-destination.ts:267](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L267)* +*Defined in [lib/source-destination/source-destination.ts:290](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L290)* ___ @@ -105,7 +107,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -124,7 +126,7 @@ ___ 'wic', ] -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -132,7 +134,7 @@ ___ ▪ **mimetype**? : *undefined | string* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ___ @@ -140,7 +142,7 @@ ___ ▪ **mimetypes**: *Map‹string, [SourceSource](sourcesource.md)›* = new Map() -*Defined in [lib/source-destination/source-destination.ts:265](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L265)* +*Defined in [lib/source-destination/source-destination.ts:288](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L288)* ## Methods @@ -148,7 +150,7 @@ ___ ▸ **_close**(): *Promise‹void›* -*Defined in [lib/source-destination/source-destination.ts:379](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L379)* +*Defined in [lib/source-destination/source-destination.ts:402](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L402)* **Returns:** *Promise‹void›* @@ -158,7 +160,7 @@ ___ ▸ **_getMetadata**(): *Promise‹[Metadata](../interfaces/metadata.md)›* -*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L311)* +*Defined in [lib/source-destination/source-destination.ts:334](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L334)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -168,7 +170,7 @@ ___ ▸ **_open**(): *Promise‹void›* -*Defined in [lib/source-destination/source-destination.ts:375](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L375)* +*Defined in [lib/source-destination/source-destination.ts:398](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L398)* **Returns:** *Promise‹void›* @@ -182,7 +184,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -206,7 +208,7 @@ ___ ▸ **canCreateReadStream**(): *Promise‹boolean›* -*Defined in [lib/source-destination/source-destination.ts:288](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L288)* +*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L311)* **Returns:** *Promise‹boolean›* @@ -216,7 +218,7 @@ ___ ▸ **canCreateSparseReadStream**(): *Promise‹boolean›* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -226,7 +228,7 @@ ___ ▸ **canCreateSparseWriteStream**(): *Promise‹boolean›* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -236,7 +238,7 @@ ___ ▸ **canCreateWriteStream**(): *Promise‹boolean›* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -246,7 +248,7 @@ ___ ▸ **canRead**(): *Promise‹boolean›* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -256,7 +258,7 @@ ___ ▸ **canWrite**(): *Promise‹boolean›* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -266,7 +268,7 @@ ___ ▸ **close**(): *Promise‹void›* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -276,7 +278,7 @@ ___ ▸ **createReadStream**(`_options`: [CreateReadStreamOptions](../interfaces/createreadstreamoptions.md)): *Promise‹ReadableStream›* -*Defined in [lib/source-destination/source-destination.ts:333](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L333)* +*Defined in [lib/source-destination/source-destination.ts:356](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L356)* **Parameters:** @@ -292,7 +294,7 @@ ___ ▸ **createSparseReadStream**(`_options`: [CreateSparseReadStreamOptions](../interfaces/createsparsereadstreamoptions.md)): *Promise‹[SparseReadable](../interfaces/sparsereadable.md)›* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -308,7 +310,7 @@ ___ ▸ **createSparseWriteStream**(`_options`: object): *Promise‹[SparseWritable](../interfaces/sparsewritable.md)›* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -326,7 +328,7 @@ ___ ▸ **createVerifier**(`checksumOrBlocks`: string | [BlocksWithChecksum](../interfaces/blockswithchecksum.md)[], `size?`: undefined | number): *[Verifier](verifier.md)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -343,7 +345,7 @@ ___ ▸ **createWriteStream**(`_options`: object): *Promise‹WritableStream›* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -365,7 +367,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -386,7 +388,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -396,7 +398,7 @@ ___ ▸ **getAlignment**(): *number | undefined* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -406,7 +408,7 @@ ___ ▸ **getBlocks**(): *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -416,7 +418,7 @@ ___ ▸ **getInnerSource**(): *Promise‹[SourceDestination](sourcedestination.md)›* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -426,7 +428,7 @@ ___ ▸ **getInnerSourceHelper**(`mimetype?`: undefined | string): *Promise‹[SourceDestination](sourcedestination.md)‹››* -*Defined in [lib/source-destination/source-destination.ts:435](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L435)* +*Defined in [lib/source-destination/source-destination.ts:458](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L458)* **Parameters:** @@ -446,7 +448,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -456,7 +458,7 @@ ___ ▸ **getMetadata**(): *Promise‹[Metadata](../interfaces/metadata.md)›* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -466,7 +468,7 @@ ___ ▸ **getMimeTypeFromContent**(): *Promise‹string | undefined›* -*Defined in [lib/source-destination/source-destination.ts:417](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L417)* +*Defined in [lib/source-destination/source-destination.ts:440](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L440)* **Returns:** *Promise‹string | undefined›* @@ -476,7 +478,7 @@ ___ ▸ **getMimeTypeFromName**(): *Promise‹string | undefined›* -*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L406)* +*Defined in [lib/source-destination/source-destination.ts:429](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L429)* **Returns:** *Promise‹string | undefined›* @@ -486,7 +488,7 @@ ___ ▸ **getPartitionTable**(): *Promise‹GetPartitionsResult | undefined›* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -500,7 +502,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -520,7 +522,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -532,6 +534,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -540,7 +570,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -568,7 +598,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -592,7 +622,7 @@ ___ ▸ **open**(): *Promise‹void›* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -606,7 +636,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -634,7 +664,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -654,11 +684,31 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -681,7 +731,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -701,7 +751,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -729,7 +779,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -745,7 +795,7 @@ ___ ▸ **write**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_fileOffset`: number): *Promise‹WriteResult›* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -766,7 +816,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -783,7 +835,7 @@ ___ ▸ **register**(`Cls`: typeof SourceSource): *void* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/sourcedestinationfs.md b/doc/classes/sourcedestinationfs.md index 10e69d7a..aa1239c7 100644 --- a/doc/classes/sourcedestinationfs.md +++ b/doc/classes/sourcedestinationfs.md @@ -29,7 +29,7 @@ \+ **new SourceDestinationFs**(`source`: [SourceDestination](sourcedestination.md)): *[SourceDestinationFs](sourcedestinationfs.md)* -*Defined in [lib/source-destination/source-destination.ts:74](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L74)* +*Defined in [lib/source-destination/source-destination.ts:97](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L97)* **Parameters:** @@ -45,7 +45,7 @@ Name | Type | • **source**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/source-destination/source-destination.ts:76](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L76)* +*Defined in [lib/source-destination/source-destination.ts:99](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L99)* ## Methods @@ -53,7 +53,7 @@ Name | Type | ▸ **close**(`_fd`: number, `callback`: function): *void* -*Defined in [lib/source-destination/source-destination.ts:86](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L86)* +*Defined in [lib/source-destination/source-destination.ts:109](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L109)* **Parameters:** @@ -77,7 +77,7 @@ ___ ▸ **fstat**(`_fd`: number, `callback`: function): *void* -*Defined in [lib/source-destination/source-destination.ts:90](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L90)* +*Defined in [lib/source-destination/source-destination.ts:113](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L113)* **Parameters:** @@ -102,7 +102,7 @@ ___ ▸ **open**(`_path`: string, `_options`: any, `callback`: function): *void* -*Defined in [lib/source-destination/source-destination.ts:78](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L78)* +*Defined in [lib/source-destination/source-destination.ts:101](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L101)* **Parameters:** @@ -129,7 +129,7 @@ ___ ▸ **read**(`_fd`: number, `buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `bufferOffset`: number, `length`: number, `sourceOffset`: number, `callback`: function): *void* -*Defined in [lib/source-destination/source-destination.ts:106](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L106)* +*Defined in [lib/source-destination/source-destination.ts:129](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L129)* **Parameters:** diff --git a/doc/classes/sourcedisk.md b/doc/classes/sourcedisk.md index e402dd48..c3fdcf70 100644 --- a/doc/classes/sourcedisk.md +++ b/doc/classes/sourcedisk.md @@ -48,7 +48,7 @@ *Overrides void* -*Defined in [lib/source-destination/configured-source/configured-source.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L47)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L47)* **Parameters:** @@ -124,7 +124,7 @@ ___ • **source**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/source-destination/configured-source/configured-source.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L48)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L48)* ## Methods @@ -134,7 +134,7 @@ ___ *Overrides void* -*Defined in [lib/source-destination/configured-source/configured-source.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L84)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L84)* **Returns:** *Promise‹void›* @@ -146,7 +146,7 @@ ___ *Overrides void* -*Defined in [lib/source-destination/configured-source/configured-source.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L57)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L57)* **Returns:** *Promise‹number›* @@ -158,7 +158,7 @@ ___ *Overrides void* -*Defined in [lib/source-destination/configured-source/configured-source.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L66)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:66](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L66)* **Parameters:** @@ -179,7 +179,7 @@ ___ *Overrides void* -*Defined in [lib/source-destination/configured-source/configured-source.ts:75](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configured-source.ts#L75)* +*Defined in [lib/source-destination/configured-source/configured-source.ts:75](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configured-source.ts#L75)* **Parameters:** diff --git a/doc/classes/sourcerandomaccessreader.md b/doc/classes/sourcerandomaccessreader.md index 4941b23f..1e6092aa 100644 --- a/doc/classes/sourcerandomaccessreader.md +++ b/doc/classes/sourcerandomaccessreader.md @@ -30,10 +30,12 @@ * [getMaxListeners](sourcerandomaccessreader.md#getmaxlisteners) * [listenerCount](sourcerandomaccessreader.md#listenercount) * [listeners](sourcerandomaccessreader.md#listeners) +* [off](sourcerandomaccessreader.md#off) * [on](sourcerandomaccessreader.md#on) * [once](sourcerandomaccessreader.md#once) * [prependListener](sourcerandomaccessreader.md#prependlistener) * [prependOnceListener](sourcerandomaccessreader.md#prependoncelistener) +* [rawListeners](sourcerandomaccessreader.md#rawlisteners) * [read](sourcerandomaccessreader.md#read) * [removeAllListeners](sourcerandomaccessreader.md#removealllisteners) * [removeListener](sourcerandomaccessreader.md#removelistener) @@ -46,7 +48,7 @@ \+ **new SourceRandomAccessReader**(`source`: [SourceDestination](sourcedestination.md)): *[SourceRandomAccessReader](sourcerandomaccessreader.md)* -*Defined in [lib/source-destination/zip.ts:132](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L132)* +*Defined in [lib/source-destination/zip.ts:132](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L132)* **Parameters:** @@ -62,7 +64,7 @@ Name | Type | • **source**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/source-destination/zip.ts:133](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L133)* +*Defined in [lib/source-destination/zip.ts:133](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L133)* ___ @@ -72,7 +74,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -82,7 +84,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides void* -*Defined in [lib/source-destination/zip.ts:137](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L137)* +*Defined in [lib/source-destination/zip.ts:137](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L137)* **Parameters:** @@ -103,7 +105,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -176,7 +178,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -197,7 +199,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -211,7 +213,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -225,7 +227,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -245,7 +247,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -257,6 +259,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -265,7 +295,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -293,7 +323,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -321,7 +351,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -349,7 +379,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -369,6 +399,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `offset`: number, `length`: number, `position`: number, `callback`: function): *void* @@ -409,7 +459,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -429,7 +479,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -457,7 +507,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -475,7 +525,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/sourcesource.md b/doc/classes/sourcesource.md index 5cee8a0e..8dd6d03c 100644 --- a/doc/classes/sourcesource.md +++ b/doc/classes/sourcesource.md @@ -62,11 +62,13 @@ * [getPartitionTable](sourcesource.md#getpartitiontable) * [listenerCount](sourcesource.md#listenercount) * [listeners](sourcesource.md#listeners) +* [off](sourcesource.md#off) * [on](sourcesource.md#on) * [once](sourcesource.md#once) * [open](sourcesource.md#open) * [prependListener](sourcesource.md#prependlistener) * [prependOnceListener](sourcesource.md#prependoncelistener) +* [rawListeners](sourcesource.md#rawlisteners) * [read](sourcesource.md#read) * [removeAllListeners](sourcesource.md#removealllisteners) * [removeListener](sourcesource.md#removelistener) @@ -81,7 +83,7 @@ \+ **new SourceSource**(`source`: [SourceDestination](sourcedestination.md)): *[SourceSource](sourcesource.md)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* **Parameters:** @@ -97,7 +99,7 @@ Name | Type | • **source**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -107,7 +109,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -128,7 +130,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -138,7 +140,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ___ @@ -146,7 +148,7 @@ ___ ▪ **requiresRandomReadableSource**: *boolean* = false -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -156,7 +158,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L30)* +*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L30)* **Returns:** *Promise‹void›* @@ -168,7 +170,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L311)* +*Defined in [lib/source-destination/source-destination.ts:334](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L334)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -180,7 +182,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L26)* +*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L26)* **Returns:** *Promise‹void›* @@ -194,7 +196,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -220,7 +222,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/source-destination.ts:288](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L288)* +*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L311)* **Returns:** *Promise‹boolean›* @@ -232,7 +234,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -244,7 +246,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -256,7 +258,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -268,7 +270,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -280,7 +282,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -292,7 +294,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -304,7 +306,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/source-destination.ts:333](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L333)* +*Defined in [lib/source-destination/source-destination.ts:356](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L356)* **Parameters:** @@ -322,7 +324,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -340,7 +342,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -360,7 +362,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -379,7 +381,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -401,7 +403,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -422,7 +424,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -434,7 +436,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -446,7 +448,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -458,7 +460,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -472,7 +474,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -484,7 +486,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -496,7 +498,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -510,7 +512,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -530,7 +532,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -542,6 +544,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -550,7 +580,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -578,7 +608,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -604,7 +634,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -618,7 +648,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -646,7 +676,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -666,13 +696,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -695,7 +745,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -715,7 +765,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -743,7 +793,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -761,7 +811,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -782,7 +832,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -801,7 +853,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/sparsefilterstream.md b/doc/classes/sparsefilterstream.md index 98f365bb..8e3b3f02 100644 --- a/doc/classes/sparsefilterstream.md +++ b/doc/classes/sparsefilterstream.md @@ -26,17 +26,21 @@ * [position](sparsefilterstream.md#private-position) * [readable](sparsefilterstream.md#readable) * [readableHighWaterMark](sparsefilterstream.md#readablehighwatermark) +* [readableLength](sparsefilterstream.md#readablelength) * [state](sparsefilterstream.md#private-optional-state) * [stateIterator](sparsefilterstream.md#private-stateiterator) * [writable](sparsefilterstream.md#writable) * [writableHighWaterMark](sparsefilterstream.md#writablehighwatermark) +* [writableLength](sparsefilterstream.md#writablelength) * [defaultMaxListeners](sparsefilterstream.md#static-defaultmaxlisteners) ### Methods +* [[Symbol.asyncIterator]](sparsefilterstream.md#[symbol.asynciterator]) * [__transform](sparsefilterstream.md#private-__transform) * [_destroy](sparsefilterstream.md#_destroy) * [_final](sparsefilterstream.md#_final) +* [_flush](sparsefilterstream.md#_flush) * [_read](sparsefilterstream.md#_read) * [_transform](sparsefilterstream.md#_transform) * [_write](sparsefilterstream.md#_write) @@ -52,6 +56,7 @@ * [listenerCount](sparsefilterstream.md#listenercount) * [listeners](sparsefilterstream.md#listeners) * [nextBlock](sparsefilterstream.md#private-nextblock) +* [off](sparsefilterstream.md#off) * [on](sparsefilterstream.md#on) * [once](sparsefilterstream.md#once) * [pause](sparsefilterstream.md#pause) @@ -59,6 +64,7 @@ * [prependListener](sparsefilterstream.md#prependlistener) * [prependOnceListener](sparsefilterstream.md#prependoncelistener) * [push](sparsefilterstream.md#push) +* [rawListeners](sparsefilterstream.md#rawlisteners) * [read](sparsefilterstream.md#read) * [removeAllListeners](sparsefilterstream.md#removealllisteners) * [removeListener](sparsefilterstream.md#removelistener) @@ -81,7 +87,7 @@ *Overrides [SourceTransform](../interfaces/sourcetransform.md).[constructor](../interfaces/sourcetransform.md#constructor)* -*Defined in [lib/sparse-stream/sparse-filter-stream.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-filter-stream.ts#L30)* +*Defined in [lib/sparse-stream/sparse-filter-stream.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-filter-stream.ts#L30)* **Parameters:** @@ -103,7 +109,7 @@ Name | Type | *Implementation of [SparseReadable](../interfaces/sparsereadable.md).[blocks](../interfaces/sparsereadable.md#blocks)* -*Defined in [lib/sparse-stream/sparse-filter-stream.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-filter-stream.ts#L27)* +*Defined in [lib/sparse-stream/sparse-filter-stream.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-filter-stream.ts#L27)* ___ @@ -111,7 +117,7 @@ ___ • **position**: *number* = 0 -*Defined in [lib/sparse-stream/sparse-filter-stream.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-filter-stream.ts#L30)* +*Defined in [lib/sparse-stream/sparse-filter-stream.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-filter-stream.ts#L30)* ___ @@ -123,7 +129,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readable](sparsefilterstream.md#readable)* -Defined in node_modules/@types/node/base.d.ts:5422 +Defined in node_modules/@types/node/stream.d.ts:20 ___ @@ -133,7 +139,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readableHighWaterMark](sparsefilterstream.md#readablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5423 +Defined in node_modules/@types/node/stream.d.ts:21 + +___ + +### readableLength + +• **readableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[readableLength](sparsefilterstream.md#readablelength)* + +Defined in node_modules/@types/node/stream.d.ts:22 ___ @@ -141,7 +157,7 @@ ___ • **state**? : *[SparseReaderState](../interfaces/sparsereaderstate.md)* -*Defined in [lib/sparse-stream/sparse-filter-stream.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-filter-stream.ts#L29)* +*Defined in [lib/sparse-stream/sparse-filter-stream.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-filter-stream.ts#L29)* ___ @@ -149,7 +165,7 @@ ___ • **stateIterator**: *Iterator‹[SparseReaderState](../interfaces/sparsereaderstate.md)›* -*Defined in [lib/sparse-stream/sparse-filter-stream.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-filter-stream.ts#L28)* +*Defined in [lib/sparse-stream/sparse-filter-stream.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-filter-stream.ts#L28)* ___ @@ -159,7 +175,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writable](sparsefilterstream.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5600 +Defined in node_modules/@types/node/stream.d.ts:209 ___ @@ -169,7 +185,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writableHighWaterMark](sparsefilterstream.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5601 +Defined in node_modules/@types/node/stream.d.ts:210 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[writableLength](sparsefilterstream.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:211 ___ @@ -179,15 +205,29 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹any›* + +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[[Symbol.asyncIterator]](sparsefilterstream.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/stream.d.ts:95 + +**Returns:** *AsyncIterableIterator‹any›* + +___ + ### `Private` __transform ▸ **__transform**(`buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer)): *void* -*Defined in [lib/sparse-stream/sparse-filter-stream.ts:69](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-filter-stream.ts#L69)* +*Defined in [lib/sparse-stream/sparse-filter-stream.ts:69](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-filter-stream.ts#L69)* **Parameters:** @@ -207,7 +247,7 @@ ___ *Overrides [SparseReadStream](sparsereadstream.md).[_destroy](sparsereadstream.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5605 +Defined in node_modules/@types/node/stream.d.ts:215 **Parameters:** @@ -215,13 +255,13 @@ Defined in node_modules/@types/node/base.d.ts:5605 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -229,17 +269,41 @@ ___ ### _final -▸ **_final**(`callback`: Function): *void* +▸ **_final**(`callback`: function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[_final](sparsefilterstream.md#_final)* -Defined in node_modules/@types/node/base.d.ts:5606 +Defined in node_modules/@types/node/stream.d.ts:216 + +**Parameters:** + +▪ **callback**: *function* + +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`error?` | [Error](notcapable.md#static-error) | null | + +**Returns:** *void* + +___ + +### _flush + +▸ **_flush**(`callback`: TransformCallback): *void* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[_flush](sparsefilterstream.md#_flush)* + +Defined in node_modules/@types/node/stream.d.ts:242 **Parameters:** Name | Type | ------ | ------ | -`callback` | Function | +`callback` | TransformCallback | **Returns:** *void* @@ -251,7 +315,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_read](sparsefilterstream.md#_read)* -Defined in node_modules/@types/node/base.d.ts:5425 +Defined in node_modules/@types/node/stream.d.ts:24 **Parameters:** @@ -269,7 +333,7 @@ ___ *Overrides [SourceTransform](../interfaces/sourcetransform.md).[_transform](../interfaces/sourcetransform.md#_transform)* -*Defined in [lib/sparse-stream/sparse-filter-stream.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-filter-stream.ts#L55)* +*Defined in [lib/sparse-stream/sparse-filter-stream.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-filter-stream.ts#L55)* **Parameters:** @@ -279,13 +343,13 @@ ___ ▪ **callback**: *function* -▸ (`error`: [Error](notcapable.md#static-error) | null): *void* +▸ (`error?`: [Error](notcapable.md#static-error)): *void* **Parameters:** Name | Type | ------ | ------ | -`error` | [Error](notcapable.md#static-error) | null | +`error?` | [Error](notcapable.md#static-error) | **Returns:** *void* @@ -297,7 +361,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_write](sparsefilterstream.md#_write)* -Defined in node_modules/@types/node/base.d.ts:5603 +Defined in node_modules/@types/node/stream.d.ts:213 **Parameters:** @@ -307,13 +371,13 @@ Defined in node_modules/@types/node/base.d.ts:5603 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -325,7 +389,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_writev](sparsefilterstream.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5604 +Defined in node_modules/@types/node/stream.d.ts:214 **Parameters:** @@ -333,13 +397,13 @@ Defined in node_modules/@types/node/base.d.ts:5604 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -347,13 +411,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5447 +Defined in node_modules/@types/node/stream.d.ts:46 Event emitter The defined events on documents including: @@ -365,30 +429,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5448 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -403,7 +443,7 @@ Defined in node_modules/@types/node/base.d.ts:5448 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5449 +Defined in node_modules/@types/node/stream.d.ts:47 **Parameters:** @@ -411,13 +451,13 @@ Defined in node_modules/@types/node/base.d.ts:5449 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -427,7 +467,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5450 +Defined in node_modules/@types/node/stream.d.ts:48 **Parameters:** @@ -445,7 +485,7 @@ Defined in node_modules/@types/node/base.d.ts:5450 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5451 +Defined in node_modules/@types/node/stream.d.ts:49 **Parameters:** @@ -463,7 +503,7 @@ Defined in node_modules/@types/node/base.d.ts:5451 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5452 +Defined in node_modules/@types/node/stream.d.ts:50 **Parameters:** @@ -481,6 +521,30 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* + +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:51 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### cork @@ -489,7 +553,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[cork](sparsefilterstream.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5613 +Defined in node_modules/@types/node/stream.d.ts:223 **Returns:** *void* @@ -501,9 +565,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[destroy](sparsefilterstream.md#destroy)* -*Overrides [SparseReadStream](sparsereadstream.md).[destroy](sparsereadstream.md#destroy)* - -Defined in node_modules/@types/node/base.d.ts:5625 +Defined in node_modules/@types/node/stream.d.ts:35 **Parameters:** @@ -517,104 +579,104 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* - -*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* +▸ **emit**(`event`: "close"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5454 +Defined in node_modules/@types/node/stream.d.ts:53 **Parameters:** Name | Type | ------ | ------ | -`event` | string | symbol | -`...args` | any[] | +`event` | "close" | **Returns:** *boolean* -▸ **emit**(`event`: "close"): *boolean* +▸ **emit**(`event`: "data", `chunk`: any): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5455 +Defined in node_modules/@types/node/stream.d.ts:54 **Parameters:** Name | Type | ------ | ------ | -`event` | "close" | +`event` | "data" | +`chunk` | any | **Returns:** *boolean* -▸ **emit**(`event`: "data", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "end"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5456 +Defined in node_modules/@types/node/stream.d.ts:55 **Parameters:** Name | Type | ------ | ------ | -`event` | "data" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`event` | "end" | **Returns:** *boolean* -▸ **emit**(`event`: "end"): *boolean* +▸ **emit**(`event`: "readable"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5457 +Defined in node_modules/@types/node/stream.d.ts:56 **Parameters:** Name | Type | ------ | ------ | -`event` | "end" | +`event` | "readable" | **Returns:** *boolean* -▸ **emit**(`event`: "readable"): *boolean* +▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5458 +Defined in node_modules/@types/node/stream.d.ts:57 **Parameters:** Name | Type | ------ | ------ | -`event` | "readable" | +`event` | "error" | +`err` | [Error](notcapable.md#static-error) | **Returns:** *boolean* -▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* + +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5459 +Defined in node_modules/@types/node/stream.d.ts:58 **Parameters:** Name | Type | ------ | ------ | -`event` | "error" | -`err` | [Error](notcapable.md#static-error) | +`event` | string | symbol | +`...args` | any[] | **Returns:** *boolean* @@ -622,40 +684,40 @@ ___ ### end -▸ **end**(`cb?`: Function): *void* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5610 +Defined in node_modules/@types/node/stream.d.ts:220 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5611 +Defined in node_modules/@types/node/stream.d.ts:221 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5612 +Defined in node_modules/@types/node/stream.d.ts:222 **Parameters:** @@ -663,7 +725,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -677,7 +739,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -691,7 +753,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -705,7 +767,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[isPaused](sparsefilterstream.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:5430 +Defined in node_modules/@types/node/stream.d.ts:29 **Returns:** *boolean* @@ -719,7 +781,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -739,7 +801,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -755,25 +817,23 @@ ___ ▸ **nextBlock**(): *void* -*Defined in [lib/sparse-stream/sparse-filter-stream.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-filter-stream.ts#L51)* +*Defined in [lib/sparse-stream/sparse-filter-stream.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-filter-stream.ts#L51)* **Returns:** *void* ___ -### on - -▸ **on**(`event`: string, `listener`: function): *this* +### off -*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -Defined in node_modules/@types/node/base.d.ts:5461 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -787,13 +847,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5462 +Defined in node_modules/@types/node/stream.d.ts:60 **Parameters:** @@ -811,7 +875,7 @@ Defined in node_modules/@types/node/base.d.ts:5462 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5463 +Defined in node_modules/@types/node/stream.d.ts:61 **Parameters:** @@ -819,13 +883,13 @@ Defined in node_modules/@types/node/base.d.ts:5463 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -835,7 +899,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5464 +Defined in node_modules/@types/node/stream.d.ts:62 **Parameters:** @@ -853,7 +917,7 @@ Defined in node_modules/@types/node/base.d.ts:5464 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5465 +Defined in node_modules/@types/node/stream.d.ts:63 **Parameters:** @@ -871,7 +935,7 @@ Defined in node_modules/@types/node/base.d.ts:5465 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5466 +Defined in node_modules/@types/node/stream.d.ts:64 **Parameters:** @@ -889,21 +953,17 @@ Name | Type | **Returns:** *this* -___ - -### once - -▸ **once**(`event`: string, `listener`: function): *this* +▸ **on**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5468 +Defined in node_modules/@types/node/stream.d.ts:65 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -917,13 +977,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5469 +Defined in node_modules/@types/node/stream.d.ts:67 **Parameters:** @@ -941,7 +1005,7 @@ Defined in node_modules/@types/node/base.d.ts:5469 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5470 +Defined in node_modules/@types/node/stream.d.ts:68 **Parameters:** @@ -949,13 +1013,13 @@ Defined in node_modules/@types/node/base.d.ts:5470 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -965,7 +1029,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5471 +Defined in node_modules/@types/node/stream.d.ts:69 **Parameters:** @@ -983,7 +1047,7 @@ Defined in node_modules/@types/node/base.d.ts:5471 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5472 +Defined in node_modules/@types/node/stream.d.ts:70 **Parameters:** @@ -1001,7 +1065,7 @@ Defined in node_modules/@types/node/base.d.ts:5472 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5473 +Defined in node_modules/@types/node/stream.d.ts:71 **Parameters:** @@ -1019,6 +1083,30 @@ Name | Type | **Returns:** *this* +▸ **once**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* + +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* + +Defined in node_modules/@types/node/stream.d.ts:72 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### pause @@ -1029,7 +1117,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[pause](sparsefilterstream.md#pause)* -Defined in node_modules/@types/node/base.d.ts:5428 +Defined in node_modules/@types/node/stream.d.ts:27 **Returns:** *this* @@ -1041,7 +1129,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:5407 +Defined in node_modules/@types/node/stream.d.ts:5 **Type parameters:** @@ -1060,37 +1148,13 @@ ___ ### prependListener -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* - -Defined in node_modules/@types/node/base.d.ts:5475 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **prependListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5476 +Defined in node_modules/@types/node/stream.d.ts:74 **Parameters:** @@ -1108,7 +1172,7 @@ Defined in node_modules/@types/node/base.d.ts:5476 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5477 +Defined in node_modules/@types/node/stream.d.ts:75 **Parameters:** @@ -1116,13 +1180,13 @@ Defined in node_modules/@types/node/base.d.ts:5477 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1132,7 +1196,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5478 +Defined in node_modules/@types/node/stream.d.ts:76 **Parameters:** @@ -1150,7 +1214,7 @@ Defined in node_modules/@types/node/base.d.ts:5478 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5479 +Defined in node_modules/@types/node/stream.d.ts:77 **Parameters:** @@ -1168,7 +1232,7 @@ Defined in node_modules/@types/node/base.d.ts:5479 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5480 +Defined in node_modules/@types/node/stream.d.ts:78 **Parameters:** @@ -1186,21 +1250,17 @@ Name | Type | **Returns:** *this* -___ - -### prependOnceListener +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5482 +Defined in node_modules/@types/node/stream.d.ts:79 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1214,13 +1274,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5483 +Defined in node_modules/@types/node/stream.d.ts:81 **Parameters:** @@ -1238,7 +1302,7 @@ Defined in node_modules/@types/node/base.d.ts:5483 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5484 +Defined in node_modules/@types/node/stream.d.ts:82 **Parameters:** @@ -1246,13 +1310,13 @@ Defined in node_modules/@types/node/base.d.ts:5484 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1262,7 +1326,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5485 +Defined in node_modules/@types/node/stream.d.ts:83 **Parameters:** @@ -1280,7 +1344,7 @@ Defined in node_modules/@types/node/base.d.ts:5485 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5486 +Defined in node_modules/@types/node/stream.d.ts:84 **Parameters:** @@ -1298,7 +1362,7 @@ Defined in node_modules/@types/node/base.d.ts:5486 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5487 +Defined in node_modules/@types/node/stream.d.ts:85 **Parameters:** @@ -1316,6 +1380,30 @@ Name | Type | **Returns:** *this* +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* + +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* + +Defined in node_modules/@types/node/stream.d.ts:86 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### push @@ -1324,7 +1412,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[push](sparsefilterstream.md#push)* -Defined in node_modules/@types/node/base.d.ts:5434 +Defined in node_modules/@types/node/stream.d.ts:33 **Parameters:** @@ -1337,79 +1425,75 @@ Name | Type | ___ -### read +### rawListeners -▸ **read**(`size?`: undefined | number): *any* +▸ **rawListeners**(`event`: string | symbol): *Function[]* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* -Defined in node_modules/@types/node/base.d.ts:5426 +Defined in node_modules/@types/node/events.d.ts:31 **Parameters:** Name | Type | ------ | ------ | -`size?` | undefined | number | +`event` | string | symbol | -**Returns:** *any* +**Returns:** *Function[]* ___ -### removeAllListeners +### read -▸ **removeAllListeners**(`event?`: string | symbol): *this* +▸ **read**(`size?`: undefined | number): *any* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/stream.d.ts:25 **Parameters:** Name | Type | ------ | ------ | -`event?` | string | symbol | +`size?` | undefined | number | -**Returns:** *this* +**Returns:** *any* ___ -### removeListener - -▸ **removeListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* - -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5489 +### removeAllListeners -**Parameters:** +▸ **removeAllListeners**(`event?`: string | symbol): *this* -▪ **event**: *string* +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -▪ **listener**: *function* +*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* -▸ (...`args`: any[]): *void* +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`event?` | string | symbol | **Returns:** *this* +___ + +### removeListener + ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5490 +Defined in node_modules/@types/node/stream.d.ts:88 **Parameters:** @@ -1427,7 +1511,7 @@ Defined in node_modules/@types/node/base.d.ts:5490 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5491 +Defined in node_modules/@types/node/stream.d.ts:89 **Parameters:** @@ -1435,13 +1519,13 @@ Defined in node_modules/@types/node/base.d.ts:5491 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1451,7 +1535,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5492 +Defined in node_modules/@types/node/stream.d.ts:90 **Parameters:** @@ -1469,7 +1553,7 @@ Defined in node_modules/@types/node/base.d.ts:5492 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5493 +Defined in node_modules/@types/node/stream.d.ts:91 **Parameters:** @@ -1487,7 +1571,7 @@ Defined in node_modules/@types/node/base.d.ts:5493 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5494 +Defined in node_modules/@types/node/stream.d.ts:92 **Parameters:** @@ -1505,6 +1589,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:93 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### resume @@ -1515,7 +1623,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[resume](sparsefilterstream.md#resume)* -Defined in node_modules/@types/node/base.d.ts:5429 +Defined in node_modules/@types/node/stream.d.ts:28 **Returns:** *this* @@ -1527,7 +1635,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setDefaultEncoding](sparsefilterstream.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5609 +Defined in node_modules/@types/node/stream.d.ts:219 **Parameters:** @@ -1547,7 +1655,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setEncoding](sparsefilterstream.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:5427 +Defined in node_modules/@types/node/stream.d.ts:26 **Parameters:** @@ -1567,7 +1675,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1585,7 +1693,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[uncork](sparsefilterstream.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5614 +Defined in node_modules/@types/node/stream.d.ts:224 **Returns:** *void* @@ -1593,23 +1701,19 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: NodeJS.WritableStream): *this* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* *Inherited from [SparseFilterStream](sparsefilterstream.md).[unpipe](sparsefilterstream.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:5431 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/stream.d.ts:30 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | NodeJS.WritableStream | **Returns:** *this* @@ -1621,7 +1725,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[unshift](sparsefilterstream.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:5432 +Defined in node_modules/@types/node/stream.d.ts:31 **Parameters:** @@ -1641,7 +1745,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[wrap](sparsefilterstream.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:5433 +Defined in node_modules/@types/node/stream.d.ts:32 **Parameters:** @@ -1655,26 +1759,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5607 +Defined in node_modules/@types/node/stream.d.ts:217 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5608 +Defined in node_modules/@types/node/stream.d.ts:218 **Parameters:** @@ -1682,7 +1786,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1694,7 +1798,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/sparsereadstream.md b/doc/classes/sparsereadstream.md index bb8ab46b..12660720 100644 --- a/doc/classes/sparsereadstream.md +++ b/doc/classes/sparsereadstream.md @@ -27,6 +27,7 @@ * [positionInBlock](sparsereadstream.md#private-positioninblock) * [readable](sparsereadstream.md#readable) * [readableHighWaterMark](sparsereadstream.md#readablehighwatermark) +* [readableLength](sparsereadstream.md#readablelength) * [source](sparsereadstream.md#private-source) * [state](sparsereadstream.md#private-optional-state) * [stateIterator](sparsereadstream.md#private-stateiterator) @@ -34,6 +35,7 @@ ### Methods +* [[Symbol.asyncIterator]](sparsereadstream.md#[symbol.asynciterator]) * [__read](sparsereadstream.md#private-__read) * [_destroy](sparsereadstream.md#_destroy) * [_read](sparsereadstream.md#_read) @@ -46,6 +48,7 @@ * [listenerCount](sparsereadstream.md#listenercount) * [listeners](sparsereadstream.md#listeners) * [nextBlock](sparsereadstream.md#private-nextblock) +* [off](sparsereadstream.md#off) * [on](sparsereadstream.md#on) * [once](sparsereadstream.md#once) * [pause](sparsereadstream.md#pause) @@ -53,6 +56,7 @@ * [prependListener](sparsereadstream.md#prependlistener) * [prependOnceListener](sparsereadstream.md#prependoncelistener) * [push](sparsereadstream.md#push) +* [rawListeners](sparsereadstream.md#rawlisteners) * [read](sparsereadstream.md#read) * [removeAllListeners](sparsereadstream.md#removealllisteners) * [removeListener](sparsereadstream.md#removelistener) @@ -72,7 +76,7 @@ *Overrides void* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L40)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L39)* **Parameters:** @@ -96,7 +100,7 @@ Name | Type | Default | • **alignedReadableState**? : *[AlignedReadableState](alignedreadablestate.md)* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L40)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L39)* ___ @@ -106,7 +110,7 @@ ___ *Implementation of [SparseReadable](../interfaces/sparsereadable.md).[blocks](../interfaces/sparsereadable.md#blocks)* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L35)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L34)* ___ @@ -114,7 +118,7 @@ ___ • **chunkSize**: *number* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L36)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L35)* ___ @@ -122,7 +126,7 @@ ___ • **positionInBlock**: *number* = 0 -*Defined in [lib/sparse-stream/sparse-read-stream.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L39)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L38)* ___ @@ -134,7 +138,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readable](sparsefilterstream.md#readable)* -Defined in node_modules/@types/node/base.d.ts:5422 +Defined in node_modules/@types/node/stream.d.ts:20 ___ @@ -144,7 +148,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readableHighWaterMark](sparsefilterstream.md#readablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5423 +Defined in node_modules/@types/node/stream.d.ts:21 + +___ + +### readableLength + +• **readableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[readableLength](sparsefilterstream.md#readablelength)* + +Defined in node_modules/@types/node/stream.d.ts:22 ___ @@ -152,7 +166,7 @@ ___ • **source**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L34)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L33)* ___ @@ -160,7 +174,7 @@ ___ • **state**? : *[SparseReaderState](../interfaces/sparsereaderstate.md)* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L38)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L37)* ___ @@ -168,7 +182,7 @@ ___ • **stateIterator**: *Iterator‹[SparseReaderState](../interfaces/sparsereaderstate.md)›* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L37)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L36)* ___ @@ -178,15 +192,29 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹any›* + +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[[Symbol.asyncIterator]](sparsefilterstream.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/stream.d.ts:95 + +**Returns:** *AsyncIterableIterator‹any›* + +___ + ### `Private` __read ▸ **__read**(): *Promise‹[SparseStreamChunk](../interfaces/sparsestreamchunk.md) | null›* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L92)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:91](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L91)* **Returns:** *Promise‹[SparseStreamChunk](../interfaces/sparsestreamchunk.md) | null›* @@ -198,7 +226,7 @@ ___ *Inherited from [SparseReadStream](sparsereadstream.md).[_destroy](sparsereadstream.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5435 +Defined in node_modules/@types/node/stream.d.ts:34 **Parameters:** @@ -206,13 +234,13 @@ Defined in node_modules/@types/node/base.d.ts:5435 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -224,7 +252,7 @@ ___ *Overrides [SparseFilterStream](sparsefilterstream.md).[_read](sparsefilterstream.md#_read)* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:78](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L78)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:77](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L77)* **Returns:** *Promise‹void›* @@ -232,13 +260,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5447 +Defined in node_modules/@types/node/stream.d.ts:46 Event emitter The defined events on documents including: @@ -250,30 +278,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5448 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -288,7 +292,7 @@ Defined in node_modules/@types/node/base.d.ts:5448 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5449 +Defined in node_modules/@types/node/stream.d.ts:47 **Parameters:** @@ -296,13 +300,13 @@ Defined in node_modules/@types/node/base.d.ts:5449 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -312,7 +316,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5450 +Defined in node_modules/@types/node/stream.d.ts:48 **Parameters:** @@ -330,7 +334,7 @@ Defined in node_modules/@types/node/base.d.ts:5450 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5451 +Defined in node_modules/@types/node/stream.d.ts:49 **Parameters:** @@ -348,7 +352,7 @@ Defined in node_modules/@types/node/base.d.ts:5451 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5452 +Defined in node_modules/@types/node/stream.d.ts:50 **Parameters:** @@ -366,46 +370,51 @@ Name | Type | **Returns:** *this* -___ +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* -### destroy +*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* -▸ **destroy**(`error?`: [Error](notcapable.md#static-error)): *void* +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:51 + +**Parameters:** -*Inherited from [SparseReadStream](sparsereadstream.md).[destroy](sparsereadstream.md#destroy)* +▪ **event**: *string | symbol* -Defined in node_modules/@types/node/base.d.ts:5436 +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`...args` | any[] | -**Returns:** *void* +**Returns:** *this* ___ -### emit - -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* - -*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* +### destroy -*Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* +▸ **destroy**(`error?`: [Error](notcapable.md#static-error)): *void* -*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[destroy](sparsefilterstream.md#destroy)* -Defined in node_modules/@types/node/base.d.ts:5454 +Defined in node_modules/@types/node/stream.d.ts:35 **Parameters:** Name | Type | ------ | ------ | -`event` | string | symbol | -`...args` | any[] | +`error?` | [Error](notcapable.md#static-error) | -**Returns:** *boolean* +**Returns:** *void* + +___ + +### emit ▸ **emit**(`event`: "close"): *boolean* @@ -413,7 +422,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5455 +Defined in node_modules/@types/node/stream.d.ts:53 **Parameters:** @@ -423,20 +432,20 @@ Name | Type | **Returns:** *boolean* -▸ **emit**(`event`: "data", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "data", `chunk`: any): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5456 +Defined in node_modules/@types/node/stream.d.ts:54 **Parameters:** Name | Type | ------ | ------ | `event` | "data" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *boolean* @@ -446,7 +455,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5457 +Defined in node_modules/@types/node/stream.d.ts:55 **Parameters:** @@ -462,7 +471,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5458 +Defined in node_modules/@types/node/stream.d.ts:56 **Parameters:** @@ -478,7 +487,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5459 +Defined in node_modules/@types/node/stream.d.ts:57 **Parameters:** @@ -489,6 +498,25 @@ Name | Type | **Returns:** *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* + +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* + +*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* + +Defined in node_modules/@types/node/stream.d.ts:58 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | +`...args` | any[] | + +**Returns:** *boolean* + ___ ### eventNames @@ -499,7 +527,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -513,7 +541,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -527,7 +555,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[isPaused](sparsefilterstream.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:5430 +Defined in node_modules/@types/node/stream.d.ts:29 **Returns:** *boolean* @@ -541,7 +569,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -561,7 +589,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -577,25 +605,23 @@ ___ ▸ **nextBlock**(): *void* -*Defined in [lib/sparse-stream/sparse-read-stream.ts:87](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-read-stream.ts#L87)* +*Defined in [lib/sparse-stream/sparse-read-stream.ts:86](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-read-stream.ts#L86)* **Returns:** *void* ___ -### on - -▸ **on**(`event`: string, `listener`: function): *this* +### off -*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -Defined in node_modules/@types/node/base.d.ts:5461 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -609,13 +635,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5462 +Defined in node_modules/@types/node/stream.d.ts:60 **Parameters:** @@ -633,7 +663,7 @@ Defined in node_modules/@types/node/base.d.ts:5462 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5463 +Defined in node_modules/@types/node/stream.d.ts:61 **Parameters:** @@ -641,13 +671,13 @@ Defined in node_modules/@types/node/base.d.ts:5463 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -657,7 +687,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5464 +Defined in node_modules/@types/node/stream.d.ts:62 **Parameters:** @@ -675,7 +705,7 @@ Defined in node_modules/@types/node/base.d.ts:5464 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5465 +Defined in node_modules/@types/node/stream.d.ts:63 **Parameters:** @@ -693,7 +723,7 @@ Defined in node_modules/@types/node/base.d.ts:5465 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5466 +Defined in node_modules/@types/node/stream.d.ts:64 **Parameters:** @@ -711,21 +741,17 @@ Name | Type | **Returns:** *this* -___ - -### once - -▸ **once**(`event`: string, `listener`: function): *this* +▸ **on**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5468 +Defined in node_modules/@types/node/stream.d.ts:65 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -739,13 +765,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5469 +Defined in node_modules/@types/node/stream.d.ts:67 **Parameters:** @@ -763,7 +793,7 @@ Defined in node_modules/@types/node/base.d.ts:5469 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5470 +Defined in node_modules/@types/node/stream.d.ts:68 **Parameters:** @@ -771,13 +801,13 @@ Defined in node_modules/@types/node/base.d.ts:5470 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -787,7 +817,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5471 +Defined in node_modules/@types/node/stream.d.ts:69 **Parameters:** @@ -805,7 +835,7 @@ Defined in node_modules/@types/node/base.d.ts:5471 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5472 +Defined in node_modules/@types/node/stream.d.ts:70 **Parameters:** @@ -823,7 +853,7 @@ Defined in node_modules/@types/node/base.d.ts:5472 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5473 +Defined in node_modules/@types/node/stream.d.ts:71 **Parameters:** @@ -841,6 +871,30 @@ Name | Type | **Returns:** *this* +▸ **once**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* + +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* + +Defined in node_modules/@types/node/stream.d.ts:72 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### pause @@ -851,7 +905,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[pause](sparsefilterstream.md#pause)* -Defined in node_modules/@types/node/base.d.ts:5428 +Defined in node_modules/@types/node/stream.d.ts:27 **Returns:** *this* @@ -863,7 +917,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:5407 +Defined in node_modules/@types/node/stream.d.ts:5 **Type parameters:** @@ -882,37 +936,13 @@ ___ ### prependListener -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* - -Defined in node_modules/@types/node/base.d.ts:5475 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **prependListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5476 +Defined in node_modules/@types/node/stream.d.ts:74 **Parameters:** @@ -930,7 +960,7 @@ Defined in node_modules/@types/node/base.d.ts:5476 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5477 +Defined in node_modules/@types/node/stream.d.ts:75 **Parameters:** @@ -938,13 +968,13 @@ Defined in node_modules/@types/node/base.d.ts:5477 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -954,7 +984,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5478 +Defined in node_modules/@types/node/stream.d.ts:76 **Parameters:** @@ -972,7 +1002,7 @@ Defined in node_modules/@types/node/base.d.ts:5478 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5479 +Defined in node_modules/@types/node/stream.d.ts:77 **Parameters:** @@ -990,7 +1020,7 @@ Defined in node_modules/@types/node/base.d.ts:5479 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5480 +Defined in node_modules/@types/node/stream.d.ts:78 **Parameters:** @@ -1008,21 +1038,17 @@ Name | Type | **Returns:** *this* -___ - -### prependOnceListener - -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5482 +Defined in node_modules/@types/node/stream.d.ts:79 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1036,13 +1062,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5483 +Defined in node_modules/@types/node/stream.d.ts:81 **Parameters:** @@ -1060,7 +1090,7 @@ Defined in node_modules/@types/node/base.d.ts:5483 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5484 +Defined in node_modules/@types/node/stream.d.ts:82 **Parameters:** @@ -1068,13 +1098,13 @@ Defined in node_modules/@types/node/base.d.ts:5484 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1084,7 +1114,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5485 +Defined in node_modules/@types/node/stream.d.ts:83 **Parameters:** @@ -1102,7 +1132,7 @@ Defined in node_modules/@types/node/base.d.ts:5485 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5486 +Defined in node_modules/@types/node/stream.d.ts:84 **Parameters:** @@ -1120,7 +1150,7 @@ Defined in node_modules/@types/node/base.d.ts:5486 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5487 +Defined in node_modules/@types/node/stream.d.ts:85 **Parameters:** @@ -1138,6 +1168,30 @@ Name | Type | **Returns:** *this* +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* + +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* + +Defined in node_modules/@types/node/stream.d.ts:86 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### push @@ -1146,7 +1200,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[push](sparsefilterstream.md#push)* -Defined in node_modules/@types/node/base.d.ts:5434 +Defined in node_modules/@types/node/stream.d.ts:33 **Parameters:** @@ -1159,79 +1213,75 @@ Name | Type | ___ -### read +### rawListeners -▸ **read**(`size?`: undefined | number): *any* +▸ **rawListeners**(`event`: string | symbol): *Function[]* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* -Defined in node_modules/@types/node/base.d.ts:5426 +Defined in node_modules/@types/node/events.d.ts:31 **Parameters:** Name | Type | ------ | ------ | -`size?` | undefined | number | +`event` | string | symbol | -**Returns:** *any* +**Returns:** *Function[]* ___ -### removeAllListeners +### read -▸ **removeAllListeners**(`event?`: string | symbol): *this* +▸ **read**(`size?`: undefined | number): *any* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/stream.d.ts:25 **Parameters:** Name | Type | ------ | ------ | -`event?` | string | symbol | +`size?` | undefined | number | -**Returns:** *this* +**Returns:** *any* ___ -### removeListener - -▸ **removeListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* - -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5489 +### removeAllListeners -**Parameters:** +▸ **removeAllListeners**(`event?`: string | symbol): *this* -▪ **event**: *string* +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -▪ **listener**: *function* +*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* -▸ (...`args`: any[]): *void* +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`event?` | string | symbol | **Returns:** *this* +___ + +### removeListener + ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5490 +Defined in node_modules/@types/node/stream.d.ts:88 **Parameters:** @@ -1249,7 +1299,7 @@ Defined in node_modules/@types/node/base.d.ts:5490 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5491 +Defined in node_modules/@types/node/stream.d.ts:89 **Parameters:** @@ -1257,13 +1307,13 @@ Defined in node_modules/@types/node/base.d.ts:5491 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1273,7 +1323,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5492 +Defined in node_modules/@types/node/stream.d.ts:90 **Parameters:** @@ -1291,7 +1341,7 @@ Defined in node_modules/@types/node/base.d.ts:5492 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5493 +Defined in node_modules/@types/node/stream.d.ts:91 **Parameters:** @@ -1309,7 +1359,7 @@ Defined in node_modules/@types/node/base.d.ts:5493 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5494 +Defined in node_modules/@types/node/stream.d.ts:92 **Parameters:** @@ -1327,6 +1377,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:93 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### resume @@ -1337,7 +1411,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[resume](sparsefilterstream.md#resume)* -Defined in node_modules/@types/node/base.d.ts:5429 +Defined in node_modules/@types/node/stream.d.ts:28 **Returns:** *this* @@ -1351,7 +1425,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setEncoding](sparsefilterstream.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:5427 +Defined in node_modules/@types/node/stream.d.ts:26 **Parameters:** @@ -1371,7 +1445,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1385,23 +1459,19 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: NodeJS.WritableStream): *this* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* *Inherited from [SparseFilterStream](sparsefilterstream.md).[unpipe](sparsefilterstream.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:5431 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/stream.d.ts:30 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | NodeJS.WritableStream | **Returns:** *this* @@ -1413,7 +1483,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[unshift](sparsefilterstream.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:5432 +Defined in node_modules/@types/node/stream.d.ts:31 **Parameters:** @@ -1433,7 +1503,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[wrap](sparsefilterstream.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:5433 +Defined in node_modules/@types/node/stream.d.ts:32 **Parameters:** @@ -1451,7 +1521,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/sparsestreamverifier.md b/doc/classes/sparsestreamverifier.md index 7291375b..e98d9e24 100644 --- a/doc/classes/sparsestreamverifier.md +++ b/doc/classes/sparsestreamverifier.md @@ -29,10 +29,12 @@ * [handleEventsAndPipe](sparsestreamverifier.md#protected-handleeventsandpipe) * [listenerCount](sparsestreamverifier.md#listenercount) * [listeners](sparsestreamverifier.md#listeners) +* [off](sparsestreamverifier.md#off) * [on](sparsestreamverifier.md#on) * [once](sparsestreamverifier.md#once) * [prependListener](sparsestreamverifier.md#prependlistener) * [prependOnceListener](sparsestreamverifier.md#prependoncelistener) +* [rawListeners](sparsestreamverifier.md#rawlisteners) * [removeAllListeners](sparsestreamverifier.md#removealllisteners) * [removeListener](sparsestreamverifier.md#removelistener) * [run](sparsestreamverifier.md#run) @@ -49,7 +51,7 @@ \+ **new SparseStreamVerifier**(`source`: [SourceDestination](sourcedestination.md), `blocks`: [BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]): *[SparseStreamVerifier](sparsestreamverifier.md)* -*Defined in [lib/source-destination/source-destination.ts:185](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L185)* +*Defined in [lib/source-destination/source-destination.ts:208](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L208)* **Parameters:** @@ -66,7 +68,7 @@ Name | Type | • **blocks**: *[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]* -*Defined in [lib/source-destination/source-destination.ts:188](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L188)* +*Defined in [lib/source-destination/source-destination.ts:211](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L211)* ___ @@ -74,7 +76,7 @@ ___ • **source**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/source-destination/source-destination.ts:187](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L187)* +*Defined in [lib/source-destination/source-destination.ts:210](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L210)* ___ @@ -84,7 +86,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -96,7 +98,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -124,7 +126,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -145,7 +147,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -159,7 +161,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -171,7 +173,7 @@ ___ *Inherited from [Verifier](verifier.md).[handleEventsAndPipe](verifier.md#protected-handleeventsandpipe)* -*Defined in [lib/source-destination/source-destination.ts:134](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L134)* +*Defined in [lib/source-destination/source-destination.ts:157](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L157)* **Parameters:** @@ -192,7 +194,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -212,7 +214,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -224,6 +226,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -232,7 +262,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -260,7 +290,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -288,7 +318,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -316,7 +346,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -336,6 +366,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -344,7 +394,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -364,7 +414,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -390,7 +440,7 @@ ___ *Overrides [Verifier](verifier.md).[run](verifier.md#abstract-run)* -*Defined in [lib/source-destination/source-destination.ts:193](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L193)* +*Defined in [lib/source-destination/source-destination.ts:216](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L216)* **Returns:** *Promise‹void›* @@ -404,7 +454,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -422,7 +472,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -441,22 +493,22 @@ Name | Type | *Inherited from [Verifier](verifier.md).[progress](verifier.md#progress)* -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### bytes • **bytes**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### position • **position**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### speed • **speed**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* diff --git a/doc/classes/sparsetransformstream.md b/doc/classes/sparsetransformstream.md index e0276273..ea9e316d 100644 --- a/doc/classes/sparsetransformstream.md +++ b/doc/classes/sparsetransformstream.md @@ -29,14 +29,19 @@ * [position](sparsetransformstream.md#position) * [readable](sparsetransformstream.md#readable) * [readableHighWaterMark](sparsetransformstream.md#readablehighwatermark) +* [readableLength](sparsetransformstream.md#readablelength) * [writable](sparsetransformstream.md#writable) * [writableHighWaterMark](sparsetransformstream.md#writablehighwatermark) +* [writableLength](sparsetransformstream.md#writablelength) * [defaultMaxListeners](sparsetransformstream.md#static-defaultmaxlisteners) ### Methods +* [[Symbol.asyncIterator]](sparsetransformstream.md#[symbol.asynciterator]) +* [__transform](sparsetransformstream.md#private-__transform) * [_destroy](sparsetransformstream.md#_destroy) * [_final](sparsetransformstream.md#_final) +* [_flush](sparsetransformstream.md#_flush) * [_read](sparsetransformstream.md#_read) * [_transform](sparsetransformstream.md#_transform) * [_write](sparsetransformstream.md#_write) @@ -51,6 +56,7 @@ * [isPaused](sparsetransformstream.md#ispaused) * [listenerCount](sparsetransformstream.md#listenercount) * [listeners](sparsetransformstream.md#listeners) +* [off](sparsetransformstream.md#off) * [on](sparsetransformstream.md#on) * [once](sparsetransformstream.md#once) * [pause](sparsetransformstream.md#pause) @@ -58,6 +64,7 @@ * [prependListener](sparsetransformstream.md#prependlistener) * [prependOnceListener](sparsetransformstream.md#prependoncelistener) * [push](sparsetransformstream.md#push) +* [rawListeners](sparsetransformstream.md#rawlisteners) * [read](sparsetransformstream.md#read) * [removeAllListeners](sparsetransformstream.md#removealllisteners) * [removeListener](sparsetransformstream.md#removelistener) @@ -80,7 +87,7 @@ *Overrides [SourceTransform](../interfaces/sourcetransform.md).[constructor](../interfaces/sourcetransform.md#constructor)* -*Defined in [lib/sparse-stream/sparse-transform-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-transform-stream.ts#L35)* +*Defined in [lib/sparse-stream/sparse-transform-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-transform-stream.ts#L36)* **Parameters:** @@ -101,7 +108,7 @@ Name | Type | Default | • **alignedReadableState**: *[AlignedReadableState](alignedreadablestate.md)* -*Defined in [lib/sparse-stream/sparse-transform-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-transform-stream.ts#L35)* +*Defined in [lib/sparse-stream/sparse-transform-stream.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-transform-stream.ts#L36)* ___ @@ -111,7 +118,7 @@ ___ *Implementation of [SparseReadable](../interfaces/sparsereadable.md).[blocks](../interfaces/sparsereadable.md#blocks)* -*Defined in [lib/sparse-stream/sparse-transform-stream.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-transform-stream.ts#L32)* +*Defined in [lib/sparse-stream/sparse-transform-stream.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-transform-stream.ts#L33)* ___ @@ -119,7 +126,7 @@ ___ • **bytesWritten**: *number* = 0 -*Defined in [lib/sparse-stream/sparse-transform-stream.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-transform-stream.ts#L34)* +*Defined in [lib/sparse-stream/sparse-transform-stream.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-transform-stream.ts#L35)* ___ @@ -127,7 +134,7 @@ ___ • **position**: *number* = 0 -*Defined in [lib/sparse-stream/sparse-transform-stream.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-transform-stream.ts#L33)* +*Defined in [lib/sparse-stream/sparse-transform-stream.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-transform-stream.ts#L34)* ___ @@ -139,7 +146,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readable](sparsefilterstream.md#readable)* -Defined in node_modules/@types/node/base.d.ts:5422 +Defined in node_modules/@types/node/stream.d.ts:20 ___ @@ -149,7 +156,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readableHighWaterMark](sparsefilterstream.md#readablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5423 +Defined in node_modules/@types/node/stream.d.ts:21 + +___ + +### readableLength + +• **readableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[readableLength](sparsefilterstream.md#readablelength)* + +Defined in node_modules/@types/node/stream.d.ts:22 ___ @@ -161,7 +178,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writable](sparsefilterstream.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5600 +Defined in node_modules/@types/node/stream.d.ts:209 ___ @@ -171,7 +188,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writableHighWaterMark](sparsefilterstream.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5601 +Defined in node_modules/@types/node/stream.d.ts:210 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[writableLength](sparsefilterstream.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:211 ___ @@ -181,10 +208,40 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹any›* + +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[[Symbol.asyncIterator]](sparsefilterstream.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/stream.d.ts:95 + +**Returns:** *AsyncIterableIterator‹any›* + +___ + +### `Private` __transform + +▸ **__transform**(`chunk`: [SparseStreamChunk](../interfaces/sparsestreamchunk.md)): *Promise‹void›* + +*Defined in [lib/sparse-stream/sparse-transform-stream.ts:58](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-transform-stream.ts#L58)* + +**Parameters:** + +Name | Type | +------ | ------ | +`chunk` | [SparseStreamChunk](../interfaces/sparsestreamchunk.md) | + +**Returns:** *Promise‹void›* + +___ + ### _destroy ▸ **_destroy**(`error`: [Error](notcapable.md#static-error) | null, `callback`: function): *void* @@ -193,7 +250,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadStream](sparsereadstream.md).[_destroy](sparsereadstream.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5605 +Defined in node_modules/@types/node/stream.d.ts:215 **Parameters:** @@ -201,13 +258,13 @@ Defined in node_modules/@types/node/base.d.ts:5605 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -215,17 +272,41 @@ ___ ### _final -▸ **_final**(`callback`: Function): *void* +▸ **_final**(`callback`: function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[_final](sparsefilterstream.md#_final)* -Defined in node_modules/@types/node/base.d.ts:5606 +Defined in node_modules/@types/node/stream.d.ts:216 + +**Parameters:** + +▪ **callback**: *function* + +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`callback` | Function | +`error?` | [Error](notcapable.md#static-error) | null | + +**Returns:** *void* + +___ + +### _flush + +▸ **_flush**(`callback`: TransformCallback): *void* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[_flush](sparsefilterstream.md#_flush)* + +Defined in node_modules/@types/node/stream.d.ts:242 + +**Parameters:** + +Name | Type | +------ | ------ | +`callback` | TransformCallback | **Returns:** *void* @@ -237,7 +318,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_read](sparsefilterstream.md#_read)* -Defined in node_modules/@types/node/base.d.ts:5425 +Defined in node_modules/@types/node/stream.d.ts:24 **Parameters:** @@ -251,11 +332,11 @@ ___ ### _transform -▸ **_transform**(`chunk`: [SparseStreamChunk](../interfaces/sparsestreamchunk.md), `_encoding`: string, `callback`: function): *Promise‹void›* +▸ **_transform**(`chunk`: [SparseStreamChunk](../interfaces/sparsestreamchunk.md), `_encoding`: string, `callback`: function): *void* *Overrides [SourceTransform](../interfaces/sourcetransform.md).[_transform](../interfaces/sourcetransform.md#_transform)* -*Defined in [lib/sparse-stream/sparse-transform-stream.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-transform-stream.ts#L57)* +*Defined in [lib/sparse-stream/sparse-transform-stream.ts:76](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-transform-stream.ts#L76)* **Parameters:** @@ -273,7 +354,7 @@ Name | Type | ------ | ------ | `error?` | [Error](notcapable.md#static-error) | -**Returns:** *Promise‹void›* +**Returns:** *void* ___ @@ -283,7 +364,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_write](sparsefilterstream.md#_write)* -Defined in node_modules/@types/node/base.d.ts:5603 +Defined in node_modules/@types/node/stream.d.ts:213 **Parameters:** @@ -293,13 +374,13 @@ Defined in node_modules/@types/node/base.d.ts:5603 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -311,7 +392,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_writev](sparsefilterstream.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5604 +Defined in node_modules/@types/node/stream.d.ts:214 **Parameters:** @@ -319,13 +400,13 @@ Defined in node_modules/@types/node/base.d.ts:5604 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -333,13 +414,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5447 +Defined in node_modules/@types/node/stream.d.ts:46 Event emitter The defined events on documents including: @@ -351,30 +432,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5448 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -389,7 +446,7 @@ Defined in node_modules/@types/node/base.d.ts:5448 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5449 +Defined in node_modules/@types/node/stream.d.ts:47 **Parameters:** @@ -397,13 +454,13 @@ Defined in node_modules/@types/node/base.d.ts:5449 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -413,7 +470,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5450 +Defined in node_modules/@types/node/stream.d.ts:48 **Parameters:** @@ -431,7 +488,7 @@ Defined in node_modules/@types/node/base.d.ts:5450 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5451 +Defined in node_modules/@types/node/stream.d.ts:49 **Parameters:** @@ -449,7 +506,7 @@ Defined in node_modules/@types/node/base.d.ts:5451 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5452 +Defined in node_modules/@types/node/stream.d.ts:50 **Parameters:** @@ -467,6 +524,30 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* + +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:51 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### cork @@ -475,7 +556,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[cork](sparsefilterstream.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5613 +Defined in node_modules/@types/node/stream.d.ts:223 **Returns:** *void* @@ -487,9 +568,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[destroy](sparsefilterstream.md#destroy)* -*Overrides [SparseReadStream](sparsereadstream.md).[destroy](sparsereadstream.md#destroy)* - -Defined in node_modules/@types/node/base.d.ts:5625 +Defined in node_modules/@types/node/stream.d.ts:35 **Parameters:** @@ -503,104 +582,104 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* - -*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* +▸ **emit**(`event`: "close"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5454 +Defined in node_modules/@types/node/stream.d.ts:53 **Parameters:** Name | Type | ------ | ------ | -`event` | string | symbol | -`...args` | any[] | +`event` | "close" | **Returns:** *boolean* -▸ **emit**(`event`: "close"): *boolean* +▸ **emit**(`event`: "data", `chunk`: any): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5455 +Defined in node_modules/@types/node/stream.d.ts:54 **Parameters:** Name | Type | ------ | ------ | -`event` | "close" | +`event` | "data" | +`chunk` | any | **Returns:** *boolean* -▸ **emit**(`event`: "data", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "end"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5456 +Defined in node_modules/@types/node/stream.d.ts:55 **Parameters:** Name | Type | ------ | ------ | -`event` | "data" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`event` | "end" | **Returns:** *boolean* -▸ **emit**(`event`: "end"): *boolean* +▸ **emit**(`event`: "readable"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5457 +Defined in node_modules/@types/node/stream.d.ts:56 **Parameters:** Name | Type | ------ | ------ | -`event` | "end" | +`event` | "readable" | **Returns:** *boolean* -▸ **emit**(`event`: "readable"): *boolean* +▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5458 +Defined in node_modules/@types/node/stream.d.ts:57 **Parameters:** Name | Type | ------ | ------ | -`event` | "readable" | +`event` | "error" | +`err` | [Error](notcapable.md#static-error) | **Returns:** *boolean* -▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* + +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5459 +Defined in node_modules/@types/node/stream.d.ts:58 **Parameters:** Name | Type | ------ | ------ | -`event` | "error" | -`err` | [Error](notcapable.md#static-error) | +`event` | string | symbol | +`...args` | any[] | **Returns:** *boolean* @@ -608,42 +687,40 @@ ___ ### end -▸ **end**(`cb?`: Function): *void* - -*Implementation of [SparseWritable](../interfaces/sparsewritable.md)* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5610 +Defined in node_modules/@types/node/stream.d.ts:220 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5611 +Defined in node_modules/@types/node/stream.d.ts:221 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5612 +Defined in node_modules/@types/node/stream.d.ts:222 **Parameters:** @@ -651,7 +728,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -665,7 +742,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -679,7 +756,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -693,7 +770,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[isPaused](sparsefilterstream.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:5430 +Defined in node_modules/@types/node/stream.d.ts:29 **Returns:** *boolean* @@ -707,7 +784,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -727,7 +804,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -739,19 +816,17 @@ Name | Type | ___ -### on +### off -▸ **on**(`event`: string, `listener`: function): *this* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* - -Defined in node_modules/@types/node/base.d.ts:5461 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -765,13 +840,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5462 +Defined in node_modules/@types/node/stream.d.ts:60 **Parameters:** @@ -789,7 +868,7 @@ Defined in node_modules/@types/node/base.d.ts:5462 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5463 +Defined in node_modules/@types/node/stream.d.ts:61 **Parameters:** @@ -797,13 +876,13 @@ Defined in node_modules/@types/node/base.d.ts:5463 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -813,7 +892,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5464 +Defined in node_modules/@types/node/stream.d.ts:62 **Parameters:** @@ -831,7 +910,7 @@ Defined in node_modules/@types/node/base.d.ts:5464 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5465 +Defined in node_modules/@types/node/stream.d.ts:63 **Parameters:** @@ -849,7 +928,7 @@ Defined in node_modules/@types/node/base.d.ts:5465 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5466 +Defined in node_modules/@types/node/stream.d.ts:64 **Parameters:** @@ -867,21 +946,17 @@ Name | Type | **Returns:** *this* -___ +▸ **on**(`event`: string | symbol, `listener`: function): *this* -### once - -▸ **once**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5468 +Defined in node_modules/@types/node/stream.d.ts:65 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -895,13 +970,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5469 +Defined in node_modules/@types/node/stream.d.ts:67 **Parameters:** @@ -919,7 +998,7 @@ Defined in node_modules/@types/node/base.d.ts:5469 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5470 +Defined in node_modules/@types/node/stream.d.ts:68 **Parameters:** @@ -927,13 +1006,13 @@ Defined in node_modules/@types/node/base.d.ts:5470 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -943,7 +1022,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5471 +Defined in node_modules/@types/node/stream.d.ts:69 **Parameters:** @@ -961,7 +1040,7 @@ Defined in node_modules/@types/node/base.d.ts:5471 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5472 +Defined in node_modules/@types/node/stream.d.ts:70 **Parameters:** @@ -979,7 +1058,7 @@ Defined in node_modules/@types/node/base.d.ts:5472 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5473 +Defined in node_modules/@types/node/stream.d.ts:71 **Parameters:** @@ -997,6 +1076,30 @@ Name | Type | **Returns:** *this* +▸ **once**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* + +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* + +Defined in node_modules/@types/node/stream.d.ts:72 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### pause @@ -1007,7 +1110,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[pause](sparsefilterstream.md#pause)* -Defined in node_modules/@types/node/base.d.ts:5428 +Defined in node_modules/@types/node/stream.d.ts:27 **Returns:** *this* @@ -1019,7 +1122,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:5407 +Defined in node_modules/@types/node/stream.d.ts:5 **Type parameters:** @@ -1038,37 +1141,13 @@ ___ ### prependListener -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* - -Defined in node_modules/@types/node/base.d.ts:5475 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **prependListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5476 +Defined in node_modules/@types/node/stream.d.ts:74 **Parameters:** @@ -1086,7 +1165,7 @@ Defined in node_modules/@types/node/base.d.ts:5476 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5477 +Defined in node_modules/@types/node/stream.d.ts:75 **Parameters:** @@ -1094,13 +1173,13 @@ Defined in node_modules/@types/node/base.d.ts:5477 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1110,7 +1189,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5478 +Defined in node_modules/@types/node/stream.d.ts:76 **Parameters:** @@ -1128,7 +1207,7 @@ Defined in node_modules/@types/node/base.d.ts:5478 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5479 +Defined in node_modules/@types/node/stream.d.ts:77 **Parameters:** @@ -1146,7 +1225,7 @@ Defined in node_modules/@types/node/base.d.ts:5479 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5480 +Defined in node_modules/@types/node/stream.d.ts:78 **Parameters:** @@ -1164,21 +1243,17 @@ Name | Type | **Returns:** *this* -___ +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -### prependOnceListener - -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5482 +Defined in node_modules/@types/node/stream.d.ts:79 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1192,13 +1267,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5483 +Defined in node_modules/@types/node/stream.d.ts:81 **Parameters:** @@ -1216,7 +1295,7 @@ Defined in node_modules/@types/node/base.d.ts:5483 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5484 +Defined in node_modules/@types/node/stream.d.ts:82 **Parameters:** @@ -1224,13 +1303,13 @@ Defined in node_modules/@types/node/base.d.ts:5484 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1240,7 +1319,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5485 +Defined in node_modules/@types/node/stream.d.ts:83 **Parameters:** @@ -1258,7 +1337,7 @@ Defined in node_modules/@types/node/base.d.ts:5485 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5486 +Defined in node_modules/@types/node/stream.d.ts:84 **Parameters:** @@ -1276,7 +1355,7 @@ Defined in node_modules/@types/node/base.d.ts:5486 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5487 +Defined in node_modules/@types/node/stream.d.ts:85 **Parameters:** @@ -1294,6 +1373,30 @@ Name | Type | **Returns:** *this* +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* + +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* + +Defined in node_modules/@types/node/stream.d.ts:86 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### push @@ -1302,7 +1405,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[push](sparsefilterstream.md#push)* -Defined in node_modules/@types/node/base.d.ts:5434 +Defined in node_modules/@types/node/stream.d.ts:33 **Parameters:** @@ -1315,79 +1418,75 @@ Name | Type | ___ -### read +### rawListeners -▸ **read**(`size?`: undefined | number): *any* +▸ **rawListeners**(`event`: string | symbol): *Function[]* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -*Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* -Defined in node_modules/@types/node/base.d.ts:5426 +Defined in node_modules/@types/node/events.d.ts:31 **Parameters:** Name | Type | ------ | ------ | -`size?` | undefined | number | +`event` | string | symbol | -**Returns:** *any* +**Returns:** *Function[]* ___ -### removeAllListeners +### read -▸ **removeAllListeners**(`event?`: string | symbol): *this* +▸ **read**(`size?`: undefined | number): *any* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/stream.d.ts:25 **Parameters:** Name | Type | ------ | ------ | -`event?` | string | symbol | +`size?` | undefined | number | -**Returns:** *this* +**Returns:** *any* ___ -### removeListener - -▸ **removeListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* - -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5489 +### removeAllListeners -**Parameters:** +▸ **removeAllListeners**(`event?`: string | symbol): *this* -▪ **event**: *string* +*Implementation of [SparseReadable](../interfaces/sparsereadable.md)* -▪ **listener**: *function* +*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* -▸ (...`args`: any[]): *void* +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`event?` | string | symbol | **Returns:** *this* +___ + +### removeListener + ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5490 +Defined in node_modules/@types/node/stream.d.ts:88 **Parameters:** @@ -1405,7 +1504,7 @@ Defined in node_modules/@types/node/base.d.ts:5490 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5491 +Defined in node_modules/@types/node/stream.d.ts:89 **Parameters:** @@ -1413,13 +1512,13 @@ Defined in node_modules/@types/node/base.d.ts:5491 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1429,7 +1528,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5492 +Defined in node_modules/@types/node/stream.d.ts:90 **Parameters:** @@ -1447,7 +1546,7 @@ Defined in node_modules/@types/node/base.d.ts:5492 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5493 +Defined in node_modules/@types/node/stream.d.ts:91 **Parameters:** @@ -1465,7 +1564,7 @@ Defined in node_modules/@types/node/base.d.ts:5493 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5494 +Defined in node_modules/@types/node/stream.d.ts:92 **Parameters:** @@ -1483,6 +1582,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:93 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### resume @@ -1493,7 +1616,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[resume](sparsefilterstream.md#resume)* -Defined in node_modules/@types/node/base.d.ts:5429 +Defined in node_modules/@types/node/stream.d.ts:28 **Returns:** *this* @@ -1505,7 +1628,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setDefaultEncoding](sparsefilterstream.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5609 +Defined in node_modules/@types/node/stream.d.ts:219 **Parameters:** @@ -1525,7 +1648,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setEncoding](sparsefilterstream.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:5427 +Defined in node_modules/@types/node/stream.d.ts:26 **Parameters:** @@ -1545,7 +1668,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1563,7 +1686,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[uncork](sparsefilterstream.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5614 +Defined in node_modules/@types/node/stream.d.ts:224 **Returns:** *void* @@ -1571,23 +1694,19 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: NodeJS.WritableStream): *this* *Implementation of [SparseReadable](../interfaces/sparsereadable.md)* *Inherited from [SparseFilterStream](sparsefilterstream.md).[unpipe](sparsefilterstream.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:5431 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/stream.d.ts:30 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | NodeJS.WritableStream | **Returns:** *this* @@ -1599,7 +1718,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[unshift](sparsefilterstream.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:5432 +Defined in node_modules/@types/node/stream.d.ts:31 **Parameters:** @@ -1619,7 +1738,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[wrap](sparsefilterstream.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:5433 +Defined in node_modules/@types/node/stream.d.ts:32 **Parameters:** @@ -1633,26 +1752,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5607 +Defined in node_modules/@types/node/stream.d.ts:217 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5608 +Defined in node_modules/@types/node/stream.d.ts:218 **Parameters:** @@ -1660,7 +1779,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1672,7 +1791,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/sparsewritestream.md b/doc/classes/sparsewritestream.md index fb4a9c21..b2591d41 100644 --- a/doc/classes/sparsewritestream.md +++ b/doc/classes/sparsewritestream.md @@ -29,6 +29,7 @@ * [position](sparsewritestream.md#position) * [writable](sparsewritestream.md#writable) * [writableHighWaterMark](sparsewritestream.md#writablehighwatermark) +* [writableLength](sparsewritestream.md#writablelength) * [defaultMaxListeners](sparsewritestream.md#static-defaultmaxlisteners) ### Methods @@ -49,11 +50,13 @@ * [getMaxListeners](sparsewritestream.md#getmaxlisteners) * [listenerCount](sparsewritestream.md#listenercount) * [listeners](sparsewritestream.md#listeners) +* [off](sparsewritestream.md#off) * [on](sparsewritestream.md#on) * [once](sparsewritestream.md#once) * [pipe](sparsewritestream.md#pipe) * [prependListener](sparsewritestream.md#prependlistener) * [prependOnceListener](sparsewritestream.md#prependoncelistener) +* [rawListeners](sparsewritestream.md#rawlisteners) * [removeAllListeners](sparsewritestream.md#removealllisteners) * [removeListener](sparsewritestream.md#removelistener) * [setDefaultEncoding](sparsewritestream.md#setdefaultencoding) @@ -71,7 +74,7 @@ *Overrides [CountingWritable](countingwritable.md).[constructor](countingwritable.md#constructor)* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:19](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L19)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:19](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L19)* **Parameters:** @@ -92,7 +95,7 @@ Name | Type | Default | • **_firstChunks**: *[SparseStreamChunk](../interfaces/sparsestreamchunk.md)[]* = [] -*Defined in [lib/sparse-stream/sparse-write-stream.ts:19](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L19)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:19](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L19)* ___ @@ -100,7 +103,7 @@ ___ • **bytesWritten**: *number* = 0 -*Defined in [lib/sparse-stream/sparse-write-stream.ts:18](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L18)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:18](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L18)* ___ @@ -108,7 +111,7 @@ ___ • **destination**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:14](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L14)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:14](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L14)* ___ @@ -116,7 +119,7 @@ ___ • **firstBytesToKeep**: *number* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:15](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L15)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:15](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L15)* ___ @@ -124,7 +127,7 @@ ___ • **maxRetries**: *number* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:16](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L16)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:16](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L16)* ___ @@ -132,7 +135,7 @@ ___ • **position**: *number* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:17](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L17)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:17](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L17)* ___ @@ -144,7 +147,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[writable](countingwritable.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5508 +Defined in node_modules/@types/node/stream.d.ts:109 ___ @@ -154,7 +157,17 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[writableHighWaterMark](countingwritable.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5509 +Defined in node_modules/@types/node/stream.d.ts:110 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [CountingWritable](countingwritable.md).[writableLength](countingwritable.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:111 ___ @@ -164,7 +177,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -172,7 +185,7 @@ Defined in node_modules/@types/node/base.d.ts:896 ▸ **__final**(): *Promise‹void›* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:129](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L129)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:129](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L129)* **Returns:** *Promise‹void›* @@ -182,7 +195,7 @@ ___ ▸ **__write**(`chunk`: [SparseStreamChunk](../interfaces/sparsestreamchunk.md)): *Promise‹void›* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L84)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L84)* **Parameters:** @@ -200,7 +213,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[_destroy](countingwritable.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5513 +Defined in node_modules/@types/node/stream.d.ts:115 **Parameters:** @@ -208,13 +221,13 @@ Defined in node_modules/@types/node/base.d.ts:5513 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -226,7 +239,7 @@ ___ *Overrides [CountingWritable](countingwritable.md).[_final](countingwritable.md#_final)* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:143](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L143)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:143](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L143)* **`summary`** Write buffered data before a stream ends, called by stream internals @@ -234,13 +247,13 @@ ___ ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error) | void): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | void | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -252,7 +265,7 @@ ___ *Overrides void* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:121](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L121)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:121](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L121)* **Parameters:** @@ -262,13 +275,13 @@ ___ ▪ **callback**: *function* -▸ (`error`: [Error](notcapable.md#static-error) | undefined): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error` | [Error](notcapable.md#static-error) | undefined | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -280,7 +293,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[_writev](countingwritable.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5512 +Defined in node_modules/@types/node/stream.d.ts:114 **Parameters:** @@ -288,13 +301,13 @@ Defined in node_modules/@types/node/base.d.ts:5512 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -302,13 +315,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5535 +Defined in node_modules/@types/node/stream.d.ts:137 Event emitter The defined events on documents including: @@ -321,30 +334,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5536 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -359,7 +348,7 @@ Defined in node_modules/@types/node/base.d.ts:5536 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5537 +Defined in node_modules/@types/node/stream.d.ts:138 **Parameters:** @@ -377,7 +366,7 @@ Defined in node_modules/@types/node/base.d.ts:5537 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5538 +Defined in node_modules/@types/node/stream.d.ts:139 **Parameters:** @@ -401,7 +390,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5539 +Defined in node_modules/@types/node/stream.d.ts:140 **Parameters:** @@ -419,7 +408,7 @@ Defined in node_modules/@types/node/base.d.ts:5539 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5540 +Defined in node_modules/@types/node/stream.d.ts:141 **Parameters:** @@ -443,7 +432,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5541 +Defined in node_modules/@types/node/stream.d.ts:142 **Parameters:** @@ -461,13 +450,37 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[addListener](countingwritable.md#addlistener)* + +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:143 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### `Private` copyChunk ▸ **copyChunk**(`chunk`: [SparseStreamChunk](../interfaces/sparsestreamchunk.md)): *[SparseStreamChunk](../interfaces/sparsestreamchunk.md)* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:71](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L71)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:71](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L71)* **Parameters:** @@ -485,7 +498,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[cork](countingwritable.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5521 +Defined in node_modules/@types/node/stream.d.ts:123 **Returns:** *void* @@ -497,7 +510,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[destroy](countingwritable.md#destroy)* -Defined in node_modules/@types/node/base.d.ts:5523 +Defined in node_modules/@types/node/stream.d.ts:125 **Parameters:** @@ -511,32 +524,13 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* - -*Implementation of [SparseWritable](../interfaces/sparsewritable.md)* - -*Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* - -*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* - -Defined in node_modules/@types/node/base.d.ts:5543 - -**Parameters:** - -Name | Type | ------- | ------ | -`event` | string | symbol | -`...args` | any[] | - -**Returns:** *boolean* - ▸ **emit**(`event`: "close"): *boolean* *Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5544 +Defined in node_modules/@types/node/stream.d.ts:145 **Parameters:** @@ -546,20 +540,19 @@ Name | Type | **Returns:** *boolean* -▸ **emit**(`event`: "drain", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "drain"): *boolean* *Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5545 +Defined in node_modules/@types/node/stream.d.ts:146 **Parameters:** Name | Type | ------ | ------ | `event` | "drain" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | **Returns:** *boolean* @@ -569,7 +562,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5546 +Defined in node_modules/@types/node/stream.d.ts:147 **Parameters:** @@ -586,7 +579,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5547 +Defined in node_modules/@types/node/stream.d.ts:148 **Parameters:** @@ -602,7 +595,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5548 +Defined in node_modules/@types/node/stream.d.ts:149 **Parameters:** @@ -619,7 +612,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5549 +Defined in node_modules/@types/node/stream.d.ts:150 **Parameters:** @@ -630,46 +623,63 @@ Name | Type | **Returns:** *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* + +*Implementation of [SparseWritable](../interfaces/sparsewritable.md)* + +*Inherited from [CountingWritable](countingwritable.md).[emit](countingwritable.md#emit)* + +*Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* + +Defined in node_modules/@types/node/stream.d.ts:151 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | +`...args` | any[] | + +**Returns:** *boolean* + ___ ### end -▸ **end**(`cb?`: Function): *void* - -*Implementation of [SparseWritable](../interfaces/sparsewritable.md)* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5518 +Defined in node_modules/@types/node/stream.d.ts:120 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5519 +Defined in node_modules/@types/node/stream.d.ts:121 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [CountingWritable](countingwritable.md).[end](countingwritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:5520 +Defined in node_modules/@types/node/stream.d.ts:122 **Parameters:** @@ -677,7 +687,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -691,7 +701,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -705,7 +715,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -719,7 +729,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -739,7 +749,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -751,19 +761,17 @@ Name | Type | ___ -### on - -▸ **on**(`event`: string, `listener`: function): *this* +### off -*Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -Defined in node_modules/@types/node/base.d.ts:5551 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -777,13 +785,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5552 +Defined in node_modules/@types/node/stream.d.ts:153 **Parameters:** @@ -801,7 +813,7 @@ Defined in node_modules/@types/node/base.d.ts:5552 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5553 +Defined in node_modules/@types/node/stream.d.ts:154 **Parameters:** @@ -819,7 +831,7 @@ Defined in node_modules/@types/node/base.d.ts:5553 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5554 +Defined in node_modules/@types/node/stream.d.ts:155 **Parameters:** @@ -843,7 +855,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5555 +Defined in node_modules/@types/node/stream.d.ts:156 **Parameters:** @@ -861,7 +873,7 @@ Defined in node_modules/@types/node/base.d.ts:5555 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5556 +Defined in node_modules/@types/node/stream.d.ts:157 **Parameters:** @@ -885,7 +897,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5557 +Defined in node_modules/@types/node/stream.d.ts:158 **Parameters:** @@ -903,21 +915,17 @@ Name | Type | **Returns:** *this* -___ - -### once - -▸ **once**(`event`: string, `listener`: function): *this* +▸ **on**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* +*Inherited from [CountingWritable](countingwritable.md).[on](countingwritable.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5559 +Defined in node_modules/@types/node/stream.d.ts:159 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -931,13 +939,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5560 +Defined in node_modules/@types/node/stream.d.ts:161 **Parameters:** @@ -955,7 +967,7 @@ Defined in node_modules/@types/node/base.d.ts:5560 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5561 +Defined in node_modules/@types/node/stream.d.ts:162 **Parameters:** @@ -973,7 +985,7 @@ Defined in node_modules/@types/node/base.d.ts:5561 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5562 +Defined in node_modules/@types/node/stream.d.ts:163 **Parameters:** @@ -997,7 +1009,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5563 +Defined in node_modules/@types/node/stream.d.ts:164 **Parameters:** @@ -1015,7 +1027,7 @@ Defined in node_modules/@types/node/base.d.ts:5563 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5564 +Defined in node_modules/@types/node/stream.d.ts:165 **Parameters:** @@ -1039,7 +1051,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5565 +Defined in node_modules/@types/node/stream.d.ts:166 **Parameters:** @@ -1057,56 +1069,56 @@ Name | Type | **Returns:** *this* -___ +▸ **once**(`event`: string | symbol, `listener`: function): *this* -### pipe +*Inherited from [CountingWritable](countingwritable.md).[once](countingwritable.md#once)* -▸ **pipe**<**T**>(`destination`: T, `options?`: undefined | object): *T* +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -*Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* +Defined in node_modules/@types/node/stream.d.ts:167 -Defined in node_modules/@types/node/base.d.ts:5407 +**Parameters:** -**Type parameters:** +▪ **event**: *string | symbol* -▪ **T**: *WritableStream* +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* **Parameters:** Name | Type | ------ | ------ | -`destination` | T | -`options?` | undefined | object | +`...args` | any[] | -**Returns:** *T* +**Returns:** *this* ___ -### prependListener - -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[prependListener](countingwritable.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* +### pipe -Defined in node_modules/@types/node/base.d.ts:5567 +▸ **pipe**<**T**>(`destination`: T, `options?`: undefined | object): *T* -**Parameters:** +*Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -▪ **event**: *string* +Defined in node_modules/@types/node/stream.d.ts:5 -▪ **listener**: *function* +**Type parameters:** -▸ (...`args`: any[]): *void* +▪ **T**: *WritableStream* **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`destination` | T | +`options?` | undefined | object | -**Returns:** *this* +**Returns:** *T* + +___ + +### prependListener ▸ **prependListener**(`event`: "close", `listener`: function): *this* @@ -1114,7 +1126,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5568 +Defined in node_modules/@types/node/stream.d.ts:169 **Parameters:** @@ -1132,7 +1144,7 @@ Defined in node_modules/@types/node/base.d.ts:5568 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5569 +Defined in node_modules/@types/node/stream.d.ts:170 **Parameters:** @@ -1150,7 +1162,7 @@ Defined in node_modules/@types/node/base.d.ts:5569 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5570 +Defined in node_modules/@types/node/stream.d.ts:171 **Parameters:** @@ -1174,7 +1186,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5571 +Defined in node_modules/@types/node/stream.d.ts:172 **Parameters:** @@ -1192,7 +1204,7 @@ Defined in node_modules/@types/node/base.d.ts:5571 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5572 +Defined in node_modules/@types/node/stream.d.ts:173 **Parameters:** @@ -1216,7 +1228,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5573 +Defined in node_modules/@types/node/stream.d.ts:174 **Parameters:** @@ -1234,21 +1246,17 @@ Name | Type | **Returns:** *this* -___ +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -### prependOnceListener - -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* - -*Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* +*Inherited from [CountingWritable](countingwritable.md).[prependListener](countingwritable.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5575 +Defined in node_modules/@types/node/stream.d.ts:175 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1262,13 +1270,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5576 +Defined in node_modules/@types/node/stream.d.ts:177 **Parameters:** @@ -1286,7 +1298,7 @@ Defined in node_modules/@types/node/base.d.ts:5576 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5577 +Defined in node_modules/@types/node/stream.d.ts:178 **Parameters:** @@ -1304,7 +1316,7 @@ Defined in node_modules/@types/node/base.d.ts:5577 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5578 +Defined in node_modules/@types/node/stream.d.ts:179 **Parameters:** @@ -1328,7 +1340,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5579 +Defined in node_modules/@types/node/stream.d.ts:180 **Parameters:** @@ -1346,7 +1358,7 @@ Defined in node_modules/@types/node/base.d.ts:5579 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5580 +Defined in node_modules/@types/node/stream.d.ts:181 **Parameters:** @@ -1370,7 +1382,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5581 +Defined in node_modules/@types/node/stream.d.ts:182 **Parameters:** @@ -1388,61 +1400,81 @@ Name | Type | **Returns:** *this* -___ +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* -### removeAllListeners +*Inherited from [CountingWritable](countingwritable.md).[prependOnceListener](countingwritable.md#prependoncelistener)* -▸ **removeAllListeners**(`event?`: string | symbol): *this* +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -*Implementation of [SparseWritable](../interfaces/sparsewritable.md)* +Defined in node_modules/@types/node/stream.d.ts:183 -*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* +**Parameters:** + +▪ **event**: *string | symbol* -Defined in node_modules/@types/node/base.d.ts:904 +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* **Parameters:** Name | Type | ------ | ------ | -`event?` | string | symbol | +`...args` | any[] | **Returns:** *this* ___ -### removeListener +### rawListeners -▸ **removeListener**(`event`: string, `listener`: function): *this* +▸ **rawListeners**(`event`: string | symbol): *Function[]* -*Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* +*Implementation of [SparseWritable](../interfaces/sparsewritable.md)* -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* -Defined in node_modules/@types/node/base.d.ts:5583 +Defined in node_modules/@types/node/events.d.ts:31 **Parameters:** -▪ **event**: *string* +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* -▪ **listener**: *function* +___ -▸ (...`args`: any[]): *void* +### removeAllListeners + +▸ **removeAllListeners**(`event?`: string | symbol): *this* + +*Implementation of [SparseWritable](../interfaces/sparsewritable.md)* + +*Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* + +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** Name | Type | ------ | ------ | -`...args` | any[] | +`event?` | string | symbol | **Returns:** *this* +___ + +### removeListener + ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5584 +Defined in node_modules/@types/node/stream.d.ts:185 **Parameters:** @@ -1460,7 +1492,7 @@ Defined in node_modules/@types/node/base.d.ts:5584 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5585 +Defined in node_modules/@types/node/stream.d.ts:186 **Parameters:** @@ -1478,7 +1510,7 @@ Defined in node_modules/@types/node/base.d.ts:5585 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5586 +Defined in node_modules/@types/node/stream.d.ts:187 **Parameters:** @@ -1502,7 +1534,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5587 +Defined in node_modules/@types/node/stream.d.ts:188 **Parameters:** @@ -1520,7 +1552,7 @@ Defined in node_modules/@types/node/base.d.ts:5587 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5588 +Defined in node_modules/@types/node/stream.d.ts:189 **Parameters:** @@ -1544,7 +1576,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5589 +Defined in node_modules/@types/node/stream.d.ts:190 **Parameters:** @@ -1562,6 +1594,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[removeListener](countingwritable.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:191 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### setDefaultEncoding @@ -1570,7 +1626,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setDefaultEncoding](countingwritable.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5517 +Defined in node_modules/@types/node/stream.d.ts:119 **Parameters:** @@ -1590,7 +1646,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1608,7 +1664,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[uncork](countingwritable.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5522 +Defined in node_modules/@types/node/stream.d.ts:124 **Returns:** *void* @@ -1616,26 +1672,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [CountingWritable](countingwritable.md).[write](countingwritable.md#write)* -Defined in node_modules/@types/node/base.d.ts:5515 +Defined in node_modules/@types/node/stream.d.ts:117 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [CountingWritable](countingwritable.md).[write](countingwritable.md#write)* -Defined in node_modules/@types/node/base.d.ts:5516 +Defined in node_modules/@types/node/stream.d.ts:118 **Parameters:** @@ -1643,7 +1699,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1653,7 +1709,7 @@ ___ ▸ **writeChunk**(`chunk`: [SparseStreamChunk](../interfaces/sparsestreamchunk.md), `flushing`: boolean): *Promise‹void›* -*Defined in [lib/sparse-stream/sparse-write-stream.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/sparse-write-stream.ts#L38)* +*Defined in [lib/sparse-stream/sparse-write-stream.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/sparse-write-stream.ts#L38)* **Parameters:** @@ -1672,7 +1728,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/streamlimiter.md b/doc/classes/streamlimiter.md index c1c05cad..49062480 100644 --- a/doc/classes/streamlimiter.md +++ b/doc/classes/streamlimiter.md @@ -24,15 +24,19 @@ * [maxBytes](streamlimiter.md#private-maxbytes) * [readable](streamlimiter.md#readable) * [readableHighWaterMark](streamlimiter.md#readablehighwatermark) +* [readableLength](streamlimiter.md#readablelength) * [stream](streamlimiter.md#private-stream) * [writable](streamlimiter.md#writable) * [writableHighWaterMark](streamlimiter.md#writablehighwatermark) +* [writableLength](streamlimiter.md#writablelength) * [defaultMaxListeners](streamlimiter.md#static-defaultmaxlisteners) ### Methods +* [[Symbol.asyncIterator]](streamlimiter.md#[symbol.asynciterator]) * [_destroy](streamlimiter.md#_destroy) * [_final](streamlimiter.md#_final) +* [_flush](streamlimiter.md#_flush) * [_read](streamlimiter.md#_read) * [_transform](streamlimiter.md#_transform) * [_write](streamlimiter.md#_write) @@ -47,6 +51,7 @@ * [isPaused](streamlimiter.md#ispaused) * [listenerCount](streamlimiter.md#listenercount) * [listeners](streamlimiter.md#listeners) +* [off](streamlimiter.md#off) * [on](streamlimiter.md#on) * [once](streamlimiter.md#once) * [pause](streamlimiter.md#pause) @@ -54,6 +59,7 @@ * [prependListener](streamlimiter.md#prependlistener) * [prependOnceListener](streamlimiter.md#prependoncelistener) * [push](streamlimiter.md#push) +* [rawListeners](streamlimiter.md#rawlisteners) * [read](streamlimiter.md#read) * [removeAllListeners](streamlimiter.md#removealllisteners) * [removeListener](streamlimiter.md#removelistener) @@ -76,7 +82,7 @@ *Overrides [SourceTransform](../interfaces/sourcetransform.md).[constructor](../interfaces/sourcetransform.md#constructor)* -*Defined in [lib/stream-limiter.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/stream-limiter.ts#L22)* +*Defined in [lib/stream-limiter.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/stream-limiter.ts#L22)* **Parameters:** @@ -93,7 +99,7 @@ Name | Type | • **maxBytes**: *number* -*Defined in [lib/stream-limiter.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/stream-limiter.ts#L23)* +*Defined in [lib/stream-limiter.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/stream-limiter.ts#L23)* ___ @@ -103,7 +109,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readable](sparsefilterstream.md#readable)* -Defined in node_modules/@types/node/base.d.ts:5422 +Defined in node_modules/@types/node/stream.d.ts:20 ___ @@ -113,7 +119,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[readableHighWaterMark](sparsefilterstream.md#readablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5423 +Defined in node_modules/@types/node/stream.d.ts:21 + +___ + +### readableLength + +• **readableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[readableLength](sparsefilterstream.md#readablelength)* + +Defined in node_modules/@types/node/stream.d.ts:22 ___ @@ -121,7 +137,7 @@ ___ • **stream**: *ReadableStream* -*Defined in [lib/stream-limiter.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/stream-limiter.ts#L23)* +*Defined in [lib/stream-limiter.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/stream-limiter.ts#L23)* ___ @@ -131,7 +147,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writable](sparsefilterstream.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5600 +Defined in node_modules/@types/node/stream.d.ts:209 ___ @@ -141,7 +157,17 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[writableHighWaterMark](sparsefilterstream.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5601 +Defined in node_modules/@types/node/stream.d.ts:210 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[writableLength](sparsefilterstream.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:211 ___ @@ -151,10 +177,22 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹any›* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[[Symbol.asyncIterator]](sparsefilterstream.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/stream.d.ts:95 + +**Returns:** *AsyncIterableIterator‹any›* + +___ + ### _destroy ▸ **_destroy**(`error`: [Error](notcapable.md#static-error) | null, `callback`: function): *void* @@ -163,7 +201,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadStream](sparsereadstream.md).[_destroy](sparsereadstream.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5605 +Defined in node_modules/@types/node/stream.d.ts:215 **Parameters:** @@ -171,13 +209,13 @@ Defined in node_modules/@types/node/base.d.ts:5605 ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error)): *void* +▸ (`error`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | +`error` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -185,17 +223,41 @@ ___ ### _final -▸ **_final**(`callback`: Function): *void* +▸ **_final**(`callback`: function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[_final](sparsefilterstream.md#_final)* -Defined in node_modules/@types/node/base.d.ts:5606 +Defined in node_modules/@types/node/stream.d.ts:216 + +**Parameters:** + +▪ **callback**: *function* + +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`error?` | [Error](notcapable.md#static-error) | null | + +**Returns:** *void* + +___ + +### _flush + +▸ **_flush**(`callback`: TransformCallback): *void* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[_flush](sparsefilterstream.md#_flush)* + +Defined in node_modules/@types/node/stream.d.ts:242 **Parameters:** Name | Type | ------ | ------ | -`callback` | Function | +`callback` | TransformCallback | **Returns:** *void* @@ -207,7 +269,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_read](sparsefilterstream.md#_read)* -Defined in node_modules/@types/node/base.d.ts:5425 +Defined in node_modules/@types/node/stream.d.ts:24 **Parameters:** @@ -225,7 +287,7 @@ ___ *Overrides [SourceTransform](../interfaces/sourcetransform.md).[_transform](../interfaces/sourcetransform.md#_transform)* -*Defined in [lib/stream-limiter.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/stream-limiter.ts#L29)* +*Defined in [lib/stream-limiter.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/stream-limiter.ts#L29)* **Parameters:** @@ -235,13 +297,13 @@ ___ ▪ **callback**: *function* -▸ (`error?`: [Error](notcapable.md#static-error) | null, `data?`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer)): *void* +▸ (`error?`: [Error](notcapable.md#static-error), `data?`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer)): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](notcapable.md#static-error) | null | +`error?` | [Error](notcapable.md#static-error) | `data?` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | **Returns:** *void* @@ -254,7 +316,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_write](sparsefilterstream.md#_write)* -Defined in node_modules/@types/node/base.d.ts:5603 +Defined in node_modules/@types/node/stream.d.ts:213 **Parameters:** @@ -264,13 +326,13 @@ Defined in node_modules/@types/node/base.d.ts:5603 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -282,7 +344,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[_writev](sparsefilterstream.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5604 +Defined in node_modules/@types/node/stream.d.ts:214 **Parameters:** @@ -290,13 +352,13 @@ Defined in node_modules/@types/node/base.d.ts:5604 ▪ **callback**: *function* -▸ (`err?`: [Error](notcapable.md#static-error)): *void* +▸ (`error?`: [Error](notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](notcapable.md#static-error) | +`error?` | [Error](notcapable.md#static-error) | null | **Returns:** *void* @@ -304,13 +366,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5447 +Defined in node_modules/@types/node/stream.d.ts:46 Event emitter The defined events on documents including: @@ -322,30 +384,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* - -*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5448 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -360,7 +398,7 @@ Defined in node_modules/@types/node/base.d.ts:5448 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5449 +Defined in node_modules/@types/node/stream.d.ts:47 **Parameters:** @@ -368,13 +406,13 @@ Defined in node_modules/@types/node/base.d.ts:5449 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -384,7 +422,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5450 +Defined in node_modules/@types/node/stream.d.ts:48 **Parameters:** @@ -402,7 +440,7 @@ Defined in node_modules/@types/node/base.d.ts:5450 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5451 +Defined in node_modules/@types/node/stream.d.ts:49 **Parameters:** @@ -420,7 +458,7 @@ Defined in node_modules/@types/node/base.d.ts:5451 *Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5452 +Defined in node_modules/@types/node/stream.d.ts:50 **Parameters:** @@ -438,6 +476,30 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[addListener](sparsefilterstream.md#addlistener)* + +*Overrides [SourceSource](sourcesource.md).[addListener](sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:51 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### cork @@ -446,7 +508,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[cork](sparsefilterstream.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5613 +Defined in node_modules/@types/node/stream.d.ts:223 **Returns:** *void* @@ -458,9 +520,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[destroy](sparsefilterstream.md#destroy)* -*Overrides [SparseReadStream](sparsereadstream.md).[destroy](sparsereadstream.md#destroy)* - -Defined in node_modules/@types/node/base.d.ts:5625 +Defined in node_modules/@types/node/stream.d.ts:35 **Parameters:** @@ -474,102 +534,102 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* +▸ **emit**(`event`: "close"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5454 +Defined in node_modules/@types/node/stream.d.ts:53 **Parameters:** Name | Type | ------ | ------ | -`event` | string | symbol | -`...args` | any[] | +`event` | "close" | **Returns:** *boolean* -▸ **emit**(`event`: "close"): *boolean* +▸ **emit**(`event`: "data", `chunk`: any): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5455 +Defined in node_modules/@types/node/stream.d.ts:54 **Parameters:** Name | Type | ------ | ------ | -`event` | "close" | +`event` | "data" | +`chunk` | any | **Returns:** *boolean* -▸ **emit**(`event`: "data", `chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "end"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5456 +Defined in node_modules/@types/node/stream.d.ts:55 **Parameters:** Name | Type | ------ | ------ | -`event` | "data" | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`event` | "end" | **Returns:** *boolean* -▸ **emit**(`event`: "end"): *boolean* +▸ **emit**(`event`: "readable"): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5457 +Defined in node_modules/@types/node/stream.d.ts:56 **Parameters:** Name | Type | ------ | ------ | -`event` | "end" | +`event` | "readable" | **Returns:** *boolean* -▸ **emit**(`event`: "readable"): *boolean* +▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5458 +Defined in node_modules/@types/node/stream.d.ts:57 **Parameters:** Name | Type | ------ | ------ | -`event` | "readable" | +`event` | "error" | +`err` | [Error](notcapable.md#static-error) | **Returns:** *boolean* -▸ **emit**(`event`: "error", `err`: [Error](notcapable.md#static-error)): *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[emit](sparsefilterstream.md#emit)* *Overrides [SourceSource](sourcesource.md).[emit](sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5459 +Defined in node_modules/@types/node/stream.d.ts:58 **Parameters:** Name | Type | ------ | ------ | -`event` | "error" | -`err` | [Error](notcapable.md#static-error) | +`event` | string | symbol | +`...args` | any[] | **Returns:** *boolean* @@ -577,40 +637,40 @@ ___ ### end -▸ **end**(`cb?`: Function): *void* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5610 +Defined in node_modules/@types/node/stream.d.ts:220 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5611 +Defined in node_modules/@types/node/stream.d.ts:221 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](sparsefilterstream.md).[end](sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5612 +Defined in node_modules/@types/node/stream.d.ts:222 **Parameters:** @@ -618,7 +678,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -630,7 +690,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[eventNames](countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -642,7 +702,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[getMaxListeners](countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -654,7 +714,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[isPaused](sparsefilterstream.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:5430 +Defined in node_modules/@types/node/stream.d.ts:29 **Returns:** *boolean* @@ -666,7 +726,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -684,7 +744,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listeners](countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -696,19 +756,17 @@ Name | Type | ___ -### on - -▸ **on**(`event`: string, `listener`: function): *this* +### off -*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* -Defined in node_modules/@types/node/base.d.ts:5461 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -722,13 +780,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5462 +Defined in node_modules/@types/node/stream.d.ts:60 **Parameters:** @@ -746,7 +808,7 @@ Defined in node_modules/@types/node/base.d.ts:5462 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5463 +Defined in node_modules/@types/node/stream.d.ts:61 **Parameters:** @@ -754,13 +816,13 @@ Defined in node_modules/@types/node/base.d.ts:5463 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -770,7 +832,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5464 +Defined in node_modules/@types/node/stream.d.ts:62 **Parameters:** @@ -788,7 +850,7 @@ Defined in node_modules/@types/node/base.d.ts:5464 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5465 +Defined in node_modules/@types/node/stream.d.ts:63 **Parameters:** @@ -806,7 +868,7 @@ Defined in node_modules/@types/node/base.d.ts:5465 *Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5466 +Defined in node_modules/@types/node/stream.d.ts:64 **Parameters:** @@ -824,21 +886,17 @@ Name | Type | **Returns:** *this* -___ +▸ **on**(`event`: string | symbol, `listener`: function): *this* -### once - -▸ **once**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[on](sparsefilterstream.md#on)* -*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* +*Overrides [SourceSource](sourcesource.md).[on](sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5468 +Defined in node_modules/@types/node/stream.d.ts:65 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -852,13 +910,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5469 +Defined in node_modules/@types/node/stream.d.ts:67 **Parameters:** @@ -876,7 +938,7 @@ Defined in node_modules/@types/node/base.d.ts:5469 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5470 +Defined in node_modules/@types/node/stream.d.ts:68 **Parameters:** @@ -884,13 +946,13 @@ Defined in node_modules/@types/node/base.d.ts:5470 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -900,7 +962,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5471 +Defined in node_modules/@types/node/stream.d.ts:69 **Parameters:** @@ -918,7 +980,7 @@ Defined in node_modules/@types/node/base.d.ts:5471 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5472 +Defined in node_modules/@types/node/stream.d.ts:70 **Parameters:** @@ -936,7 +998,7 @@ Defined in node_modules/@types/node/base.d.ts:5472 *Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5473 +Defined in node_modules/@types/node/stream.d.ts:71 **Parameters:** @@ -954,6 +1016,30 @@ Name | Type | **Returns:** *this* +▸ **once**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[once](sparsefilterstream.md#once)* + +*Overrides [SourceSource](sourcesource.md).[once](sourcesource.md#once)* + +Defined in node_modules/@types/node/stream.d.ts:72 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### pause @@ -962,7 +1048,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[pause](sparsefilterstream.md#pause)* -Defined in node_modules/@types/node/base.d.ts:5428 +Defined in node_modules/@types/node/stream.d.ts:27 **Returns:** *this* @@ -974,7 +1060,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[pipe](countingwritable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:5407 +Defined in node_modules/@types/node/stream.d.ts:5 **Type parameters:** @@ -993,37 +1079,13 @@ ___ ### prependListener -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* - -*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* - -Defined in node_modules/@types/node/base.d.ts:5475 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **prependListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5476 +Defined in node_modules/@types/node/stream.d.ts:74 **Parameters:** @@ -1041,7 +1103,7 @@ Defined in node_modules/@types/node/base.d.ts:5476 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5477 +Defined in node_modules/@types/node/stream.d.ts:75 **Parameters:** @@ -1049,13 +1111,13 @@ Defined in node_modules/@types/node/base.d.ts:5477 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1065,7 +1127,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5478 +Defined in node_modules/@types/node/stream.d.ts:76 **Parameters:** @@ -1083,7 +1145,7 @@ Defined in node_modules/@types/node/base.d.ts:5478 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5479 +Defined in node_modules/@types/node/stream.d.ts:77 **Parameters:** @@ -1101,7 +1163,7 @@ Defined in node_modules/@types/node/base.d.ts:5479 *Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5480 +Defined in node_modules/@types/node/stream.d.ts:78 **Parameters:** @@ -1119,21 +1181,17 @@ Name | Type | **Returns:** *this* -___ +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -### prependOnceListener - -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependListener](sparsefilterstream.md#prependlistener)* -*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](sourcesource.md).[prependListener](sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5482 +Defined in node_modules/@types/node/stream.d.ts:79 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1147,13 +1205,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5483 +Defined in node_modules/@types/node/stream.d.ts:81 **Parameters:** @@ -1171,7 +1233,7 @@ Defined in node_modules/@types/node/base.d.ts:5483 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5484 +Defined in node_modules/@types/node/stream.d.ts:82 **Parameters:** @@ -1179,13 +1241,13 @@ Defined in node_modules/@types/node/base.d.ts:5484 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1195,7 +1257,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5485 +Defined in node_modules/@types/node/stream.d.ts:83 **Parameters:** @@ -1213,7 +1275,7 @@ Defined in node_modules/@types/node/base.d.ts:5485 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5486 +Defined in node_modules/@types/node/stream.d.ts:84 **Parameters:** @@ -1231,7 +1293,7 @@ Defined in node_modules/@types/node/base.d.ts:5486 *Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5487 +Defined in node_modules/@types/node/stream.d.ts:85 **Parameters:** @@ -1249,6 +1311,30 @@ Name | Type | **Returns:** *this* +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[prependOnceListener](sparsefilterstream.md#prependoncelistener)* + +*Overrides [SourceSource](sourcesource.md).[prependOnceListener](sourcesource.md#prependoncelistener)* + +Defined in node_modules/@types/node/stream.d.ts:86 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### push @@ -1257,7 +1343,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[push](sparsefilterstream.md#push)* -Defined in node_modules/@types/node/base.d.ts:5434 +Defined in node_modules/@types/node/stream.d.ts:33 **Parameters:** @@ -1270,13 +1356,31 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`size?`: undefined | number): *any* *Inherited from [SparseFilterStream](sparsefilterstream.md).[read](sparsefilterstream.md#read)* -Defined in node_modules/@types/node/base.d.ts:5426 +Defined in node_modules/@types/node/stream.d.ts:25 **Parameters:** @@ -1294,7 +1398,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[removeAllListeners](countingwritable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -1308,37 +1412,13 @@ ___ ### removeListener -▸ **removeListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* - -*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5489 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5490 +Defined in node_modules/@types/node/stream.d.ts:88 **Parameters:** @@ -1356,7 +1436,7 @@ Defined in node_modules/@types/node/base.d.ts:5490 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5491 +Defined in node_modules/@types/node/stream.d.ts:89 **Parameters:** @@ -1364,13 +1444,13 @@ Defined in node_modules/@types/node/base.d.ts:5491 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](../interfaces/alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1380,7 +1460,7 @@ Name | Type | *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5492 +Defined in node_modules/@types/node/stream.d.ts:90 **Parameters:** @@ -1398,7 +1478,7 @@ Defined in node_modules/@types/node/base.d.ts:5492 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5493 +Defined in node_modules/@types/node/stream.d.ts:91 **Parameters:** @@ -1416,7 +1496,7 @@ Defined in node_modules/@types/node/base.d.ts:5493 *Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5494 +Defined in node_modules/@types/node/stream.d.ts:92 **Parameters:** @@ -1434,6 +1514,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](sparsefilterstream.md).[removeListener](sparsefilterstream.md#removelistener)* + +*Overrides [SourceSource](sourcesource.md).[removeListener](sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:93 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### resume @@ -1442,7 +1546,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[resume](sparsefilterstream.md#resume)* -Defined in node_modules/@types/node/base.d.ts:5429 +Defined in node_modules/@types/node/stream.d.ts:28 **Returns:** *this* @@ -1454,7 +1558,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setDefaultEncoding](sparsefilterstream.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5609 +Defined in node_modules/@types/node/stream.d.ts:219 **Parameters:** @@ -1472,7 +1576,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[setEncoding](sparsefilterstream.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:5427 +Defined in node_modules/@types/node/stream.d.ts:26 **Parameters:** @@ -1490,7 +1594,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[setMaxListeners](countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1508,7 +1612,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[uncork](sparsefilterstream.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5614 +Defined in node_modules/@types/node/stream.d.ts:224 **Returns:** *void* @@ -1516,21 +1620,17 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: NodeJS.WritableStream): *this* *Inherited from [SparseFilterStream](sparsefilterstream.md).[unpipe](sparsefilterstream.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:5431 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/stream.d.ts:30 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | NodeJS.WritableStream | **Returns:** *this* @@ -1542,7 +1642,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[unshift](sparsefilterstream.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:5432 +Defined in node_modules/@types/node/stream.d.ts:31 **Parameters:** @@ -1560,7 +1660,7 @@ ___ *Inherited from [SparseFilterStream](sparsefilterstream.md).[wrap](sparsefilterstream.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:5433 +Defined in node_modules/@types/node/stream.d.ts:32 **Parameters:** @@ -1574,26 +1674,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5607 +Defined in node_modules/@types/node/stream.d.ts:217 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](sparsefilterstream.md).[write](sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5608 +Defined in node_modules/@types/node/stream.d.ts:218 **Parameters:** @@ -1601,7 +1701,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1613,7 +1713,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/streamverifier.md b/doc/classes/streamverifier.md index 1893e6d4..80e7cebf 100644 --- a/doc/classes/streamverifier.md +++ b/doc/classes/streamverifier.md @@ -30,10 +30,12 @@ * [handleEventsAndPipe](streamverifier.md#protected-handleeventsandpipe) * [listenerCount](streamverifier.md#listenercount) * [listeners](streamverifier.md#listeners) +* [off](streamverifier.md#off) * [on](streamverifier.md#on) * [once](streamverifier.md#once) * [prependListener](streamverifier.md#prependlistener) * [prependOnceListener](streamverifier.md#prependoncelistener) +* [rawListeners](streamverifier.md#rawlisteners) * [removeAllListeners](streamverifier.md#removealllisteners) * [removeListener](streamverifier.md#removelistener) * [run](streamverifier.md#run) @@ -50,7 +52,7 @@ \+ **new StreamVerifier**(`source`: [SourceDestination](sourcedestination.md), `checksum`: string, `size`: number): *[StreamVerifier](streamverifier.md)* -*Defined in [lib/source-destination/source-destination.ts:152](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L152)* +*Defined in [lib/source-destination/source-destination.ts:175](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L175)* **Parameters:** @@ -68,7 +70,7 @@ Name | Type | • **checksum**: *string* -*Defined in [lib/source-destination/source-destination.ts:155](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L155)* +*Defined in [lib/source-destination/source-destination.ts:178](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L178)* ___ @@ -76,7 +78,7 @@ ___ • **size**: *number* -*Defined in [lib/source-destination/source-destination.ts:156](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L156)* +*Defined in [lib/source-destination/source-destination.ts:179](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L179)* ___ @@ -84,7 +86,7 @@ ___ • **source**: *[SourceDestination](sourcedestination.md)* -*Defined in [lib/source-destination/source-destination.ts:154](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L154)* +*Defined in [lib/source-destination/source-destination.ts:177](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L177)* ___ @@ -94,7 +96,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -106,7 +108,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -134,7 +136,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -155,7 +157,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -169,7 +171,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -181,7 +183,7 @@ ___ *Inherited from [Verifier](verifier.md).[handleEventsAndPipe](verifier.md#protected-handleeventsandpipe)* -*Defined in [lib/source-destination/source-destination.ts:134](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L134)* +*Defined in [lib/source-destination/source-destination.ts:157](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L157)* **Parameters:** @@ -202,7 +204,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -222,7 +224,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -234,6 +236,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -242,7 +272,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -270,7 +300,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -298,7 +328,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -326,7 +356,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -346,6 +376,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -354,7 +404,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -374,7 +424,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -400,7 +450,7 @@ ___ *Overrides [Verifier](verifier.md).[run](verifier.md#abstract-run)* -*Defined in [lib/source-destination/source-destination.ts:161](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L161)* +*Defined in [lib/source-destination/source-destination.ts:184](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L184)* **Returns:** *Promise‹void›* @@ -414,7 +464,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -432,7 +482,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -451,22 +503,22 @@ Name | Type | *Inherited from [Verifier](verifier.md).[progress](verifier.md#progress)* -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### bytes • **bytes**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### position • **position**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### speed • **speed**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* diff --git a/doc/classes/streamzipsource.md b/doc/classes/streamzipsource.md index 316bc2a7..8a3314dc 100644 --- a/doc/classes/streamzipsource.md +++ b/doc/classes/streamzipsource.md @@ -53,11 +53,13 @@ * [getPartitionTable](streamzipsource.md#getpartitiontable) * [listenerCount](streamzipsource.md#listenercount) * [listeners](streamzipsource.md#listeners) +* [off](streamzipsource.md#off) * [on](streamzipsource.md#on) * [once](streamzipsource.md#once) * [open](streamzipsource.md#open) * [prependListener](streamzipsource.md#prependlistener) * [prependOnceListener](streamzipsource.md#prependoncelistener) +* [rawListeners](streamzipsource.md#rawlisteners) * [read](streamzipsource.md#read) * [removeAllListeners](streamzipsource.md#removealllisteners) * [removeListener](streamzipsource.md#removelistener) @@ -74,7 +76,7 @@ *Overrides [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/zip.ts:75](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L75)* +*Defined in [lib/source-destination/zip.ts:75](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L75)* **Parameters:** @@ -98,7 +100,7 @@ Name | Type | • **entry**? : *ZipStreamEntry* -*Defined in [lib/source-destination/zip.ts:75](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L75)* +*Defined in [lib/source-destination/zip.ts:75](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L75)* ___ @@ -106,7 +108,7 @@ ___ • **match**: *function* -*Defined in [lib/source-destination/zip.ts:79](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L79)* +*Defined in [lib/source-destination/zip.ts:79](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L79)* #### Type declaration: @@ -126,7 +128,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -136,7 +138,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -157,7 +159,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -167,7 +169,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ___ @@ -177,7 +179,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -189,7 +191,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L30)* +*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L30)* **Returns:** *Promise‹void›* @@ -201,7 +203,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/zip.ts:122](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L122)* +*Defined in [lib/source-destination/zip.ts:122](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L122)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -215,7 +217,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L26)* +*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L26)* **Returns:** *Promise‹void›* @@ -229,7 +231,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -255,7 +257,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/zip.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L84)* +*Defined in [lib/source-destination/zip.ts:84](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L84)* **Returns:** *Promise‹boolean›* @@ -267,7 +269,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -279,7 +281,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -291,7 +293,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -303,7 +305,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -315,7 +317,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -327,7 +329,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -339,7 +341,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/zip.ts:106](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L106)* +*Defined in [lib/source-destination/zip.ts:106](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L106)* **Parameters:** @@ -360,7 +362,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -378,7 +380,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -398,7 +400,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -417,7 +419,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -439,7 +441,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -460,7 +462,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -472,7 +474,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -484,7 +486,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -494,7 +496,7 @@ ___ ▸ **getEntry**(): *Promise‹ZipStreamEntry›* -*Defined in [lib/source-destination/zip.ts:88](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L88)* +*Defined in [lib/source-destination/zip.ts:88](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L88)* **Returns:** *Promise‹ZipStreamEntry›* @@ -506,7 +508,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -520,7 +522,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -532,7 +534,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -544,7 +546,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -558,7 +560,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -578,7 +580,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -590,6 +592,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -598,7 +628,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -626,7 +656,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -652,7 +682,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -666,7 +696,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -694,7 +724,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -714,13 +744,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -743,7 +793,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -763,7 +813,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -791,7 +841,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -809,7 +859,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -830,7 +880,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -849,7 +901,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/usbbootdeviceadapter.md b/doc/classes/usbbootdeviceadapter.md index 8d9eef13..7f542380 100644 --- a/doc/classes/usbbootdeviceadapter.md +++ b/doc/classes/usbbootdeviceadapter.md @@ -28,12 +28,14 @@ * [getMaxListeners](usbbootdeviceadapter.md#getmaxlisteners) * [listenerCount](usbbootdeviceadapter.md#listenercount) * [listeners](usbbootdeviceadapter.md#listeners) +* [off](usbbootdeviceadapter.md#off) * [on](usbbootdeviceadapter.md#on) * [onAttach](usbbootdeviceadapter.md#private-onattach) * [onDetach](usbbootdeviceadapter.md#private-ondetach) * [once](usbbootdeviceadapter.md#once) * [prependListener](usbbootdeviceadapter.md#prependlistener) * [prependOnceListener](usbbootdeviceadapter.md#prependoncelistener) +* [rawListeners](usbbootdeviceadapter.md#rawlisteners) * [removeAllListeners](usbbootdeviceadapter.md#removealllisteners) * [removeListener](usbbootdeviceadapter.md#removelistener) * [setMaxListeners](usbbootdeviceadapter.md#setmaxlisteners) @@ -47,7 +49,7 @@ \+ **new UsbbootDeviceAdapter**(): *[UsbbootDeviceAdapter](usbbootdeviceadapter.md)* -*Defined in [lib/scanner/adapters/usbboot.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/usbboot.ts#L28)* +*Defined in [lib/scanner/adapters/usbboot.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/usbboot.ts#L28)* **Returns:** *[UsbbootDeviceAdapter](usbbootdeviceadapter.md)* @@ -57,7 +59,7 @@ • **drives**: *Map‹UsbbootDevice, [UsbbootDrive](usbbootdrive.md)›* = new Map() -*Defined in [lib/scanner/adapters/usbboot.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/usbboot.ts#L27)* +*Defined in [lib/scanner/adapters/usbboot.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/usbboot.ts#L27)* ___ @@ -65,7 +67,7 @@ ___ • **scanner**: *UsbbootScannerType* -*Defined in [lib/scanner/adapters/usbboot.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/usbboot.ts#L28)* +*Defined in [lib/scanner/adapters/usbboot.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/usbboot.ts#L28)* ___ @@ -75,7 +77,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -87,7 +89,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -115,7 +117,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -136,7 +138,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -150,7 +152,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -164,7 +166,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -184,7 +186,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -196,6 +198,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -204,7 +234,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -228,7 +258,7 @@ ___ ▸ **onAttach**(`device`: UsbbootDevice): *void* -*Defined in [lib/scanner/adapters/usbboot.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/usbboot.ts#L53)* +*Defined in [lib/scanner/adapters/usbboot.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/usbboot.ts#L53)* **Parameters:** @@ -244,7 +274,7 @@ ___ ▸ **onDetach**(`device`: UsbbootDevice): *void* -*Defined in [lib/scanner/adapters/usbboot.ts:62](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/usbboot.ts#L62)* +*Defined in [lib/scanner/adapters/usbboot.ts:62](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/usbboot.ts#L62)* **Parameters:** @@ -264,7 +294,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -292,7 +322,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -320,7 +350,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -340,6 +370,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -348,7 +398,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -368,7 +418,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -396,7 +446,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -414,7 +464,7 @@ ___ *Overrides [Adapter](adapter.md).[start](adapter.md#abstract-start)* -*Defined in [lib/scanner/adapters/usbboot.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/usbboot.ts#L45)* +*Defined in [lib/scanner/adapters/usbboot.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/usbboot.ts#L45)* **Returns:** *void* @@ -426,7 +476,7 @@ ___ *Overrides [Adapter](adapter.md).[stop](adapter.md#abstract-stop)* -*Defined in [lib/scanner/adapters/usbboot.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/usbboot.ts#L49)* +*Defined in [lib/scanner/adapters/usbboot.ts:49](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/usbboot.ts#L49)* **Returns:** *void* @@ -438,7 +488,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/classes/usbbootdrive.md b/doc/classes/usbbootdrive.md index a36a2d49..8af8a7d5 100644 --- a/doc/classes/usbbootdrive.md +++ b/doc/classes/usbbootdrive.md @@ -65,11 +65,13 @@ * [getPartitionTable](usbbootdrive.md#getpartitiontable) * [listenerCount](usbbootdrive.md#listenercount) * [listeners](usbbootdrive.md#listeners) +* [off](usbbootdrive.md#off) * [on](usbbootdrive.md#on) * [once](usbbootdrive.md#once) * [open](usbbootdrive.md#open) * [prependListener](usbbootdrive.md#prependlistener) * [prependOnceListener](usbbootdrive.md#prependoncelistener) +* [rawListeners](usbbootdrive.md#rawlisteners) * [read](usbbootdrive.md#read) * [removeAllListeners](usbbootdrive.md#removealllisteners) * [removeListener](usbbootdrive.md#removelistener) @@ -84,7 +86,7 @@ \+ **new UsbbootDrive**(`usbDevice`: UsbbootDevice): *[UsbbootDrive](usbbootdrive.md)* -*Defined in [lib/source-destination/usbboot.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L35)* +*Defined in [lib/source-destination/usbboot.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L35)* **Parameters:** @@ -102,7 +104,7 @@ Name | Type | *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[description](../interfaces/adaptersourcedestination.md#description)* -*Defined in [lib/source-destination/usbboot.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L30)* +*Defined in [lib/source-destination/usbboot.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L30)* ___ @@ -112,7 +114,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[device](../interfaces/adaptersourcedestination.md#device)* -*Defined in [lib/source-destination/usbboot.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L26)* +*Defined in [lib/source-destination/usbboot.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L26)* ___ @@ -122,7 +124,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[devicePath](../interfaces/adaptersourcedestination.md#devicepath)* -*Defined in [lib/source-destination/usbboot.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L27)* +*Defined in [lib/source-destination/usbboot.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L27)* ___ @@ -130,7 +132,7 @@ ___ • **disabled**: *boolean* = true -*Defined in [lib/source-destination/usbboot.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L33)* +*Defined in [lib/source-destination/usbboot.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L33)* ___ @@ -138,7 +140,7 @@ ___ • **displayName**: *string* = "Initializing device" -*Defined in [lib/source-destination/usbboot.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L25)* +*Defined in [lib/source-destination/usbboot.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L25)* ___ @@ -148,7 +150,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[emitsProgress](../interfaces/adaptersourcedestination.md#emitsprogress)* -*Defined in [lib/source-destination/usbboot.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L35)* +*Defined in [lib/source-destination/usbboot.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L35)* ___ @@ -156,7 +158,7 @@ ___ • **icon**: *string* = "loading" -*Defined in [lib/source-destination/usbboot.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L28)* +*Defined in [lib/source-destination/usbboot.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L28)* ___ @@ -164,7 +166,7 @@ ___ • **isReadOnly**: *boolean* = false -*Defined in [lib/source-destination/usbboot.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L32)* +*Defined in [lib/source-destination/usbboot.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L32)* ___ @@ -174,7 +176,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[isSystem](../interfaces/adaptersourcedestination.md#issystem)* -*Defined in [lib/source-destination/usbboot.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L29)* +*Defined in [lib/source-destination/usbboot.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L29)* ___ @@ -184,7 +186,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[mountpoints](../interfaces/adaptersourcedestination.md#mountpoints)* -*Defined in [lib/source-destination/usbboot.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L31)* +*Defined in [lib/source-destination/usbboot.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L31)* ___ @@ -194,7 +196,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[raw](../interfaces/adaptersourcedestination.md#raw)* -*Defined in [lib/source-destination/usbboot.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L24)* +*Defined in [lib/source-destination/usbboot.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L24)* ___ @@ -204,7 +206,7 @@ ___ *Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md).[size](../interfaces/adaptersourcedestination.md#size)* -*Defined in [lib/source-destination/usbboot.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L34)* +*Defined in [lib/source-destination/usbboot.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L34)* ___ @@ -212,7 +214,7 @@ ___ • **usbDevice**: *UsbbootDevice* -*Defined in [lib/source-destination/usbboot.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/usbboot.ts#L37)* +*Defined in [lib/source-destination/usbboot.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/usbboot.ts#L37)* ___ @@ -224,7 +226,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -247,7 +249,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -259,7 +261,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Methods @@ -271,7 +273,7 @@ ___ *Inherited from [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-destination.ts:379](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L379)* +*Defined in [lib/source-destination/source-destination.ts:402](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L402)* **Returns:** *Promise‹void›* @@ -285,7 +287,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L311)* +*Defined in [lib/source-destination/source-destination.ts:334](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L334)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -299,7 +301,7 @@ ___ *Inherited from [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-destination.ts:375](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L375)* +*Defined in [lib/source-destination/source-destination.ts:398](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L398)* **Returns:** *Promise‹void›* @@ -313,7 +315,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -341,7 +343,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/source-destination.ts:288](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L288)* +*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L311)* **Returns:** *Promise‹boolean›* @@ -355,7 +357,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -369,7 +371,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -383,7 +385,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -397,7 +399,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -411,7 +413,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -425,7 +427,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -439,7 +441,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/source-destination.ts:333](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L333)* +*Defined in [lib/source-destination/source-destination.ts:356](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L356)* **Parameters:** @@ -459,7 +461,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -477,7 +479,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -499,7 +501,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -518,7 +520,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -542,7 +544,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -565,7 +567,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -579,7 +581,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -593,7 +595,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -607,7 +609,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -623,7 +625,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -637,7 +639,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -651,7 +653,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -667,7 +669,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -689,7 +691,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -701,6 +703,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -709,7 +739,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -737,7 +767,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -765,7 +795,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -779,7 +809,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -807,7 +837,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -827,6 +857,28 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Implementation of [AdapterSourceDestination](../interfaces/adaptersourcedestination.md)* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* @@ -835,7 +887,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -860,7 +912,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -880,7 +932,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -910,7 +962,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -930,7 +982,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -953,7 +1005,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -974,7 +1028,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/verificationerror.md b/doc/classes/verificationerror.md index a57fdebd..0d2cfe88 100644 --- a/doc/classes/verificationerror.md +++ b/doc/classes/verificationerror.md @@ -28,7 +28,7 @@ • **code**: *string* = "EVALIDATION" -*Defined in [lib/errors.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/errors.ts#L24)* +*Defined in [lib/errors.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/errors.ts#L24)* ___ diff --git a/doc/classes/verifier.md b/doc/classes/verifier.md index dddb197f..375f87f3 100644 --- a/doc/classes/verifier.md +++ b/doc/classes/verifier.md @@ -29,10 +29,12 @@ * [handleEventsAndPipe](verifier.md#protected-handleeventsandpipe) * [listenerCount](verifier.md#listenercount) * [listeners](verifier.md#listeners) +* [off](verifier.md#off) * [on](verifier.md#on) * [once](verifier.md#once) * [prependListener](verifier.md#prependlistener) * [prependOnceListener](verifier.md#prependoncelistener) +* [rawListeners](verifier.md#rawlisteners) * [removeAllListeners](verifier.md#removealllisteners) * [removeListener](verifier.md#removelistener) * [run](verifier.md#abstract-run) @@ -51,7 +53,7 @@ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods @@ -63,7 +65,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -91,7 +93,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -112,7 +114,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -126,7 +128,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -136,7 +138,7 @@ ___ ▸ **handleEventsAndPipe**(`stream`: ReadableStream, `meter`: WritableStream): *void* -*Defined in [lib/source-destination/source-destination.ts:134](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L134)* +*Defined in [lib/source-destination/source-destination.ts:157](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L157)* **Parameters:** @@ -157,7 +159,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -177,7 +179,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -189,6 +191,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -197,7 +227,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -225,7 +255,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -253,7 +283,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -281,7 +311,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -301,6 +331,26 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* @@ -309,7 +359,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -329,7 +379,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -353,7 +403,7 @@ ___ ▸ **run**(): *Promise‹void›* -*Defined in [lib/source-destination/source-destination.ts:132](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L132)* +*Defined in [lib/source-destination/source-destination.ts:155](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L155)* **Returns:** *Promise‹void›* @@ -367,7 +417,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -385,7 +435,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -402,22 +454,22 @@ Name | Type | ### ▪ **progress**: *object* -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### bytes • **bytes**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### position • **position**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* ### speed • **speed**: *number* = 0 -*Defined in [lib/source-destination/source-destination.ts:130](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L130)* +*Defined in [lib/source-destination/source-destination.ts:153](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L153)* diff --git a/doc/classes/xzsource.md b/doc/classes/xzsource.md index 366d01c1..2f2461ee 100644 --- a/doc/classes/xzsource.md +++ b/doc/classes/xzsource.md @@ -53,11 +53,13 @@ * [getSize](xzsource.md#protected-getsize) * [listenerCount](xzsource.md#listenercount) * [listeners](xzsource.md#listeners) +* [off](xzsource.md#off) * [on](xzsource.md#on) * [once](xzsource.md#once) * [open](xzsource.md#open) * [prependListener](xzsource.md#prependlistener) * [prependOnceListener](xzsource.md#prependoncelistener) +* [rawListeners](xzsource.md#rawlisteners) * [read](xzsource.md#read) * [removeAllListeners](xzsource.md#removealllisteners) * [removeListener](xzsource.md#removelistener) @@ -74,7 +76,7 @@ *Inherited from [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* **Parameters:** @@ -92,7 +94,7 @@ Name | Type | *Inherited from [CompressedSource](compressedsource.md).[isSizeEstimated](compressedsource.md#protected-issizeestimated)* -*Defined in [lib/source-destination/compressed-source.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L45)* +*Defined in [lib/source-destination/compressed-source.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L45)* ___ @@ -102,7 +104,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -112,7 +114,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -133,7 +135,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -143,7 +145,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/xz.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/xz.ts#L27)* +*Defined in [lib/source-destination/xz.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/xz.ts#L27)* ___ @@ -153,7 +155,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -165,7 +167,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L30)* +*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L30)* **Returns:** *Promise‹void›* @@ -179,7 +181,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/compressed-source.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L85)* +*Defined in [lib/source-destination/compressed-source.ts:85](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L85)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -193,7 +195,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L26)* +*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L26)* **Returns:** *Promise‹void›* @@ -207,7 +209,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -235,7 +237,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/compressed-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L51)* +*Defined in [lib/source-destination/compressed-source.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L51)* **Returns:** *Promise‹boolean›* @@ -247,7 +249,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -259,7 +261,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -271,7 +273,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -283,7 +285,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -295,7 +297,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -307,7 +309,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -321,7 +323,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/compressed-source.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L55)* +*Defined in [lib/source-destination/compressed-source.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L55)* **Parameters:** @@ -343,7 +345,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -361,7 +363,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -381,7 +383,7 @@ ___ *Overrides [CompressedSource](compressedsource.md).[createTransform](compressedsource.md#protected-abstract-createtransform)* -*Defined in [lib/source-destination/xz.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/xz.ts#L29)* +*Defined in [lib/source-destination/xz.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/xz.ts#L29)* **Returns:** *Transform* @@ -393,7 +395,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -412,7 +414,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -434,7 +436,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -455,7 +457,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -467,7 +469,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -479,7 +481,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -491,7 +493,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -505,7 +507,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -517,7 +519,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -529,7 +531,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -541,7 +543,7 @@ ___ *Overrides [CompressedSource](compressedsource.md).[getSize](compressedsource.md#protected-getsize)* -*Defined in [lib/source-destination/xz.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/xz.ts#L33)* +*Defined in [lib/source-destination/xz.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/xz.ts#L33)* **Returns:** *Promise‹number | undefined›* @@ -555,7 +557,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -575,7 +577,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -587,6 +589,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -595,7 +625,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -623,7 +653,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -649,7 +679,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -663,7 +693,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -691,7 +721,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -711,13 +741,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -740,7 +790,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -760,7 +810,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -788,7 +838,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -806,7 +856,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -827,7 +877,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -846,7 +898,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/classes/zipsource.md b/doc/classes/zipsource.md index e9015b3d..dc452ce4 100644 --- a/doc/classes/zipsource.md +++ b/doc/classes/zipsource.md @@ -54,12 +54,14 @@ * [getPartitionTable](zipsource.md#getpartitiontable) * [listenerCount](zipsource.md#listenercount) * [listeners](zipsource.md#listeners) +* [off](zipsource.md#off) * [on](zipsource.md#on) * [once](zipsource.md#once) * [open](zipsource.md#open) * [prepare](zipsource.md#private-prepare) * [prependListener](zipsource.md#prependlistener) * [prependOnceListener](zipsource.md#prependoncelistener) +* [rawListeners](zipsource.md#rawlisteners) * [read](zipsource.md#read) * [removeAllListeners](zipsource.md#removealllisteners) * [removeListener](zipsource.md#removelistener) @@ -76,7 +78,7 @@ *Overrides [SourceSource](sourcesource.md).[constructor](sourcesource.md#constructor)* -*Defined in [lib/source-destination/zip.ts:365](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L365)* +*Defined in [lib/source-destination/zip.ts:365](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L365)* **Parameters:** @@ -102,7 +104,7 @@ Name | Type | • **implementation**: *[RandomAccessZipSource](randomaccesszipsource.md) | [StreamZipSource](streamzipsource.md)* -*Defined in [lib/source-destination/zip.ts:365](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L365)* +*Defined in [lib/source-destination/zip.ts:365](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L365)* ___ @@ -110,7 +112,7 @@ ___ • **match**: *function* -*Defined in [lib/source-destination/zip.ts:370](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L370)* +*Defined in [lib/source-destination/zip.ts:370](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L370)* #### Type declaration: @@ -128,7 +130,7 @@ ___ • **preferStreamSource**: *boolean* -*Defined in [lib/source-destination/zip.ts:369](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L369)* +*Defined in [lib/source-destination/zip.ts:369](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L369)* ___ @@ -136,7 +138,7 @@ ___ • **ready**: *Promise‹void›* -*Defined in [lib/source-destination/zip.ts:364](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L364)* +*Defined in [lib/source-destination/zip.ts:364](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L364)* ___ @@ -146,7 +148,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[source](sourcesource.md#protected-source)* -*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L22)* +*Defined in [lib/source-destination/source-source.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L22)* ___ @@ -156,7 +158,7 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[defaultMaxListeners](countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -177,7 +179,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[imageExtensions](sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -187,7 +189,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[mimetype](sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/zip.ts:363](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L363)* +*Defined in [lib/source-destination/zip.ts:363](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L363)* ___ @@ -197,7 +199,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[requiresRandomReadableSource](sourcesource.md#static-requiresrandomreadablesource)* -*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L20)* +*Defined in [lib/source-destination/source-source.ts:20](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L20)* ## Methods @@ -209,7 +211,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_close](sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L30)* +*Defined in [lib/source-destination/source-source.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L30)* **Returns:** *Promise‹void›* @@ -221,7 +223,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[_getMetadata](sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/zip.ts:428](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L428)* +*Defined in [lib/source-destination/zip.ts:428](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L428)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -235,7 +237,7 @@ ___ *Overrides [SourceDestination](sourcedestination.md).[_open](sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-source.ts#L26)* +*Defined in [lib/source-destination/source-source.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-source.ts#L26)* **Returns:** *Promise‹void›* @@ -249,7 +251,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[addListener](../interfaces/sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -275,7 +277,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateReadStream](sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/zip.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L384)* +*Defined in [lib/source-destination/zip.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L384)* **Returns:** *Promise‹boolean›* @@ -287,7 +289,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[canCreateSparseReadStream](sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/zip.ts:394](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L394)* +*Defined in [lib/source-destination/zip.ts:394](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L394)* **Returns:** *Promise‹boolean›* @@ -299,7 +301,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateSparseWriteStream](sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -311,7 +313,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canCreateWriteStream](sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -323,7 +325,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canRead](sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -335,7 +337,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[canWrite](sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -347,7 +349,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[close](sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -359,7 +361,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createReadStream](sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/zip.ts:399](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L399)* +*Defined in [lib/source-destination/zip.ts:399](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L399)* **Parameters:** @@ -383,7 +385,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[createSparseReadStream](sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/zip.ts:415](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L415)* +*Defined in [lib/source-destination/zip.ts:415](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L415)* **Parameters:** @@ -405,7 +407,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createSparseWriteStream](sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -425,7 +427,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createVerifier](sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -444,7 +446,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[createWriteStream](sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -466,7 +468,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[emit](../interfaces/sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -487,7 +489,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[eventNames](../interfaces/sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -499,7 +501,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getAlignment](sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -511,7 +513,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getBlocks](sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](../interfaces/blockswithchecksum.md)[]›* @@ -523,7 +525,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getInnerSource](sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](sourcedestination.md)›* @@ -537,7 +539,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[getMaxListeners](../interfaces/sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -549,7 +551,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getMetadata](sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](../interfaces/metadata.md)›* @@ -561,7 +563,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[getPartitionTable](sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -575,7 +577,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listenerCount](../interfaces/sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -595,7 +597,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[listeners](../interfaces/sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -607,6 +609,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](countingwritable.md).[off](countingwritable.md#off)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[off](../interfaces/sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -615,7 +645,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[on](../interfaces/sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -643,7 +673,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[once](../interfaces/sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -669,7 +699,7 @@ ___ *Overrides [SourceSource](sourcesource.md).[open](sourcesource.md#open)* -*Defined in [lib/source-destination/zip.ts:389](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L389)* +*Defined in [lib/source-destination/zip.ts:389](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L389)* **Returns:** *Promise‹void›* @@ -679,7 +709,7 @@ ___ ▸ **prepare**(): *Promise‹void›* -*Defined in [lib/source-destination/zip.ts:376](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/zip.ts#L376)* +*Defined in [lib/source-destination/zip.ts:376](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/zip.ts#L376)* **Returns:** *Promise‹void›* @@ -693,7 +723,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependListener](../interfaces/sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -721,7 +751,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[prependOnceListener](../interfaces/sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -741,13 +771,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](countingwritable.md).[rawListeners](countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](../interfaces/sparsereadable.md).[rawListeners](../interfaces/sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](../interfaces/alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](sourcesource.md).[read](sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -770,7 +820,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeAllListeners](../interfaces/sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -790,7 +840,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[removeListener](../interfaces/sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -818,7 +868,7 @@ ___ *Overrides [SparseReadable](../interfaces/sparsereadable.md).[setMaxListeners](../interfaces/sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -836,7 +886,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[write](sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -857,7 +907,9 @@ ___ *Inherited from [CountingWritable](countingwritable.md).[listenerCount](countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -876,7 +928,7 @@ ___ *Inherited from [SourceSource](sourcesource.md).[register](sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/interfaces/adaptersourcedestination.md b/doc/interfaces/adaptersourcedestination.md index 6207eda5..71700e11 100644 --- a/doc/interfaces/adaptersourcedestination.md +++ b/doc/interfaces/adaptersourcedestination.md @@ -58,11 +58,13 @@ * [getPartitionTable](adaptersourcedestination.md#getpartitiontable) * [listenerCount](adaptersourcedestination.md#listenercount) * [listeners](adaptersourcedestination.md#listeners) +* [off](adaptersourcedestination.md#off) * [on](adaptersourcedestination.md#on) * [once](adaptersourcedestination.md#once) * [open](adaptersourcedestination.md#open) * [prependListener](adaptersourcedestination.md#prependlistener) * [prependOnceListener](adaptersourcedestination.md#prependoncelistener) +* [rawListeners](adaptersourcedestination.md#rawlisteners) * [read](adaptersourcedestination.md#read) * [removeAllListeners](adaptersourcedestination.md#removealllisteners) * [removeListener](adaptersourcedestination.md#removelistener) @@ -77,7 +79,7 @@ • **description**: *string* -*Defined in [lib/scanner/adapters/adapter.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L27)* +*Defined in [lib/scanner/adapters/adapter.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L27)* ___ @@ -85,7 +87,7 @@ ___ • **device**: *string | null* -*Defined in [lib/scanner/adapters/adapter.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L24)* +*Defined in [lib/scanner/adapters/adapter.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L24)* ___ @@ -93,7 +95,7 @@ ___ • **devicePath**: *string | null* -*Defined in [lib/scanner/adapters/adapter.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L25)* +*Defined in [lib/scanner/adapters/adapter.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L25)* ___ @@ -101,7 +103,7 @@ ___ • **emitsProgress**: *boolean* -*Defined in [lib/scanner/adapters/adapter.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L30)* +*Defined in [lib/scanner/adapters/adapter.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L30)* ___ @@ -109,7 +111,7 @@ ___ • **isSystem**: *boolean* -*Defined in [lib/scanner/adapters/adapter.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L26)* +*Defined in [lib/scanner/adapters/adapter.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L26)* ___ @@ -117,7 +119,7 @@ ___ • **mountpoints**: *Array‹object›* -*Defined in [lib/scanner/adapters/adapter.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L28)* +*Defined in [lib/scanner/adapters/adapter.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L28)* ___ @@ -125,7 +127,7 @@ ___ • **raw**: *string | null* -*Defined in [lib/scanner/adapters/adapter.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L23)* +*Defined in [lib/scanner/adapters/adapter.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L23)* ___ @@ -133,7 +135,7 @@ ___ • **size**: *number | null* -*Defined in [lib/scanner/adapters/adapter.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/adapter.ts#L29)* +*Defined in [lib/scanner/adapters/adapter.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/adapter.ts#L29)* ___ @@ -143,7 +145,7 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[defaultMaxListeners](../classes/countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ___ @@ -164,7 +166,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[imageExtensions](../classes/sourcesource.md#static-imageextensions)* -*Defined in [lib/source-destination/source-destination.ts:252](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L252)* +*Defined in [lib/source-destination/source-destination.ts:275](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L275)* ___ @@ -174,7 +176,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[mimetype](../classes/sourcesource.md#static-optional-mimetype)* -*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L264)* +*Defined in [lib/source-destination/source-destination.ts:287](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L287)* ## Methods @@ -184,7 +186,7 @@ ___ *Inherited from [SourceDestination](../classes/sourcedestination.md).[_close](../classes/sourcedestination.md#protected-_close)* -*Defined in [lib/source-destination/source-destination.ts:379](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L379)* +*Defined in [lib/source-destination/source-destination.ts:402](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L402)* **Returns:** *Promise‹void›* @@ -196,7 +198,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[_getMetadata](../classes/sourcesource.md#protected-_getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L311)* +*Defined in [lib/source-destination/source-destination.ts:334](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L334)* **Returns:** *Promise‹[Metadata](metadata.md)›* @@ -208,7 +210,7 @@ ___ *Inherited from [SourceDestination](../classes/sourcedestination.md).[_open](../classes/sourcedestination.md#protected-_open)* -*Defined in [lib/source-destination/source-destination.ts:375](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L375)* +*Defined in [lib/source-destination/source-destination.ts:398](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L398)* **Returns:** *Promise‹void›* @@ -222,7 +224,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[addListener](sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:898 +Defined in node_modules/@types/node/events.d.ts:20 **Parameters:** @@ -248,7 +250,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[canCreateReadStream](../classes/sourcesource.md#cancreatereadstream)* -*Defined in [lib/source-destination/source-destination.ts:288](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L288)* +*Defined in [lib/source-destination/source-destination.ts:311](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L311)* **Returns:** *Promise‹boolean›* @@ -260,7 +262,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[canCreateSparseReadStream](../classes/sourcesource.md#cancreatesparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:292](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L292)* +*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L315)* **Returns:** *Promise‹boolean›* @@ -272,7 +274,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[canCreateSparseWriteStream](../classes/sourcesource.md#cancreatesparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:300](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L300)* +*Defined in [lib/source-destination/source-destination.ts:323](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L323)* **Returns:** *Promise‹boolean›* @@ -284,7 +286,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[canCreateWriteStream](../classes/sourcesource.md#cancreatewritestream)* -*Defined in [lib/source-destination/source-destination.ts:296](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L296)* +*Defined in [lib/source-destination/source-destination.ts:319](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L319)* **Returns:** *Promise‹boolean›* @@ -296,7 +298,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[canRead](../classes/sourcesource.md#canread)* -*Defined in [lib/source-destination/source-destination.ts:280](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L280)* +*Defined in [lib/source-destination/source-destination.ts:303](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L303)* **Returns:** *Promise‹boolean›* @@ -308,7 +310,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[canWrite](../classes/sourcesource.md#canwrite)* -*Defined in [lib/source-destination/source-destination.ts:284](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L284)* +*Defined in [lib/source-destination/source-destination.ts:307](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L307)* **Returns:** *Promise‹boolean›* @@ -320,7 +322,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[close](../classes/sourcesource.md#close)* -*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L368)* +*Defined in [lib/source-destination/source-destination.ts:391](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L391)* **Returns:** *Promise‹void›* @@ -332,7 +334,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[createReadStream](../classes/sourcesource.md#createreadstream)* -*Defined in [lib/source-destination/source-destination.ts:333](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L333)* +*Defined in [lib/source-destination/source-destination.ts:356](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L356)* **Parameters:** @@ -350,7 +352,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[createSparseReadStream](../classes/sourcesource.md#createsparsereadstream)* -*Defined in [lib/source-destination/source-destination.ts:339](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L339)* +*Defined in [lib/source-destination/source-destination.ts:362](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L362)* **Parameters:** @@ -368,7 +370,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[createSparseWriteStream](../classes/sourcesource.md#createsparsewritestream)* -*Defined in [lib/source-destination/source-destination.ts:355](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L355)* +*Defined in [lib/source-destination/source-destination.ts:378](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L378)* **Parameters:** @@ -388,7 +390,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[createVerifier](../classes/sourcesource.md#createverifier)* -*Defined in [lib/source-destination/source-destination.ts:383](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L383)* +*Defined in [lib/source-destination/source-destination.ts:406](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L406)* **Parameters:** @@ -407,7 +409,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[createWriteStream](../classes/sourcesource.md#createwritestream)* -*Defined in [lib/source-destination/source-destination.ts:349](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L349)* +*Defined in [lib/source-destination/source-destination.ts:372](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L372)* **Parameters:** @@ -429,7 +431,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[emit](sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:908 +Defined in node_modules/@types/node/events.d.ts:32 **Parameters:** @@ -450,7 +452,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[eventNames](sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -462,7 +464,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[getAlignment](../classes/sourcesource.md#getalignment)* -*Defined in [lib/source-destination/source-destination.ts:276](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L276)* +*Defined in [lib/source-destination/source-destination.ts:299](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L299)* **Returns:** *number | undefined* @@ -474,7 +476,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[getBlocks](../classes/sourcesource.md#getblocks)* -*Defined in [lib/source-destination/source-destination.ts:345](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L345)* +*Defined in [lib/source-destination/source-destination.ts:368](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L368)* **Returns:** *Promise‹[BlocksWithChecksum](blockswithchecksum.md)[]›* @@ -486,7 +488,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[getInnerSource](../classes/sourcesource.md#getinnersource)* -*Defined in [lib/source-destination/source-destination.ts:452](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L452)* +*Defined in [lib/source-destination/source-destination.ts:475](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L475)* **Returns:** *Promise‹[SourceDestination](../classes/sourcedestination.md)›* @@ -500,7 +502,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[getMaxListeners](sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -512,7 +514,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[getMetadata](../classes/sourcesource.md#getmetadata)* -*Defined in [lib/source-destination/source-destination.ts:304](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L304)* +*Defined in [lib/source-destination/source-destination.ts:327](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L327)* **Returns:** *Promise‹[Metadata](metadata.md)›* @@ -524,7 +526,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[getPartitionTable](../classes/sourcesource.md#getpartitiontable)* -*Defined in [lib/source-destination/source-destination.ts:473](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L473)* +*Defined in [lib/source-destination/source-destination.ts:496](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L496)* **Returns:** *Promise‹GetPartitionsResult | undefined›* @@ -538,7 +540,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[listenerCount](sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -558,7 +560,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[listeners](sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -570,6 +572,34 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [CountingWritable](../classes/countingwritable.md).[off](../classes/countingwritable.md#off)* + +*Overrides [SparseReadable](sparsereadable.md).[off](sparsereadable.md#off)* + +Defined in node_modules/@types/node/events.d.ts:26 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* @@ -578,7 +608,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[on](sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:899 +Defined in node_modules/@types/node/events.d.ts:21 **Parameters:** @@ -606,7 +636,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[once](sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:900 +Defined in node_modules/@types/node/events.d.ts:22 **Parameters:** @@ -632,7 +662,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[open](../classes/sourcesource.md#open)* -*Defined in [lib/source-destination/source-destination.ts:361](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L361)* +*Defined in [lib/source-destination/source-destination.ts:384](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L384)* **Returns:** *Promise‹void›* @@ -646,7 +676,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[prependListener](sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:901 +Defined in node_modules/@types/node/events.d.ts:23 **Parameters:** @@ -674,7 +704,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[prependOnceListener](sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:902 +Defined in node_modules/@types/node/events.d.ts:24 **Parameters:** @@ -694,13 +724,33 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](../classes/countingwritable.md).[rawListeners](../classes/countingwritable.md#rawlisteners)* + +*Overrides [SparseReadable](sparsereadable.md).[rawListeners](sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`_buffer`: [Buffer](alignedlockablebuffer.md#buffer), `_bufferOffset`: number, `_length`: number, `_sourceOffset`: number): *Promise‹ReadResult›* *Inherited from [SourceSource](../classes/sourcesource.md).[read](../classes/sourcesource.md#read)* -*Defined in [lib/source-destination/source-destination.ts:315](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L315)* +*Defined in [lib/source-destination/source-destination.ts:338](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L338)* **Parameters:** @@ -723,7 +773,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[removeAllListeners](sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -743,7 +793,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[removeListener](sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:903 +Defined in node_modules/@types/node/events.d.ts:25 **Parameters:** @@ -771,7 +821,7 @@ ___ *Overrides [SparseReadable](sparsereadable.md).[setMaxListeners](sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -789,7 +839,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[write](../classes/sourcesource.md#write)* -*Defined in [lib/source-destination/source-destination.ts:324](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L324)* +*Defined in [lib/source-destination/source-destination.ts:347](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L347)* **Parameters:** @@ -810,7 +860,9 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[listenerCount](../classes/countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** @@ -829,7 +881,7 @@ ___ *Inherited from [SourceSource](../classes/sourcesource.md).[register](../classes/sourcesource.md#static-register)* -*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L270)* +*Defined in [lib/source-destination/source-destination.ts:293](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L293)* **Parameters:** diff --git a/doc/interfaces/alignedlockablebuffer.md b/doc/interfaces/alignedlockablebuffer.md index 417f7da7..6e70a9a6 100644 --- a/doc/interfaces/alignedlockablebuffer.md +++ b/doc/interfaces/alignedlockablebuffer.md @@ -22,6 +22,7 @@ * [buffer](alignedlockablebuffer.md#buffer) * [byteLength](alignedlockablebuffer.md#bytelength) * [byteOffset](alignedlockablebuffer.md#byteoffset) +* [constructor](alignedlockablebuffer.md#constructor) * [length](alignedlockablebuffer.md#length) * [lock](alignedlockablebuffer.md#lock) * [rlock](alignedlockablebuffer.md#rlock) @@ -116,7 +117,7 @@ ___ • **Buffer**: *object* -Defined in node_modules/@types/node/base.d.ts:153 +Defined in node_modules/@types/node/globals.d.ts:291 Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. @@ -130,7 +131,7 @@ Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'bas * **new __type**(`array`: Uint8Array): *[Buffer](alignedlockablebuffer.md#buffer)* -* **new __type**(`arrayBuffer`: ArrayBuffer): *[Buffer](alignedlockablebuffer.md#buffer)* +* **new __type**(`arrayBuffer`: ArrayBuffer | SharedArrayBuffer): *[Buffer](alignedlockablebuffer.md#buffer)* * **new __type**(`array`: any[]): *[Buffer](alignedlockablebuffer.md#buffer)* @@ -146,21 +147,27 @@ Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'bas * **allocUnsafeSlow**(`size`: number): *[Buffer](alignedlockablebuffer.md#buffer)* -* **byteLength**(`string`: string | [Buffer](alignedlockablebuffer.md#buffer) | DataView | ArrayBuffer, `encoding?`: undefined | string): *number* +* **byteLength**(`string`: string | NodeJS.TypedArray | DataView | ArrayBuffer | SharedArrayBuffer, `encoding?`: undefined | string): *number* -* **compare**(`buf1`: [Buffer](alignedlockablebuffer.md#buffer), `buf2`: [Buffer](alignedlockablebuffer.md#buffer)): *number* +* **compare**(`buf1`: Uint8Array, `buf2`: Uint8Array): *number* -* **concat**(`list`: [Buffer](alignedlockablebuffer.md#buffer)[], `totalLength?`: undefined | number): *[Buffer](alignedlockablebuffer.md#buffer)* +* **concat**(`list`: Uint8Array[], `totalLength?`: undefined | number): *[Buffer](alignedlockablebuffer.md#buffer)* -* **from**(`arrayBuffer`: ArrayBuffer, `byteOffset?`: undefined | number, `length?`: undefined | number): *[Buffer](alignedlockablebuffer.md#buffer)* +* **from**(`arrayBuffer`: ArrayBuffer | SharedArrayBuffer, `byteOffset?`: undefined | number, `length?`: undefined | number): *[Buffer](alignedlockablebuffer.md#buffer)* -* **from**(`data`: any[] | string | [Buffer](alignedlockablebuffer.md#buffer) | ArrayBuffer): *[Buffer](alignedlockablebuffer.md#buffer)* +* **from**(`data`: any[]): *[Buffer](alignedlockablebuffer.md#buffer)* + +* **from**(`data`: Uint8Array): *[Buffer](alignedlockablebuffer.md#buffer)* + +* **from**(`obj`: object | object, `byteOffset?`: undefined | number, `length?`: undefined | number): *[Buffer](alignedlockablebuffer.md#buffer)* * **from**(`str`: string, `encoding?`: undefined | string): *[Buffer](alignedlockablebuffer.md#buffer)* * **isBuffer**(`obj`: any): *obj is Buffer* -* **isEncoding**(`encoding`: string): *boolean* +* **isEncoding**(`encoding`: string): *boolean | undefined* + +* **of**(...`items`: number[]): *[Buffer](alignedlockablebuffer.md#buffer)* ___ @@ -168,7 +175,7 @@ ___ • **alignment**: *number* -*Defined in [lib/aligned-lockable-buffer.ts:5](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L5)* +*Defined in [lib/aligned-lockable-buffer.ts:5](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L5)* ___ @@ -208,6 +215,16 @@ The offset in bytes of the array. ___ +### constructor + +• **constructor**: *typeof Buffer* + +*Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[constructor](alignedlockablebuffer.md#constructor)* + +Defined in node_modules/@types/node/globals.d.ts:230 + +___ + ### length • **length**: *number* @@ -224,7 +241,7 @@ ___ • **lock**: *function* -*Defined in [lib/aligned-lockable-buffer.ts:6](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L6)* +*Defined in [lib/aligned-lockable-buffer.ts:6](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L6)* #### Type declaration: @@ -236,7 +253,7 @@ ___ • **rlock**: *function* -*Defined in [lib/aligned-lockable-buffer.ts:7](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L7)* +*Defined in [lib/aligned-lockable-buffer.ts:7](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L7)* #### Type declaration: @@ -250,7 +267,7 @@ ___ *Overrides void* -*Defined in [lib/aligned-lockable-buffer.ts:8](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/aligned-lockable-buffer.ts#L8)* +*Defined in [lib/aligned-lockable-buffer.ts:8](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/aligned-lockable-buffer.ts#L8)* #### Type declaration: @@ -267,17 +284,17 @@ Name | Type | ### compare -▸ **compare**(`otherBuffer`: [Buffer](alignedlockablebuffer.md#buffer), `targetStart?`: undefined | number, `targetEnd?`: undefined | number, `sourceStart?`: undefined | number, `sourceEnd?`: undefined | number): *number* +▸ **compare**(`otherBuffer`: Uint8Array, `targetStart?`: undefined | number, `targetEnd?`: undefined | number, `sourceStart?`: undefined | number, `sourceEnd?`: undefined | number): *number* *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[compare](alignedlockablebuffer.md#compare)* -Defined in node_modules/@types/node/base.d.ts:806 +Defined in node_modules/@types/node/globals.d.ts:235 **Parameters:** Name | Type | ------ | ------ | -`otherBuffer` | [Buffer](alignedlockablebuffer.md#buffer) | +`otherBuffer` | Uint8Array | `targetStart?` | undefined | number | `targetEnd?` | undefined | number | `sourceStart?` | undefined | number | @@ -289,17 +306,17 @@ ___ ### copy -▸ **copy**(`targetBuffer`: [Buffer](alignedlockablebuffer.md#buffer), `targetStart?`: undefined | number, `sourceStart?`: undefined | number, `sourceEnd?`: undefined | number): *number* +▸ **copy**(`targetBuffer`: Uint8Array, `targetStart?`: undefined | number, `sourceStart?`: undefined | number, `sourceEnd?`: undefined | number): *number* *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[copy](alignedlockablebuffer.md#copy)* -Defined in node_modules/@types/node/base.d.ts:807 +Defined in node_modules/@types/node/globals.d.ts:236 **Parameters:** Name | Type | ------ | ------ | -`targetBuffer` | [Buffer](alignedlockablebuffer.md#buffer) | +`targetBuffer` | Uint8Array | `targetStart?` | undefined | number | `sourceStart?` | undefined | number | `sourceEnd?` | undefined | number | @@ -337,7 +354,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[entries](alignedlockablebuffer.md#entries)* -Defined in node_modules/@types/node/base.d.ts:851 +Defined in node_modules/@types/node/globals.d.ts:280 **Returns:** *IterableIterator‹[number, number]›* @@ -345,17 +362,17 @@ ___ ### equals -▸ **equals**(`otherBuffer`: [Buffer](alignedlockablebuffer.md#buffer)): *boolean* +▸ **equals**(`otherBuffer`: Uint8Array): *boolean* *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[equals](alignedlockablebuffer.md#equals)* -Defined in node_modules/@types/node/base.d.ts:805 +Defined in node_modules/@types/node/globals.d.ts:234 **Parameters:** Name | Type | ------ | ------ | -`otherBuffer` | [Buffer](alignedlockablebuffer.md#buffer) | +`otherBuffer` | Uint8Array | **Returns:** *boolean* @@ -406,7 +423,7 @@ ___ *Overrides void* -Defined in node_modules/@types/node/base.d.ts:848 +Defined in node_modules/@types/node/globals.d.ts:277 **Parameters:** @@ -574,7 +591,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[includes](alignedlockablebuffer.md#includes)* -Defined in node_modules/@types/node/base.d.ts:852 +Defined in node_modules/@types/node/globals.d.ts:281 **Parameters:** @@ -590,19 +607,19 @@ ___ ### indexOf -▸ **indexOf**(`value`: string | number | [Buffer](alignedlockablebuffer.md#buffer), `byteOffset?`: undefined | number, `encoding?`: undefined | string): *number* +▸ **indexOf**(`value`: string | number | Uint8Array, `byteOffset?`: undefined | number, `encoding?`: undefined | string): *number* *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[indexOf](alignedlockablebuffer.md#indexof)* *Overrides void* -Defined in node_modules/@types/node/base.d.ts:849 +Defined in node_modules/@types/node/globals.d.ts:278 **Parameters:** Name | Type | ------ | ------ | -`value` | string | number | [Buffer](alignedlockablebuffer.md#buffer) | +`value` | string | number | Uint8Array | `byteOffset?` | undefined | number | `encoding?` | undefined | string | @@ -636,7 +653,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[keys](alignedlockablebuffer.md#keys)* -Defined in node_modules/@types/node/base.d.ts:853 +Defined in node_modules/@types/node/globals.d.ts:282 **Returns:** *IterableIterator‹number›* @@ -644,19 +661,19 @@ ___ ### lastIndexOf -▸ **lastIndexOf**(`value`: string | number | [Buffer](alignedlockablebuffer.md#buffer), `byteOffset?`: undefined | number, `encoding?`: undefined | string): *number* +▸ **lastIndexOf**(`value`: string | number | Uint8Array, `byteOffset?`: undefined | number, `encoding?`: undefined | string): *number* *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[lastIndexOf](alignedlockablebuffer.md#lastindexof)* *Overrides void* -Defined in node_modules/@types/node/base.d.ts:850 +Defined in node_modules/@types/node/globals.d.ts:279 **Parameters:** Name | Type | ------ | ------ | -`value` | string | number | [Buffer](alignedlockablebuffer.md#buffer) | +`value` | string | number | Uint8Array | `byteOffset?` | undefined | number | `encoding?` | undefined | string | @@ -707,7 +724,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readDoubleBE](alignedlockablebuffer.md#readdoublebe)* -Defined in node_modules/@types/node/base.d.ts:830 +Defined in node_modules/@types/node/globals.d.ts:259 **Parameters:** @@ -726,7 +743,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readDoubleLE](alignedlockablebuffer.md#readdoublele)* -Defined in node_modules/@types/node/base.d.ts:829 +Defined in node_modules/@types/node/globals.d.ts:258 **Parameters:** @@ -745,7 +762,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readFloatBE](alignedlockablebuffer.md#readfloatbe)* -Defined in node_modules/@types/node/base.d.ts:828 +Defined in node_modules/@types/node/globals.d.ts:257 **Parameters:** @@ -764,7 +781,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readFloatLE](alignedlockablebuffer.md#readfloatle)* -Defined in node_modules/@types/node/base.d.ts:827 +Defined in node_modules/@types/node/globals.d.ts:256 **Parameters:** @@ -783,7 +800,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readInt16BE](alignedlockablebuffer.md#readint16be)* -Defined in node_modules/@types/node/base.d.ts:824 +Defined in node_modules/@types/node/globals.d.ts:253 **Parameters:** @@ -802,7 +819,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readInt16LE](alignedlockablebuffer.md#readint16le)* -Defined in node_modules/@types/node/base.d.ts:823 +Defined in node_modules/@types/node/globals.d.ts:252 **Parameters:** @@ -821,7 +838,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readInt32BE](alignedlockablebuffer.md#readint32be)* -Defined in node_modules/@types/node/base.d.ts:826 +Defined in node_modules/@types/node/globals.d.ts:255 **Parameters:** @@ -840,7 +857,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readInt32LE](alignedlockablebuffer.md#readint32le)* -Defined in node_modules/@types/node/base.d.ts:825 +Defined in node_modules/@types/node/globals.d.ts:254 **Parameters:** @@ -859,7 +876,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readInt8](alignedlockablebuffer.md#readint8)* -Defined in node_modules/@types/node/base.d.ts:822 +Defined in node_modules/@types/node/globals.d.ts:251 **Parameters:** @@ -878,7 +895,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readIntBE](alignedlockablebuffer.md#readintbe)* -Defined in node_modules/@types/node/base.d.ts:816 +Defined in node_modules/@types/node/globals.d.ts:245 **Parameters:** @@ -898,7 +915,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readIntLE](alignedlockablebuffer.md#readintle)* -Defined in node_modules/@types/node/base.d.ts:815 +Defined in node_modules/@types/node/globals.d.ts:244 **Parameters:** @@ -918,7 +935,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readUInt16BE](alignedlockablebuffer.md#readuint16be)* -Defined in node_modules/@types/node/base.d.ts:819 +Defined in node_modules/@types/node/globals.d.ts:248 **Parameters:** @@ -937,7 +954,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readUInt16LE](alignedlockablebuffer.md#readuint16le)* -Defined in node_modules/@types/node/base.d.ts:818 +Defined in node_modules/@types/node/globals.d.ts:247 **Parameters:** @@ -956,7 +973,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readUInt32BE](alignedlockablebuffer.md#readuint32be)* -Defined in node_modules/@types/node/base.d.ts:821 +Defined in node_modules/@types/node/globals.d.ts:250 **Parameters:** @@ -975,7 +992,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readUInt32LE](alignedlockablebuffer.md#readuint32le)* -Defined in node_modules/@types/node/base.d.ts:820 +Defined in node_modules/@types/node/globals.d.ts:249 **Parameters:** @@ -994,7 +1011,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readUInt8](alignedlockablebuffer.md#readuint8)* -Defined in node_modules/@types/node/base.d.ts:817 +Defined in node_modules/@types/node/globals.d.ts:246 **Parameters:** @@ -1013,7 +1030,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readUIntBE](alignedlockablebuffer.md#readuintbe)* -Defined in node_modules/@types/node/base.d.ts:814 +Defined in node_modules/@types/node/globals.d.ts:243 **Parameters:** @@ -1033,7 +1050,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[readUIntLE](alignedlockablebuffer.md#readuintle)* -Defined in node_modules/@types/node/base.d.ts:813 +Defined in node_modules/@types/node/globals.d.ts:242 **Parameters:** @@ -1365,7 +1382,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[swap16](alignedlockablebuffer.md#swap16)* -Defined in node_modules/@types/node/base.d.ts:831 +Defined in node_modules/@types/node/globals.d.ts:260 **Returns:** *[Buffer](alignedlockablebuffer.md#buffer)* @@ -1377,7 +1394,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[swap32](alignedlockablebuffer.md#swap32)* -Defined in node_modules/@types/node/base.d.ts:832 +Defined in node_modules/@types/node/globals.d.ts:261 **Returns:** *[Buffer](alignedlockablebuffer.md#buffer)* @@ -1389,7 +1406,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[swap64](alignedlockablebuffer.md#swap64)* -Defined in node_modules/@types/node/base.d.ts:833 +Defined in node_modules/@types/node/globals.d.ts:262 **Returns:** *[Buffer](alignedlockablebuffer.md#buffer)* @@ -1401,7 +1418,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[toJSON](alignedlockablebuffer.md#tojson)* -Defined in node_modules/@types/node/base.d.ts:804 +Defined in node_modules/@types/node/globals.d.ts:233 **Returns:** *object* @@ -1433,7 +1450,7 @@ ___ *Overrides void* -Defined in node_modules/@types/node/base.d.ts:803 +Defined in node_modules/@types/node/globals.d.ts:232 **Parameters:** @@ -1453,7 +1470,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[values](alignedlockablebuffer.md#values)* -Defined in node_modules/@types/node/base.d.ts:854 +Defined in node_modules/@types/node/globals.d.ts:283 **Returns:** *IterableIterator‹number›* @@ -1465,7 +1482,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[write](alignedlockablebuffer.md#write)* -Defined in node_modules/@types/node/base.d.ts:802 +Defined in node_modules/@types/node/globals.d.ts:231 **Parameters:** @@ -1486,7 +1503,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeDoubleBE](alignedlockablebuffer.md#writedoublebe)* -Defined in node_modules/@types/node/base.d.ts:847 +Defined in node_modules/@types/node/globals.d.ts:276 **Parameters:** @@ -1506,7 +1523,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeDoubleLE](alignedlockablebuffer.md#writedoublele)* -Defined in node_modules/@types/node/base.d.ts:846 +Defined in node_modules/@types/node/globals.d.ts:275 **Parameters:** @@ -1526,7 +1543,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeFloatBE](alignedlockablebuffer.md#writefloatbe)* -Defined in node_modules/@types/node/base.d.ts:845 +Defined in node_modules/@types/node/globals.d.ts:274 **Parameters:** @@ -1546,7 +1563,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeFloatLE](alignedlockablebuffer.md#writefloatle)* -Defined in node_modules/@types/node/base.d.ts:844 +Defined in node_modules/@types/node/globals.d.ts:273 **Parameters:** @@ -1566,7 +1583,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeInt16BE](alignedlockablebuffer.md#writeint16be)* -Defined in node_modules/@types/node/base.d.ts:841 +Defined in node_modules/@types/node/globals.d.ts:270 **Parameters:** @@ -1586,7 +1603,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeInt16LE](alignedlockablebuffer.md#writeint16le)* -Defined in node_modules/@types/node/base.d.ts:840 +Defined in node_modules/@types/node/globals.d.ts:269 **Parameters:** @@ -1606,7 +1623,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeInt32BE](alignedlockablebuffer.md#writeint32be)* -Defined in node_modules/@types/node/base.d.ts:843 +Defined in node_modules/@types/node/globals.d.ts:272 **Parameters:** @@ -1626,7 +1643,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeInt32LE](alignedlockablebuffer.md#writeint32le)* -Defined in node_modules/@types/node/base.d.ts:842 +Defined in node_modules/@types/node/globals.d.ts:271 **Parameters:** @@ -1646,7 +1663,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeInt8](alignedlockablebuffer.md#writeint8)* -Defined in node_modules/@types/node/base.d.ts:839 +Defined in node_modules/@types/node/globals.d.ts:268 **Parameters:** @@ -1666,7 +1683,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeIntBE](alignedlockablebuffer.md#writeintbe)* -Defined in node_modules/@types/node/base.d.ts:812 +Defined in node_modules/@types/node/globals.d.ts:241 **Parameters:** @@ -1687,7 +1704,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeIntLE](alignedlockablebuffer.md#writeintle)* -Defined in node_modules/@types/node/base.d.ts:811 +Defined in node_modules/@types/node/globals.d.ts:240 **Parameters:** @@ -1708,7 +1725,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeUInt16BE](alignedlockablebuffer.md#writeuint16be)* -Defined in node_modules/@types/node/base.d.ts:836 +Defined in node_modules/@types/node/globals.d.ts:265 **Parameters:** @@ -1728,7 +1745,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeUInt16LE](alignedlockablebuffer.md#writeuint16le)* -Defined in node_modules/@types/node/base.d.ts:835 +Defined in node_modules/@types/node/globals.d.ts:264 **Parameters:** @@ -1748,7 +1765,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeUInt32BE](alignedlockablebuffer.md#writeuint32be)* -Defined in node_modules/@types/node/base.d.ts:838 +Defined in node_modules/@types/node/globals.d.ts:267 **Parameters:** @@ -1768,7 +1785,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeUInt32LE](alignedlockablebuffer.md#writeuint32le)* -Defined in node_modules/@types/node/base.d.ts:837 +Defined in node_modules/@types/node/globals.d.ts:266 **Parameters:** @@ -1788,7 +1805,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeUInt8](alignedlockablebuffer.md#writeuint8)* -Defined in node_modules/@types/node/base.d.ts:834 +Defined in node_modules/@types/node/globals.d.ts:263 **Parameters:** @@ -1808,7 +1825,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeUIntBE](alignedlockablebuffer.md#writeuintbe)* -Defined in node_modules/@types/node/base.d.ts:810 +Defined in node_modules/@types/node/globals.d.ts:239 **Parameters:** @@ -1829,7 +1846,7 @@ ___ *Inherited from [AlignedLockableBuffer](alignedlockablebuffer.md).[writeUIntLE](alignedlockablebuffer.md#writeuintle)* -Defined in node_modules/@types/node/base.d.ts:809 +Defined in node_modules/@types/node/globals.d.ts:238 **Parameters:** diff --git a/doc/interfaces/block.md b/doc/interfaces/block.md index 7b5d3d60..5e8608c8 100644 --- a/doc/interfaces/block.md +++ b/doc/interfaces/block.md @@ -19,7 +19,7 @@ • **length**: *number* -*Defined in [lib/sparse-stream/shared.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L35)* +*Defined in [lib/sparse-stream/shared.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L35)* ___ @@ -27,4 +27,4 @@ ___ • **offset**: *number* -*Defined in [lib/sparse-stream/shared.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L34)* +*Defined in [lib/sparse-stream/shared.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L34)* diff --git a/doc/interfaces/blockswithchecksum.md b/doc/interfaces/blockswithchecksum.md index 34f6d25c..4f79b47a 100644 --- a/doc/interfaces/blockswithchecksum.md +++ b/doc/interfaces/blockswithchecksum.md @@ -20,7 +20,7 @@ • **blocks**: *[Block](block.md)[]* -*Defined in [lib/sparse-stream/shared.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L41)* +*Defined in [lib/sparse-stream/shared.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L41)* ___ @@ -28,7 +28,7 @@ ___ • **checksum**? : *undefined | string* -*Defined in [lib/sparse-stream/shared.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L40)* +*Defined in [lib/sparse-stream/shared.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L40)* ___ @@ -36,4 +36,4 @@ ___ • **checksumType**? : *[ChecksumType](../README.md#checksumtype)* -*Defined in [lib/sparse-stream/shared.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L39)* +*Defined in [lib/sparse-stream/shared.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L39)* diff --git a/doc/interfaces/createreadstreamoptions.md b/doc/interfaces/createreadstreamoptions.md index fcb77a96..d46e32f4 100644 --- a/doc/interfaces/createreadstreamoptions.md +++ b/doc/interfaces/createreadstreamoptions.md @@ -22,7 +22,7 @@ • **alignment**? : *undefined | number* -*Defined in [lib/source-destination/source-destination.ts:241](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L241)* +*Defined in [lib/source-destination/source-destination.ts:264](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L264)* ___ @@ -30,7 +30,7 @@ ___ • **emitProgress**? : *undefined | false | true* -*Defined in [lib/source-destination/source-destination.ts:238](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L238)* +*Defined in [lib/source-destination/source-destination.ts:261](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L261)* ___ @@ -38,7 +38,7 @@ ___ • **end**? : *undefined | number* -*Defined in [lib/source-destination/source-destination.ts:240](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L240)* +*Defined in [lib/source-destination/source-destination.ts:263](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L263)* ___ @@ -46,7 +46,7 @@ ___ • **numBuffers**? : *undefined | number* -*Defined in [lib/source-destination/source-destination.ts:242](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L242)* +*Defined in [lib/source-destination/source-destination.ts:265](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L265)* ___ @@ -54,4 +54,4 @@ ___ • **start**? : *undefined | number* -*Defined in [lib/source-destination/source-destination.ts:239](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L239)* +*Defined in [lib/source-destination/source-destination.ts:262](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L262)* diff --git a/doc/interfaces/createsparsereadstreamoptions.md b/doc/interfaces/createsparsereadstreamoptions.md index 52c5650c..e0ea4c86 100644 --- a/doc/interfaces/createsparsereadstreamoptions.md +++ b/doc/interfaces/createsparsereadstreamoptions.md @@ -20,7 +20,7 @@ • **alignment**? : *undefined | number* -*Defined in [lib/source-destination/source-destination.ts:247](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L247)* +*Defined in [lib/source-destination/source-destination.ts:270](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L270)* ___ @@ -28,7 +28,7 @@ ___ • **generateChecksums**? : *undefined | false | true* -*Defined in [lib/source-destination/source-destination.ts:246](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L246)* +*Defined in [lib/source-destination/source-destination.ts:269](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L269)* ___ @@ -36,4 +36,4 @@ ___ • **numBuffers**? : *undefined | number* -*Defined in [lib/source-destination/source-destination.ts:248](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/source-destination.ts#L248)* +*Defined in [lib/source-destination/source-destination.ts:271](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/source-destination.ts#L271)* diff --git a/doc/interfaces/drivelistdrive.md b/doc/interfaces/drivelistdrive.md index abfca584..43cba55e 100644 --- a/doc/interfaces/drivelistdrive.md +++ b/doc/interfaces/drivelistdrive.md @@ -101,7 +101,7 @@ ___ • **displayName**: *string* -*Defined in [lib/scanner/adapters/block-device.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L52)* +*Defined in [lib/scanner/adapters/block-device.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L52)* ___ @@ -129,7 +129,7 @@ ___ • **icon**? : *undefined | string* -*Defined in [lib/scanner/adapters/block-device.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/scanner/adapters/block-device.ts#L53)* +*Defined in [lib/scanner/adapters/block-device.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/scanner/adapters/block-device.ts#L53)* ___ diff --git a/doc/interfaces/execresult.md b/doc/interfaces/execresult.md index 640b4dae..76f3089a 100644 --- a/doc/interfaces/execresult.md +++ b/doc/interfaces/execresult.md @@ -19,7 +19,7 @@ • **stderr**: *string* -*Defined in [lib/diskpart.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L33)* +*Defined in [lib/diskpart.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L33)* ___ @@ -27,4 +27,4 @@ ___ • **stdout**: *string* -*Defined in [lib/diskpart.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/diskpart.ts#L32)* +*Defined in [lib/diskpart.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/diskpart.ts#L32)* diff --git a/doc/interfaces/metadata.md b/doc/interfaces/metadata.md index 4b273275..4f3b4fb3 100644 --- a/doc/interfaces/metadata.md +++ b/doc/interfaces/metadata.md @@ -35,7 +35,7 @@ • **blockMap**? : *BlockMap* -*Defined in [lib/source-destination/metadata.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L27)* +*Defined in [lib/source-destination/metadata.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L27)* ___ @@ -43,7 +43,7 @@ ___ • **blockmappedSize**? : *undefined | number* -*Defined in [lib/source-destination/metadata.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L25)* +*Defined in [lib/source-destination/metadata.ts:25](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L25)* ___ @@ -51,7 +51,7 @@ ___ • **blocks**? : *[BlocksWithChecksum](blockswithchecksum.md)[]* -*Defined in [lib/source-destination/metadata.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L28)* +*Defined in [lib/source-destination/metadata.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L28)* ___ @@ -59,7 +59,7 @@ ___ • **bytesToZeroOutFromTheBeginning**? : *undefined | number* -*Defined in [lib/source-destination/metadata.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L31)* +*Defined in [lib/source-destination/metadata.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L31)* ___ @@ -67,7 +67,7 @@ ___ • **checksum**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L32)* +*Defined in [lib/source-destination/metadata.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L32)* ___ @@ -75,7 +75,7 @@ ___ • **checksumType**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L33)* +*Defined in [lib/source-destination/metadata.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L33)* ___ @@ -83,7 +83,7 @@ ___ • **compressedSize**? : *undefined | number* -*Defined in [lib/source-destination/metadata.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L24)* +*Defined in [lib/source-destination/metadata.ts:24](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L24)* ___ @@ -91,7 +91,7 @@ ___ • **instructions**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L29)* +*Defined in [lib/source-destination/metadata.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L29)* ___ @@ -99,7 +99,7 @@ ___ • **isEtch**? : *undefined | false | true* -*Defined in [lib/source-destination/metadata.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L39)* +*Defined in [lib/source-destination/metadata.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L39)* ___ @@ -107,7 +107,7 @@ ___ • **isSizeEstimated**? : *undefined | false | true* -*Defined in [lib/source-destination/metadata.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L23)* +*Defined in [lib/source-destination/metadata.ts:23](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L23)* ___ @@ -115,7 +115,7 @@ ___ • **logo**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L30)* +*Defined in [lib/source-destination/metadata.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L30)* ___ @@ -123,7 +123,7 @@ ___ • **name**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L26)* +*Defined in [lib/source-destination/metadata.ts:26](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L26)* ___ @@ -131,7 +131,7 @@ ___ • **recommendedDriveSize**? : *undefined | number* -*Defined in [lib/source-destination/metadata.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L34)* +*Defined in [lib/source-destination/metadata.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L34)* ___ @@ -139,7 +139,7 @@ ___ • **releaseNotesUrl**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L35)* +*Defined in [lib/source-destination/metadata.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L35)* ___ @@ -147,7 +147,7 @@ ___ • **size**? : *undefined | number* -*Defined in [lib/source-destination/metadata.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L22)* +*Defined in [lib/source-destination/metadata.ts:22](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L22)* ___ @@ -155,7 +155,7 @@ ___ • **supportUrl**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L36)* +*Defined in [lib/source-destination/metadata.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L36)* ___ @@ -163,7 +163,7 @@ ___ • **url**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L37)* +*Defined in [lib/source-destination/metadata.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L37)* ___ @@ -171,4 +171,4 @@ ___ • **version**? : *undefined | string* -*Defined in [lib/source-destination/metadata.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/metadata.ts#L38)* +*Defined in [lib/source-destination/metadata.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/metadata.ts#L38)* diff --git a/doc/interfaces/multidestinationprogress.md b/doc/interfaces/multidestinationprogress.md index 847a5ff8..b8a83c60 100644 --- a/doc/interfaces/multidestinationprogress.md +++ b/doc/interfaces/multidestinationprogress.md @@ -39,7 +39,7 @@ *Inherited from [MultiDestinationState](multidestinationstate.md).[active](multidestinationstate.md#active)* -*Defined in [lib/multi-write.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L37)* +*Defined in [lib/multi-write.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L37)* ___ @@ -49,7 +49,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[blockmappedSize](multidestinationstate.md#optional-blockmappedsize)* -*Defined in [lib/multi-write.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L45)* +*Defined in [lib/multi-write.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L45)* ___ @@ -57,7 +57,7 @@ ___ • **bytes**: *number* -*Defined in [lib/multi-write.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L52)* +*Defined in [lib/multi-write.ts:52](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L52)* ___ @@ -67,7 +67,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[compressedSize](multidestinationstate.md#optional-compressedsize)* -*Defined in [lib/multi-write.ts:44](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L44)* +*Defined in [lib/multi-write.ts:44](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L44)* ___ @@ -75,7 +75,7 @@ ___ • **eta**? : *undefined | number* -*Defined in [lib/multi-write.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L57)* +*Defined in [lib/multi-write.ts:57](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L57)* ___ @@ -85,7 +85,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[failed](multidestinationstate.md#failed)* -*Defined in [lib/multi-write.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L40)* +*Defined in [lib/multi-write.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L40)* ___ @@ -95,7 +95,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[flashing](multidestinationstate.md#flashing)* -*Defined in [lib/multi-write.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L38)* +*Defined in [lib/multi-write.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L38)* ___ @@ -103,7 +103,7 @@ ___ • **percentage**? : *undefined | number* -*Defined in [lib/multi-write.ts:56](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L56)* +*Defined in [lib/multi-write.ts:56](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L56)* ___ @@ -111,7 +111,7 @@ ___ • **position**: *number* -*Defined in [lib/multi-write.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L53)* +*Defined in [lib/multi-write.ts:53](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L53)* ___ @@ -121,7 +121,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[rootStreamPosition](multidestinationstate.md#optional-rootstreamposition)* -*Defined in [lib/multi-write.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L47)* +*Defined in [lib/multi-write.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L47)* ___ @@ -131,7 +131,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[rootStreamSpeed](multidestinationstate.md#optional-rootstreamspeed)* -*Defined in [lib/multi-write.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L48)* +*Defined in [lib/multi-write.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L48)* ___ @@ -141,7 +141,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[size](multidestinationstate.md#optional-size)* -*Defined in [lib/multi-write.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L43)* +*Defined in [lib/multi-write.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L43)* ___ @@ -151,7 +151,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[sparse](multidestinationstate.md#optional-sparse)* -*Defined in [lib/multi-write.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L46)* +*Defined in [lib/multi-write.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L46)* ___ @@ -159,7 +159,7 @@ ___ • **speed**: *number* -*Defined in [lib/multi-write.ts:54](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L54)* +*Defined in [lib/multi-write.ts:54](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L54)* ___ @@ -169,7 +169,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[successful](multidestinationstate.md#successful)* -*Defined in [lib/multi-write.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L41)* +*Defined in [lib/multi-write.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L41)* ___ @@ -177,7 +177,7 @@ ___ • **totalSpeed**: *number* -*Defined in [lib/multi-write.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L55)* +*Defined in [lib/multi-write.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L55)* ___ @@ -187,7 +187,7 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[type](multidestinationstate.md#type)* -*Defined in [lib/multi-write.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L42)* +*Defined in [lib/multi-write.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L42)* ___ @@ -197,4 +197,4 @@ ___ *Inherited from [MultiDestinationState](multidestinationstate.md).[verifying](multidestinationstate.md#verifying)* -*Defined in [lib/multi-write.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L39)* +*Defined in [lib/multi-write.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L39)* diff --git a/doc/interfaces/multidestinationstate.md b/doc/interfaces/multidestinationstate.md index 6f7d7c2d..c0bef581 100644 --- a/doc/interfaces/multidestinationstate.md +++ b/doc/interfaces/multidestinationstate.md @@ -31,7 +31,7 @@ • **active**: *number* -*Defined in [lib/multi-write.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L37)* +*Defined in [lib/multi-write.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L37)* ___ @@ -39,7 +39,7 @@ ___ • **blockmappedSize**? : *undefined | number* -*Defined in [lib/multi-write.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L45)* +*Defined in [lib/multi-write.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L45)* ___ @@ -47,7 +47,7 @@ ___ • **compressedSize**? : *undefined | number* -*Defined in [lib/multi-write.ts:44](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L44)* +*Defined in [lib/multi-write.ts:44](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L44)* ___ @@ -55,7 +55,7 @@ ___ • **failed**: *number* -*Defined in [lib/multi-write.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L40)* +*Defined in [lib/multi-write.ts:40](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L40)* ___ @@ -63,7 +63,7 @@ ___ • **flashing**: *number* -*Defined in [lib/multi-write.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L38)* +*Defined in [lib/multi-write.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L38)* ___ @@ -71,7 +71,7 @@ ___ • **rootStreamPosition**? : *undefined | number* -*Defined in [lib/multi-write.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L47)* +*Defined in [lib/multi-write.ts:47](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L47)* ___ @@ -79,7 +79,7 @@ ___ • **rootStreamSpeed**? : *undefined | number* -*Defined in [lib/multi-write.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L48)* +*Defined in [lib/multi-write.ts:48](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L48)* ___ @@ -87,7 +87,7 @@ ___ • **size**? : *undefined | number* -*Defined in [lib/multi-write.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L43)* +*Defined in [lib/multi-write.ts:43](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L43)* ___ @@ -95,7 +95,7 @@ ___ • **sparse**? : *undefined | false | true* -*Defined in [lib/multi-write.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L46)* +*Defined in [lib/multi-write.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L46)* ___ @@ -103,7 +103,7 @@ ___ • **successful**: *number* -*Defined in [lib/multi-write.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L41)* +*Defined in [lib/multi-write.ts:41](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L41)* ___ @@ -111,7 +111,7 @@ ___ • **type**: *[WriteStep](../README.md#writestep)* -*Defined in [lib/multi-write.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L42)* +*Defined in [lib/multi-write.ts:42](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L42)* ___ @@ -119,4 +119,4 @@ ___ • **verifying**: *number* -*Defined in [lib/multi-write.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L39)* +*Defined in [lib/multi-write.ts:39](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L39)* diff --git a/doc/interfaces/operation.md b/doc/interfaces/operation.md index 300a9e5f..ce2f108b 100644 --- a/doc/interfaces/operation.md +++ b/doc/interfaces/operation.md @@ -19,7 +19,7 @@ • **command**: *[OperationCommand](../README.md#operationcommand)* -*Defined in [lib/source-destination/configured-source/configure.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L31)* +*Defined in [lib/source-destination/configured-source/configure.ts:31](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L31)* ___ @@ -27,4 +27,4 @@ ___ • **when**: *any* -*Defined in [lib/source-destination/configured-source/configure.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/configure.ts#L32)* +*Defined in [lib/source-destination/configured-source/configure.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/configure.ts#L32)* diff --git a/doc/interfaces/pipesourcetodestinationsresult.md b/doc/interfaces/pipesourcetodestinationsresult.md index dbf38e5e..6c3334f5 100644 --- a/doc/interfaces/pipesourcetodestinationsresult.md +++ b/doc/interfaces/pipesourcetodestinationsresult.md @@ -19,7 +19,7 @@ • **bytesWritten**: *number* -*Defined in [lib/multi-write.ts:69](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L69)* +*Defined in [lib/multi-write.ts:69](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L69)* ___ @@ -27,4 +27,4 @@ ___ • **failures**: *Map‹[SourceDestination](../classes/sourcedestination.md), [Error](../classes/notcapable.md#static-error)›* -*Defined in [lib/multi-write.ts:68](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/multi-write.ts#L68)* +*Defined in [lib/multi-write.ts:68](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/multi-write.ts#L68)* diff --git a/doc/interfaces/progressevent.md b/doc/interfaces/progressevent.md index 1520dcd7..9c90ce8f 100644 --- a/doc/interfaces/progressevent.md +++ b/doc/interfaces/progressevent.md @@ -20,7 +20,7 @@ • **bytes**: *number* -*Defined in [lib/source-destination/progress.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L29)* +*Defined in [lib/source-destination/progress.ts:29](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L29)* ___ @@ -28,7 +28,7 @@ ___ • **position**: *number* -*Defined in [lib/source-destination/progress.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L28)* +*Defined in [lib/source-destination/progress.ts:28](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L28)* ___ @@ -36,4 +36,4 @@ ___ • **speed**: *number* -*Defined in [lib/source-destination/progress.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/progress.ts#L30)* +*Defined in [lib/source-destination/progress.ts:30](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/progress.ts#L30)* diff --git a/doc/interfaces/sourcetransform.md b/doc/interfaces/sourcetransform.md index a9b374a2..1a0d8717 100644 --- a/doc/interfaces/sourcetransform.md +++ b/doc/interfaces/sourcetransform.md @@ -23,15 +23,19 @@ * [readable](sourcetransform.md#readable) * [readableHighWaterMark](sourcetransform.md#readablehighwatermark) +* [readableLength](sourcetransform.md#readablelength) * [sourceStream](sourcetransform.md#sourcestream) * [writable](sourcetransform.md#writable) * [writableHighWaterMark](sourcetransform.md#writablehighwatermark) +* [writableLength](sourcetransform.md#writablelength) * [defaultMaxListeners](sourcetransform.md#static-defaultmaxlisteners) ### Methods +* [[Symbol.asyncIterator]](sourcetransform.md#[symbol.asynciterator]) * [_destroy](sourcetransform.md#_destroy) * [_final](sourcetransform.md#_final) +* [_flush](sourcetransform.md#_flush) * [_read](sourcetransform.md#_read) * [_transform](sourcetransform.md#_transform) * [_write](sourcetransform.md#_write) @@ -46,6 +50,7 @@ * [isPaused](sourcetransform.md#ispaused) * [listenerCount](sourcetransform.md#listenercount) * [listeners](sourcetransform.md#listeners) +* [off](sourcetransform.md#off) * [on](sourcetransform.md#on) * [once](sourcetransform.md#once) * [pause](sourcetransform.md#pause) @@ -53,6 +58,7 @@ * [prependListener](sourcetransform.md#prependlistener) * [prependOnceListener](sourcetransform.md#prependoncelistener) * [push](sourcetransform.md#push) +* [rawListeners](sourcetransform.md#rawlisteners) * [read](sourcetransform.md#read) * [removeAllListeners](sourcetransform.md#removealllisteners) * [removeListener](sourcetransform.md#removelistener) @@ -77,7 +83,7 @@ *Overrides void* -Defined in node_modules/@types/node/base.d.ts:5622 +Defined in node_modules/@types/node/stream.d.ts:239 **Parameters:** @@ -95,7 +101,7 @@ Name | Type | *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[readable](../classes/sparsefilterstream.md#readable)* -Defined in node_modules/@types/node/base.d.ts:5422 +Defined in node_modules/@types/node/stream.d.ts:20 ___ @@ -105,7 +111,17 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[readableHighWaterMark](../classes/sparsefilterstream.md#readablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5423 +Defined in node_modules/@types/node/stream.d.ts:21 + +___ + +### readableLength + +• **readableLength**: *number* + +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[readableLength](../classes/sparsefilterstream.md#readablelength)* + +Defined in node_modules/@types/node/stream.d.ts:22 ___ @@ -113,7 +129,7 @@ ___ • **sourceStream**: *ReadableStream* -*Defined in [lib/source-destination/compressed-source.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/compressed-source.ts#L27)* +*Defined in [lib/source-destination/compressed-source.ts:27](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/compressed-source.ts#L27)* ___ @@ -123,7 +139,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[writable](../classes/sparsefilterstream.md#writable)* -Defined in node_modules/@types/node/base.d.ts:5600 +Defined in node_modules/@types/node/stream.d.ts:209 ___ @@ -133,7 +149,17 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[writableHighWaterMark](../classes/sparsefilterstream.md#writablehighwatermark)* -Defined in node_modules/@types/node/base.d.ts:5601 +Defined in node_modules/@types/node/stream.d.ts:210 + +___ + +### writableLength + +• **writableLength**: *number* + +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[writableLength](../classes/sparsefilterstream.md#writablelength)* + +Defined in node_modules/@types/node/stream.d.ts:211 ___ @@ -143,10 +169,22 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[defaultMaxListeners](../classes/countingwritable.md#static-defaultmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:896 +Defined in node_modules/@types/node/events.d.ts:18 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹any›* + +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[[Symbol.asyncIterator]](../classes/sparsefilterstream.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/stream.d.ts:95 + +**Returns:** *AsyncIterableIterator‹any›* + +___ + ### _destroy ▸ **_destroy**(`error`: [Error](../classes/notcapable.md#static-error) | null, `callback`: function): *void* @@ -155,7 +193,7 @@ Defined in node_modules/@types/node/base.d.ts:896 *Overrides [SparseReadStream](../classes/sparsereadstream.md).[_destroy](../classes/sparsereadstream.md#_destroy)* -Defined in node_modules/@types/node/base.d.ts:5605 +Defined in node_modules/@types/node/stream.d.ts:215 **Parameters:** @@ -163,13 +201,13 @@ Defined in node_modules/@types/node/base.d.ts:5605 ▪ **callback**: *function* -▸ (`error?`: [Error](../classes/notcapable.md#static-error)): *void* +▸ (`error`: [Error](../classes/notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`error?` | [Error](../classes/notcapable.md#static-error) | +`error` | [Error](../classes/notcapable.md#static-error) | null | **Returns:** *void* @@ -177,17 +215,41 @@ ___ ### _final -▸ **_final**(`callback`: Function): *void* +▸ **_final**(`callback`: function): *void* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[_final](../classes/sparsefilterstream.md#_final)* -Defined in node_modules/@types/node/base.d.ts:5606 +Defined in node_modules/@types/node/stream.d.ts:216 + +**Parameters:** + +▪ **callback**: *function* + +▸ (`error?`: [Error](../classes/notcapable.md#static-error) | null): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`error?` | [Error](../classes/notcapable.md#static-error) | null | + +**Returns:** *void* + +___ + +### _flush + +▸ **_flush**(`callback`: TransformCallback): *void* + +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[_flush](../classes/sparsefilterstream.md#_flush)* + +Defined in node_modules/@types/node/stream.d.ts:242 **Parameters:** Name | Type | ------ | ------ | -`callback` | Function | +`callback` | TransformCallback | **Returns:** *void* @@ -199,7 +261,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[_read](../classes/sparsefilterstream.md#_read)* -Defined in node_modules/@types/node/base.d.ts:5425 +Defined in node_modules/@types/node/stream.d.ts:24 **Parameters:** @@ -213,11 +275,11 @@ ___ ### _transform -▸ **_transform**(`chunk`: any, `encoding`: string, `callback`: Function): *void* +▸ **_transform**(`chunk`: any, `encoding`: string, `callback`: TransformCallback): *void* *Inherited from [SourceTransform](sourcetransform.md).[_transform](sourcetransform.md#_transform)* -Defined in node_modules/@types/node/base.d.ts:5624 +Defined in node_modules/@types/node/stream.d.ts:241 **Parameters:** @@ -225,7 +287,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding` | string | -`callback` | Function | +`callback` | TransformCallback | **Returns:** *void* @@ -237,7 +299,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[_write](../classes/sparsefilterstream.md#_write)* -Defined in node_modules/@types/node/base.d.ts:5603 +Defined in node_modules/@types/node/stream.d.ts:213 **Parameters:** @@ -247,13 +309,13 @@ Defined in node_modules/@types/node/base.d.ts:5603 ▪ **callback**: *function* -▸ (`err?`: [Error](../classes/notcapable.md#static-error)): *void* +▸ (`error?`: [Error](../classes/notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](../classes/notcapable.md#static-error) | +`error?` | [Error](../classes/notcapable.md#static-error) | null | **Returns:** *void* @@ -265,7 +327,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[_writev](../classes/sparsefilterstream.md#optional-_writev)* -Defined in node_modules/@types/node/base.d.ts:5604 +Defined in node_modules/@types/node/stream.d.ts:214 **Parameters:** @@ -273,13 +335,13 @@ Defined in node_modules/@types/node/base.d.ts:5604 ▪ **callback**: *function* -▸ (`err?`: [Error](../classes/notcapable.md#static-error)): *void* +▸ (`error?`: [Error](../classes/notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](../classes/notcapable.md#static-error) | +`error?` | [Error](../classes/notcapable.md#static-error) | null | **Returns:** *void* @@ -287,13 +349,13 @@ ___ ### addListener -▸ **addListener**(`event`: string, `listener`: function): *this* +▸ **addListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[addListener](../classes/sparsefilterstream.md#addlistener)* *Overrides [SourceSource](../classes/sourcesource.md).[addListener](../classes/sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5447 +Defined in node_modules/@types/node/stream.d.ts:46 Event emitter The defined events on documents including: @@ -305,30 +367,6 @@ The defined events on documents including: **Parameters:** -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - -▸ **addListener**(`event`: "close", `listener`: function): *this* - -*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[addListener](../classes/sparsefilterstream.md#addlistener)* - -*Overrides [SourceSource](../classes/sourcesource.md).[addListener](../classes/sourcesource.md#addlistener)* - -Defined in node_modules/@types/node/base.d.ts:5448 - -**Parameters:** - ▪ **event**: *"close"* ▪ **listener**: *function* @@ -343,7 +381,7 @@ Defined in node_modules/@types/node/base.d.ts:5448 *Overrides [SourceSource](../classes/sourcesource.md).[addListener](../classes/sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5449 +Defined in node_modules/@types/node/stream.d.ts:47 **Parameters:** @@ -351,13 +389,13 @@ Defined in node_modules/@types/node/base.d.ts:5449 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -367,7 +405,7 @@ Name | Type | *Overrides [SourceSource](../classes/sourcesource.md).[addListener](../classes/sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5450 +Defined in node_modules/@types/node/stream.d.ts:48 **Parameters:** @@ -385,7 +423,7 @@ Defined in node_modules/@types/node/base.d.ts:5450 *Overrides [SourceSource](../classes/sourcesource.md).[addListener](../classes/sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5451 +Defined in node_modules/@types/node/stream.d.ts:49 **Parameters:** @@ -403,7 +441,7 @@ Defined in node_modules/@types/node/base.d.ts:5451 *Overrides [SourceSource](../classes/sourcesource.md).[addListener](../classes/sourcesource.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:5452 +Defined in node_modules/@types/node/stream.d.ts:50 **Parameters:** @@ -421,6 +459,30 @@ Name | Type | **Returns:** *this* +▸ **addListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[addListener](../classes/sparsefilterstream.md#addlistener)* + +*Overrides [SourceSource](../classes/sourcesource.md).[addListener](../classes/sourcesource.md#addlistener)* + +Defined in node_modules/@types/node/stream.d.ts:51 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### cork @@ -429,7 +491,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[cork](../classes/sparsefilterstream.md#cork)* -Defined in node_modules/@types/node/base.d.ts:5613 +Defined in node_modules/@types/node/stream.d.ts:223 **Returns:** *void* @@ -441,9 +503,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[destroy](../classes/sparsefilterstream.md#destroy)* -*Overrides [SparseReadStream](../classes/sparsereadstream.md).[destroy](../classes/sparsereadstream.md#destroy)* - -Defined in node_modules/@types/node/base.d.ts:5625 +Defined in node_modules/@types/node/stream.d.ts:35 **Parameters:** @@ -457,102 +517,102 @@ ___ ### emit -▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* +▸ **emit**(`event`: "close"): *boolean* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[emit](../classes/sparsefilterstream.md#emit)* *Overrides [SourceSource](../classes/sourcesource.md).[emit](../classes/sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5454 +Defined in node_modules/@types/node/stream.d.ts:53 **Parameters:** Name | Type | ------ | ------ | -`event` | string | symbol | -`...args` | any[] | +`event` | "close" | **Returns:** *boolean* -▸ **emit**(`event`: "close"): *boolean* +▸ **emit**(`event`: "data", `chunk`: any): *boolean* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[emit](../classes/sparsefilterstream.md#emit)* *Overrides [SourceSource](../classes/sourcesource.md).[emit](../classes/sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5455 +Defined in node_modules/@types/node/stream.d.ts:54 **Parameters:** Name | Type | ------ | ------ | -`event` | "close" | +`event` | "data" | +`chunk` | any | **Returns:** *boolean* -▸ **emit**(`event`: "data", `chunk`: [Buffer](alignedlockablebuffer.md#buffer) | string): *boolean* +▸ **emit**(`event`: "end"): *boolean* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[emit](../classes/sparsefilterstream.md#emit)* *Overrides [SourceSource](../classes/sourcesource.md).[emit](../classes/sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5456 +Defined in node_modules/@types/node/stream.d.ts:55 **Parameters:** Name | Type | ------ | ------ | -`event` | "data" | -`chunk` | [Buffer](alignedlockablebuffer.md#buffer) | string | +`event` | "end" | **Returns:** *boolean* -▸ **emit**(`event`: "end"): *boolean* +▸ **emit**(`event`: "readable"): *boolean* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[emit](../classes/sparsefilterstream.md#emit)* *Overrides [SourceSource](../classes/sourcesource.md).[emit](../classes/sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5457 +Defined in node_modules/@types/node/stream.d.ts:56 **Parameters:** Name | Type | ------ | ------ | -`event` | "end" | +`event` | "readable" | **Returns:** *boolean* -▸ **emit**(`event`: "readable"): *boolean* +▸ **emit**(`event`: "error", `err`: [Error](../classes/notcapable.md#static-error)): *boolean* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[emit](../classes/sparsefilterstream.md#emit)* *Overrides [SourceSource](../classes/sourcesource.md).[emit](../classes/sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5458 +Defined in node_modules/@types/node/stream.d.ts:57 **Parameters:** Name | Type | ------ | ------ | -`event` | "readable" | +`event` | "error" | +`err` | [Error](../classes/notcapable.md#static-error) | **Returns:** *boolean* -▸ **emit**(`event`: "error", `err`: [Error](../classes/notcapable.md#static-error)): *boolean* +▸ **emit**(`event`: string | symbol, ...`args`: any[]): *boolean* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[emit](../classes/sparsefilterstream.md#emit)* *Overrides [SourceSource](../classes/sourcesource.md).[emit](../classes/sourcesource.md#emit)* -Defined in node_modules/@types/node/base.d.ts:5459 +Defined in node_modules/@types/node/stream.d.ts:58 **Parameters:** Name | Type | ------ | ------ | -`event` | "error" | -`err` | [Error](../classes/notcapable.md#static-error) | +`event` | string | symbol | +`...args` | any[] | **Returns:** *boolean* @@ -560,40 +620,40 @@ ___ ### end -▸ **end**(`cb?`: Function): *void* +▸ **end**(`cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[end](../classes/sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5610 +Defined in node_modules/@types/node/stream.d.ts:220 **Parameters:** Name | Type | ------ | ------ | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[end](../classes/sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5611 +Defined in node_modules/@types/node/stream.d.ts:221 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* -▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *void* +▸ **end**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *void* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[end](../classes/sparsefilterstream.md#end)* -Defined in node_modules/@types/node/base.d.ts:5612 +Defined in node_modules/@types/node/stream.d.ts:222 **Parameters:** @@ -601,7 +661,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *void* @@ -613,7 +673,7 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[eventNames](../classes/countingwritable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:909 +Defined in node_modules/@types/node/events.d.ts:33 **Returns:** *Array‹string | symbol›* @@ -625,7 +685,7 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[getMaxListeners](../classes/countingwritable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:906 +Defined in node_modules/@types/node/events.d.ts:29 **Returns:** *number* @@ -637,7 +697,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[isPaused](../classes/sparsefilterstream.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:5430 +Defined in node_modules/@types/node/stream.d.ts:29 **Returns:** *boolean* @@ -649,7 +709,7 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[listenerCount](../classes/countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:910 +Defined in node_modules/@types/node/events.d.ts:34 **Parameters:** @@ -667,7 +727,7 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[listeners](../classes/countingwritable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:907 +Defined in node_modules/@types/node/events.d.ts:30 **Parameters:** @@ -679,19 +739,17 @@ Name | Type | ___ -### on - -▸ **on**(`event`: string, `listener`: function): *this* +### off -*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[on](../classes/sparsefilterstream.md#on)* +▸ **off**(`event`: string | symbol, `listener`: function): *this* -*Overrides [SourceSource](../classes/sourcesource.md).[on](../classes/sourcesource.md#on)* +*Inherited from [CountingWritable](../classes/countingwritable.md).[off](../classes/countingwritable.md#off)* -Defined in node_modules/@types/node/base.d.ts:5461 +Defined in node_modules/@types/node/events.d.ts:26 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -705,13 +763,17 @@ Name | Type | **Returns:** *this* +___ + +### on + ▸ **on**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[on](../classes/sparsefilterstream.md#on)* *Overrides [SourceSource](../classes/sourcesource.md).[on](../classes/sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5462 +Defined in node_modules/@types/node/stream.d.ts:60 **Parameters:** @@ -729,7 +791,7 @@ Defined in node_modules/@types/node/base.d.ts:5462 *Overrides [SourceSource](../classes/sourcesource.md).[on](../classes/sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5463 +Defined in node_modules/@types/node/stream.d.ts:61 **Parameters:** @@ -737,13 +799,13 @@ Defined in node_modules/@types/node/base.d.ts:5463 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -753,7 +815,7 @@ Name | Type | *Overrides [SourceSource](../classes/sourcesource.md).[on](../classes/sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5464 +Defined in node_modules/@types/node/stream.d.ts:62 **Parameters:** @@ -771,7 +833,7 @@ Defined in node_modules/@types/node/base.d.ts:5464 *Overrides [SourceSource](../classes/sourcesource.md).[on](../classes/sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5465 +Defined in node_modules/@types/node/stream.d.ts:63 **Parameters:** @@ -789,7 +851,7 @@ Defined in node_modules/@types/node/base.d.ts:5465 *Overrides [SourceSource](../classes/sourcesource.md).[on](../classes/sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5466 +Defined in node_modules/@types/node/stream.d.ts:64 **Parameters:** @@ -807,21 +869,17 @@ Name | Type | **Returns:** *this* -___ - -### once - -▸ **once**(`event`: string, `listener`: function): *this* +▸ **on**(`event`: string | symbol, `listener`: function): *this* -*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[once](../classes/sparsefilterstream.md#once)* +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[on](../classes/sparsefilterstream.md#on)* -*Overrides [SourceSource](../classes/sourcesource.md).[once](../classes/sourcesource.md#once)* +*Overrides [SourceSource](../classes/sourcesource.md).[on](../classes/sourcesource.md#on)* -Defined in node_modules/@types/node/base.d.ts:5468 +Defined in node_modules/@types/node/stream.d.ts:65 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -835,13 +893,17 @@ Name | Type | **Returns:** *this* +___ + +### once + ▸ **once**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[once](../classes/sparsefilterstream.md#once)* *Overrides [SourceSource](../classes/sourcesource.md).[once](../classes/sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5469 +Defined in node_modules/@types/node/stream.d.ts:67 **Parameters:** @@ -859,7 +921,7 @@ Defined in node_modules/@types/node/base.d.ts:5469 *Overrides [SourceSource](../classes/sourcesource.md).[once](../classes/sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5470 +Defined in node_modules/@types/node/stream.d.ts:68 **Parameters:** @@ -867,13 +929,13 @@ Defined in node_modules/@types/node/base.d.ts:5470 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -883,7 +945,7 @@ Name | Type | *Overrides [SourceSource](../classes/sourcesource.md).[once](../classes/sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5471 +Defined in node_modules/@types/node/stream.d.ts:69 **Parameters:** @@ -901,7 +963,7 @@ Defined in node_modules/@types/node/base.d.ts:5471 *Overrides [SourceSource](../classes/sourcesource.md).[once](../classes/sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5472 +Defined in node_modules/@types/node/stream.d.ts:70 **Parameters:** @@ -919,7 +981,7 @@ Defined in node_modules/@types/node/base.d.ts:5472 *Overrides [SourceSource](../classes/sourcesource.md).[once](../classes/sourcesource.md#once)* -Defined in node_modules/@types/node/base.d.ts:5473 +Defined in node_modules/@types/node/stream.d.ts:71 **Parameters:** @@ -937,6 +999,30 @@ Name | Type | **Returns:** *this* +▸ **once**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[once](../classes/sparsefilterstream.md#once)* + +*Overrides [SourceSource](../classes/sourcesource.md).[once](../classes/sourcesource.md#once)* + +Defined in node_modules/@types/node/stream.d.ts:72 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### pause @@ -945,7 +1031,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[pause](../classes/sparsefilterstream.md#pause)* -Defined in node_modules/@types/node/base.d.ts:5428 +Defined in node_modules/@types/node/stream.d.ts:27 **Returns:** *this* @@ -957,7 +1043,7 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[pipe](../classes/countingwritable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:5407 +Defined in node_modules/@types/node/stream.d.ts:5 **Type parameters:** @@ -976,37 +1062,13 @@ ___ ### prependListener -▸ **prependListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[prependListener](../classes/sparsefilterstream.md#prependlistener)* - -*Overrides [SourceSource](../classes/sourcesource.md).[prependListener](../classes/sourcesource.md#prependlistener)* - -Defined in node_modules/@types/node/base.d.ts:5475 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **prependListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[prependListener](../classes/sparsefilterstream.md#prependlistener)* *Overrides [SourceSource](../classes/sourcesource.md).[prependListener](../classes/sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5476 +Defined in node_modules/@types/node/stream.d.ts:74 **Parameters:** @@ -1024,7 +1086,7 @@ Defined in node_modules/@types/node/base.d.ts:5476 *Overrides [SourceSource](../classes/sourcesource.md).[prependListener](../classes/sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5477 +Defined in node_modules/@types/node/stream.d.ts:75 **Parameters:** @@ -1032,13 +1094,13 @@ Defined in node_modules/@types/node/base.d.ts:5477 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1048,7 +1110,7 @@ Name | Type | *Overrides [SourceSource](../classes/sourcesource.md).[prependListener](../classes/sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5478 +Defined in node_modules/@types/node/stream.d.ts:76 **Parameters:** @@ -1066,7 +1128,7 @@ Defined in node_modules/@types/node/base.d.ts:5478 *Overrides [SourceSource](../classes/sourcesource.md).[prependListener](../classes/sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5479 +Defined in node_modules/@types/node/stream.d.ts:77 **Parameters:** @@ -1084,7 +1146,7 @@ Defined in node_modules/@types/node/base.d.ts:5479 *Overrides [SourceSource](../classes/sourcesource.md).[prependListener](../classes/sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5480 +Defined in node_modules/@types/node/stream.d.ts:78 **Parameters:** @@ -1102,21 +1164,17 @@ Name | Type | **Returns:** *this* -___ - -### prependOnceListener +▸ **prependListener**(`event`: string | symbol, `listener`: function): *this* -▸ **prependOnceListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[prependOnceListener](../classes/sparsefilterstream.md#prependoncelistener)* +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[prependListener](../classes/sparsefilterstream.md#prependlistener)* -*Overrides [SourceSource](../classes/sourcesource.md).[prependOnceListener](../classes/sourcesource.md#prependoncelistener)* +*Overrides [SourceSource](../classes/sourcesource.md).[prependListener](../classes/sourcesource.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:5482 +Defined in node_modules/@types/node/stream.d.ts:79 **Parameters:** -▪ **event**: *string* +▪ **event**: *string | symbol* ▪ **listener**: *function* @@ -1130,13 +1188,17 @@ Name | Type | **Returns:** *this* +___ + +### prependOnceListener + ▸ **prependOnceListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[prependOnceListener](../classes/sparsefilterstream.md#prependoncelistener)* *Overrides [SourceSource](../classes/sourcesource.md).[prependOnceListener](../classes/sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5483 +Defined in node_modules/@types/node/stream.d.ts:81 **Parameters:** @@ -1154,7 +1216,7 @@ Defined in node_modules/@types/node/base.d.ts:5483 *Overrides [SourceSource](../classes/sourcesource.md).[prependOnceListener](../classes/sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5484 +Defined in node_modules/@types/node/stream.d.ts:82 **Parameters:** @@ -1162,13 +1224,13 @@ Defined in node_modules/@types/node/base.d.ts:5484 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1178,7 +1240,7 @@ Name | Type | *Overrides [SourceSource](../classes/sourcesource.md).[prependOnceListener](../classes/sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5485 +Defined in node_modules/@types/node/stream.d.ts:83 **Parameters:** @@ -1196,7 +1258,7 @@ Defined in node_modules/@types/node/base.d.ts:5485 *Overrides [SourceSource](../classes/sourcesource.md).[prependOnceListener](../classes/sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5486 +Defined in node_modules/@types/node/stream.d.ts:84 **Parameters:** @@ -1214,7 +1276,7 @@ Defined in node_modules/@types/node/base.d.ts:5486 *Overrides [SourceSource](../classes/sourcesource.md).[prependOnceListener](../classes/sourcesource.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:5487 +Defined in node_modules/@types/node/stream.d.ts:85 **Parameters:** @@ -1232,6 +1294,30 @@ Name | Type | **Returns:** *this* +▸ **prependOnceListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[prependOnceListener](../classes/sparsefilterstream.md#prependoncelistener)* + +*Overrides [SourceSource](../classes/sourcesource.md).[prependOnceListener](../classes/sourcesource.md#prependoncelistener)* + +Defined in node_modules/@types/node/stream.d.ts:86 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### push @@ -1240,7 +1326,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[push](../classes/sparsefilterstream.md#push)* -Defined in node_modules/@types/node/base.d.ts:5434 +Defined in node_modules/@types/node/stream.d.ts:33 **Parameters:** @@ -1253,13 +1339,31 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [CountingWritable](../classes/countingwritable.md).[rawListeners](../classes/countingwritable.md#rawlisteners)* + +Defined in node_modules/@types/node/events.d.ts:31 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`size?`: undefined | number): *any* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[read](../classes/sparsefilterstream.md#read)* -Defined in node_modules/@types/node/base.d.ts:5426 +Defined in node_modules/@types/node/stream.d.ts:25 **Parameters:** @@ -1277,7 +1381,7 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[removeAllListeners](../classes/countingwritable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:904 +Defined in node_modules/@types/node/events.d.ts:27 **Parameters:** @@ -1291,37 +1395,13 @@ ___ ### removeListener -▸ **removeListener**(`event`: string, `listener`: function): *this* - -*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[removeListener](../classes/sparsefilterstream.md#removelistener)* - -*Overrides [SourceSource](../classes/sourcesource.md).[removeListener](../classes/sourcesource.md#removelistener)* - -Defined in node_modules/@types/node/base.d.ts:5489 - -**Parameters:** - -▪ **event**: *string* - -▪ **listener**: *function* - -▸ (...`args`: any[]): *void* - -**Parameters:** - -Name | Type | ------- | ------ | -`...args` | any[] | - -**Returns:** *this* - ▸ **removeListener**(`event`: "close", `listener`: function): *this* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[removeListener](../classes/sparsefilterstream.md#removelistener)* *Overrides [SourceSource](../classes/sourcesource.md).[removeListener](../classes/sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5490 +Defined in node_modules/@types/node/stream.d.ts:88 **Parameters:** @@ -1339,7 +1419,7 @@ Defined in node_modules/@types/node/base.d.ts:5490 *Overrides [SourceSource](../classes/sourcesource.md).[removeListener](../classes/sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5491 +Defined in node_modules/@types/node/stream.d.ts:89 **Parameters:** @@ -1347,13 +1427,13 @@ Defined in node_modules/@types/node/base.d.ts:5491 ▪ **listener**: *function* -▸ (`chunk`: [Buffer](alignedlockablebuffer.md#buffer) | string): *void* +▸ (`chunk`: any): *void* **Parameters:** Name | Type | ------ | ------ | -`chunk` | [Buffer](alignedlockablebuffer.md#buffer) | string | +`chunk` | any | **Returns:** *this* @@ -1363,7 +1443,7 @@ Name | Type | *Overrides [SourceSource](../classes/sourcesource.md).[removeListener](../classes/sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5492 +Defined in node_modules/@types/node/stream.d.ts:90 **Parameters:** @@ -1381,7 +1461,7 @@ Defined in node_modules/@types/node/base.d.ts:5492 *Overrides [SourceSource](../classes/sourcesource.md).[removeListener](../classes/sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5493 +Defined in node_modules/@types/node/stream.d.ts:91 **Parameters:** @@ -1399,7 +1479,7 @@ Defined in node_modules/@types/node/base.d.ts:5493 *Overrides [SourceSource](../classes/sourcesource.md).[removeListener](../classes/sourcesource.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:5494 +Defined in node_modules/@types/node/stream.d.ts:92 **Parameters:** @@ -1417,6 +1497,30 @@ Name | Type | **Returns:** *this* +▸ **removeListener**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[removeListener](../classes/sparsefilterstream.md#removelistener)* + +*Overrides [SourceSource](../classes/sourcesource.md).[removeListener](../classes/sourcesource.md#removelistener)* + +Defined in node_modules/@types/node/stream.d.ts:93 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + ___ ### resume @@ -1425,7 +1529,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[resume](../classes/sparsefilterstream.md#resume)* -Defined in node_modules/@types/node/base.d.ts:5429 +Defined in node_modules/@types/node/stream.d.ts:28 **Returns:** *this* @@ -1437,7 +1541,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[setDefaultEncoding](../classes/sparsefilterstream.md#setdefaultencoding)* -Defined in node_modules/@types/node/base.d.ts:5609 +Defined in node_modules/@types/node/stream.d.ts:219 **Parameters:** @@ -1455,7 +1559,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[setEncoding](../classes/sparsefilterstream.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:5427 +Defined in node_modules/@types/node/stream.d.ts:26 **Parameters:** @@ -1473,7 +1577,7 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[setMaxListeners](../classes/countingwritable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:905 +Defined in node_modules/@types/node/events.d.ts:28 **Parameters:** @@ -1491,7 +1595,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[uncork](../classes/sparsefilterstream.md#uncork)* -Defined in node_modules/@types/node/base.d.ts:5614 +Defined in node_modules/@types/node/stream.d.ts:224 **Returns:** *void* @@ -1499,21 +1603,17 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: NodeJS.WritableStream): *this* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[unpipe](../classes/sparsefilterstream.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:5431 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/stream.d.ts:30 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | NodeJS.WritableStream | **Returns:** *this* @@ -1525,7 +1625,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[unshift](../classes/sparsefilterstream.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:5432 +Defined in node_modules/@types/node/stream.d.ts:31 **Parameters:** @@ -1543,7 +1643,7 @@ ___ *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[wrap](../classes/sparsefilterstream.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:5433 +Defined in node_modules/@types/node/stream.d.ts:32 **Parameters:** @@ -1557,26 +1657,26 @@ ___ ### write -▸ **write**(`chunk`: any, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[write](../classes/sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5607 +Defined in node_modules/@types/node/stream.d.ts:217 **Parameters:** Name | Type | ------ | ------ | `chunk` | any | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* -▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: Function): *boolean* +▸ **write**(`chunk`: any, `encoding?`: undefined | string, `cb?`: undefined | function): *boolean* *Inherited from [SparseFilterStream](../classes/sparsefilterstream.md).[write](../classes/sparsefilterstream.md#write)* -Defined in node_modules/@types/node/base.d.ts:5608 +Defined in node_modules/@types/node/stream.d.ts:218 **Parameters:** @@ -1584,7 +1684,7 @@ Name | Type | ------ | ------ | `chunk` | any | `encoding?` | undefined | string | -`cb?` | Function | +`cb?` | undefined | function | **Returns:** *boolean* @@ -1596,7 +1696,9 @@ ___ *Inherited from [CountingWritable](../classes/countingwritable.md).[listenerCount](../classes/countingwritable.md#static-listenercount)* -Defined in node_modules/@types/node/base.d.ts:895 +Defined in node_modules/@types/node/events.d.ts:17 + +**`deprecated`** since v4.0.0 **Parameters:** diff --git a/doc/interfaces/sparsereadable.md b/doc/interfaces/sparsereadable.md index a4931158..825b2662 100644 --- a/doc/interfaces/sparsereadable.md +++ b/doc/interfaces/sparsereadable.md @@ -23,6 +23,7 @@ ### Methods +* [[Symbol.asyncIterator]](sparsereadable.md#[symbol.asynciterator]) * [addListener](sparsereadable.md#addlistener) * [emit](sparsereadable.md#emit) * [eventNames](sparsereadable.md#eventnames) @@ -30,6 +31,7 @@ * [isPaused](sparsereadable.md#ispaused) * [listenerCount](sparsereadable.md#listenercount) * [listeners](sparsereadable.md#listeners) +* [off](sparsereadable.md#off) * [on](sparsereadable.md#on) * [once](sparsereadable.md#once) * [pause](sparsereadable.md#pause) @@ -37,6 +39,7 @@ * [prependListener](sparsereadable.md#prependlistener) * [prependOnceListener](sparsereadable.md#prependoncelistener) * [push](sparsereadable.md#push) +* [rawListeners](sparsereadable.md#rawlisteners) * [read](sparsereadable.md#read) * [removeAllListeners](sparsereadable.md#removealllisteners) * [removeListener](sparsereadable.md#removelistener) @@ -53,7 +56,7 @@ • **blocks**: *[BlocksWithChecksum](blockswithchecksum.md)[]* -*Defined in [lib/sparse-stream/shared.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L50)* +*Defined in [lib/sparse-stream/shared.ts:50](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L50)* ___ @@ -63,17 +66,29 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[readable](sparsereadable.md#readable)* -Defined in node_modules/@types/node/base.d.ts:401 +Defined in node_modules/@types/node/globals.d.ts:569 ## Methods +### [Symbol.asyncIterator] + +▸ **[Symbol.asyncIterator]**(): *AsyncIterableIterator‹string | [Buffer](alignedlockablebuffer.md#buffer)›* + +*Inherited from [SparseReadable](sparsereadable.md).[[Symbol.asyncIterator]](sparsereadable.md#[symbol.asynciterator])* + +Defined in node_modules/@types/node/globals.d.ts:580 + +**Returns:** *AsyncIterableIterator‹string | [Buffer](alignedlockablebuffer.md#buffer)›* + +___ + ### addListener ▸ **addListener**(`event`: string | symbol, `listener`: function): *this* *Inherited from [SparseReadable](sparsereadable.md).[addListener](sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:384 +Defined in node_modules/@types/node/globals.d.ts:550 **Parameters:** @@ -99,7 +114,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[emit](sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:392 +Defined in node_modules/@types/node/globals.d.ts:560 **Parameters:** @@ -118,7 +133,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[eventNames](sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:397 +Defined in node_modules/@types/node/globals.d.ts:565 **Returns:** *Array‹string | symbol›* @@ -130,7 +145,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[getMaxListeners](sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:390 +Defined in node_modules/@types/node/globals.d.ts:557 **Returns:** *number* @@ -142,7 +157,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[isPaused](sparsereadable.md#ispaused)* -Defined in node_modules/@types/node/base.d.ts:406 +Defined in node_modules/@types/node/globals.d.ts:574 **Returns:** *boolean* @@ -154,7 +169,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[listenerCount](sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:393 +Defined in node_modules/@types/node/globals.d.ts:561 **Parameters:** @@ -172,7 +187,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[listeners](sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:391 +Defined in node_modules/@types/node/globals.d.ts:558 **Parameters:** @@ -184,13 +199,39 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseReadable](sparsereadable.md).[off](sparsereadable.md#off)* + +Defined in node_modules/@types/node/globals.d.ts:554 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* *Inherited from [SparseReadable](sparsereadable.md).[on](sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:385 +Defined in node_modules/@types/node/globals.d.ts:551 **Parameters:** @@ -216,7 +257,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[once](sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:386 +Defined in node_modules/@types/node/globals.d.ts:552 **Parameters:** @@ -242,7 +283,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[pause](sparsereadable.md#pause)* -Defined in node_modules/@types/node/base.d.ts:404 +Defined in node_modules/@types/node/globals.d.ts:572 **Returns:** *this* @@ -254,7 +295,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[pipe](sparsereadable.md#pipe)* -Defined in node_modules/@types/node/base.d.ts:407 +Defined in node_modules/@types/node/globals.d.ts:575 **Type parameters:** @@ -277,7 +318,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[prependListener](sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:395 +Defined in node_modules/@types/node/globals.d.ts:563 **Parameters:** @@ -303,7 +344,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[prependOnceListener](sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:396 +Defined in node_modules/@types/node/globals.d.ts:564 **Parameters:** @@ -327,7 +368,7 @@ ___ ▸ **push**(`chunk`: [SparseStreamChunk](sparsestreamchunk.md)): *boolean* -*Defined in [lib/sparse-stream/shared.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L51)* +*Defined in [lib/sparse-stream/shared.ts:51](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L51)* **Parameters:** @@ -339,13 +380,31 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [SparseReadable](sparsereadable.md).[rawListeners](sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/globals.d.ts:559 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### read ▸ **read**(`size?`: undefined | number): *string | [Buffer](alignedlockablebuffer.md#buffer)* *Inherited from [SparseReadable](sparsereadable.md).[read](sparsereadable.md#read)* -Defined in node_modules/@types/node/base.d.ts:402 +Defined in node_modules/@types/node/globals.d.ts:570 **Parameters:** @@ -363,7 +422,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[removeAllListeners](sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:388 +Defined in node_modules/@types/node/globals.d.ts:555 **Parameters:** @@ -381,7 +440,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[removeListener](sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:387 +Defined in node_modules/@types/node/globals.d.ts:553 **Parameters:** @@ -407,7 +466,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[resume](sparsereadable.md#resume)* -Defined in node_modules/@types/node/base.d.ts:405 +Defined in node_modules/@types/node/globals.d.ts:573 **Returns:** *this* @@ -419,7 +478,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[setEncoding](sparsereadable.md#setencoding)* -Defined in node_modules/@types/node/base.d.ts:403 +Defined in node_modules/@types/node/globals.d.ts:571 **Parameters:** @@ -437,7 +496,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[setMaxListeners](sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:389 +Defined in node_modules/@types/node/globals.d.ts:556 **Parameters:** @@ -451,21 +510,17 @@ ___ ### unpipe -▸ **unpipe**<**T**>(`destination?`: T): *this* +▸ **unpipe**(`destination?`: WritableStream): *this* *Inherited from [SparseReadable](sparsereadable.md).[unpipe](sparsereadable.md#unpipe)* -Defined in node_modules/@types/node/base.d.ts:408 - -**Type parameters:** - -▪ **T**: *WritableStream* +Defined in node_modules/@types/node/globals.d.ts:576 **Parameters:** Name | Type | ------ | ------ | -`destination?` | T | +`destination?` | WritableStream | **Returns:** *this* @@ -477,7 +532,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[unshift](sparsereadable.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:409 +Defined in node_modules/@types/node/globals.d.ts:577 **Parameters:** @@ -491,7 +546,7 @@ Name | Type | *Inherited from [SparseReadable](sparsereadable.md).[unshift](sparsereadable.md#unshift)* -Defined in node_modules/@types/node/base.d.ts:410 +Defined in node_modules/@types/node/globals.d.ts:578 **Parameters:** @@ -509,7 +564,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[wrap](sparsereadable.md#wrap)* -Defined in node_modules/@types/node/base.d.ts:411 +Defined in node_modules/@types/node/globals.d.ts:579 **Parameters:** diff --git a/doc/interfaces/sparsereaderstate.md b/doc/interfaces/sparsereaderstate.md index b554d01c..6fd745ae 100644 --- a/doc/interfaces/sparsereaderstate.md +++ b/doc/interfaces/sparsereaderstate.md @@ -20,7 +20,7 @@ • **block**: *[BlocksWithChecksum](blockswithchecksum.md)* -*Defined in [lib/sparse-stream/shared.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L92)* +*Defined in [lib/sparse-stream/shared.ts:92](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L92)* ___ @@ -28,7 +28,7 @@ ___ • **hasher**? : *[AnyHasher](../README.md#anyhasher)* -*Defined in [lib/sparse-stream/shared.ts:94](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L94)* +*Defined in [lib/sparse-stream/shared.ts:94](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L94)* ___ @@ -36,4 +36,4 @@ ___ • **subBlock**: *[Block](block.md)* -*Defined in [lib/sparse-stream/shared.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L93)* +*Defined in [lib/sparse-stream/shared.ts:93](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L93)* diff --git a/doc/interfaces/sparsestreamchunk.md b/doc/interfaces/sparsestreamchunk.md index 672ca47a..a697a75b 100644 --- a/doc/interfaces/sparsestreamchunk.md +++ b/doc/interfaces/sparsestreamchunk.md @@ -19,7 +19,7 @@ • **buffer**: *[Buffer](alignedlockablebuffer.md#buffer) | [AlignedLockableBuffer](alignedlockablebuffer.md)* -*Defined in [lib/sparse-stream/shared.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L45)* +*Defined in [lib/sparse-stream/shared.ts:45](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L45)* ___ @@ -27,4 +27,4 @@ ___ • **position**: *number* -*Defined in [lib/sparse-stream/shared.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L46)* +*Defined in [lib/sparse-stream/shared.ts:46](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L46)* diff --git a/doc/interfaces/sparsewritable.md b/doc/interfaces/sparsewritable.md index 5fab226d..a9d4897a 100644 --- a/doc/interfaces/sparsewritable.md +++ b/doc/interfaces/sparsewritable.md @@ -29,10 +29,12 @@ * [getMaxListeners](sparsewritable.md#getmaxlisteners) * [listenerCount](sparsewritable.md#listenercount) * [listeners](sparsewritable.md#listeners) +* [off](sparsewritable.md#off) * [on](sparsewritable.md#on) * [once](sparsewritable.md#once) * [prependListener](sparsewritable.md#prependlistener) * [prependOnceListener](sparsewritable.md#prependoncelistener) +* [rawListeners](sparsewritable.md#rawlisteners) * [removeAllListeners](sparsewritable.md#removealllisteners) * [removeListener](sparsewritable.md#removelistener) * [setMaxListeners](sparsewritable.md#setmaxlisteners) @@ -46,7 +48,7 @@ *Inherited from [SparseWritable](sparsewritable.md).[writable](sparsewritable.md#writable)* -Defined in node_modules/@types/node/base.d.ts:415 +Defined in node_modules/@types/node/globals.d.ts:584 ## Methods @@ -54,7 +56,7 @@ Defined in node_modules/@types/node/base.d.ts:415 ▸ **_write**(`chunk`: [SparseStreamChunk](sparsestreamchunk.md), `encoding`: string, `callback`: function): *void* -*Defined in [lib/sparse-stream/shared.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/sparse-stream/shared.ts#L55)* +*Defined in [lib/sparse-stream/shared.ts:55](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/sparse-stream/shared.ts#L55)* **Parameters:** @@ -64,13 +66,13 @@ Defined in node_modules/@types/node/base.d.ts:415 ▪ **callback**: *function* -▸ (`err?`: [Error](../classes/notcapable.md#static-error) | void): *void* +▸ (`err?`: [Error](../classes/notcapable.md#static-error) | null): *void* **Parameters:** Name | Type | ------ | ------ | -`err?` | [Error](../classes/notcapable.md#static-error) | void | +`err?` | [Error](../classes/notcapable.md#static-error) | null | **Returns:** *void* @@ -82,7 +84,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[addListener](sparsereadable.md#addlistener)* -Defined in node_modules/@types/node/base.d.ts:384 +Defined in node_modules/@types/node/globals.d.ts:550 **Parameters:** @@ -108,7 +110,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[emit](sparsereadable.md#emit)* -Defined in node_modules/@types/node/base.d.ts:392 +Defined in node_modules/@types/node/globals.d.ts:560 **Parameters:** @@ -127,7 +129,7 @@ ___ *Inherited from [SparseWritable](sparsewritable.md).[end](sparsewritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:418 +Defined in node_modules/@types/node/globals.d.ts:587 **Parameters:** @@ -141,7 +143,7 @@ Name | Type | *Inherited from [SparseWritable](sparsewritable.md).[end](sparsewritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:419 +Defined in node_modules/@types/node/globals.d.ts:588 **Parameters:** @@ -156,7 +158,7 @@ Name | Type | *Inherited from [SparseWritable](sparsewritable.md).[end](sparsewritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:420 +Defined in node_modules/@types/node/globals.d.ts:589 **Parameters:** @@ -171,7 +173,7 @@ Name | Type | *Inherited from [SparseWritable](sparsewritable.md).[end](sparsewritable.md#end)* -Defined in node_modules/@types/node/base.d.ts:421 +Defined in node_modules/@types/node/globals.d.ts:590 **Parameters:** @@ -191,7 +193,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[eventNames](sparsereadable.md#eventnames)* -Defined in node_modules/@types/node/base.d.ts:397 +Defined in node_modules/@types/node/globals.d.ts:565 **Returns:** *Array‹string | symbol›* @@ -203,7 +205,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[getMaxListeners](sparsereadable.md#getmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:390 +Defined in node_modules/@types/node/globals.d.ts:557 **Returns:** *number* @@ -215,7 +217,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[listenerCount](sparsereadable.md#listenercount)* -Defined in node_modules/@types/node/base.d.ts:393 +Defined in node_modules/@types/node/globals.d.ts:561 **Parameters:** @@ -233,7 +235,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[listeners](sparsereadable.md#listeners)* -Defined in node_modules/@types/node/base.d.ts:391 +Defined in node_modules/@types/node/globals.d.ts:558 **Parameters:** @@ -245,13 +247,39 @@ Name | Type | ___ +### off + +▸ **off**(`event`: string | symbol, `listener`: function): *this* + +*Inherited from [SparseReadable](sparsereadable.md).[off](sparsereadable.md#off)* + +Defined in node_modules/@types/node/globals.d.ts:554 + +**Parameters:** + +▪ **event**: *string | symbol* + +▪ **listener**: *function* + +▸ (...`args`: any[]): *void* + +**Parameters:** + +Name | Type | +------ | ------ | +`...args` | any[] | + +**Returns:** *this* + +___ + ### on ▸ **on**(`event`: string | symbol, `listener`: function): *this* *Inherited from [SparseReadable](sparsereadable.md).[on](sparsereadable.md#on)* -Defined in node_modules/@types/node/base.d.ts:385 +Defined in node_modules/@types/node/globals.d.ts:551 **Parameters:** @@ -277,7 +305,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[once](sparsereadable.md#once)* -Defined in node_modules/@types/node/base.d.ts:386 +Defined in node_modules/@types/node/globals.d.ts:552 **Parameters:** @@ -303,7 +331,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[prependListener](sparsereadable.md#prependlistener)* -Defined in node_modules/@types/node/base.d.ts:395 +Defined in node_modules/@types/node/globals.d.ts:563 **Parameters:** @@ -329,7 +357,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[prependOnceListener](sparsereadable.md#prependoncelistener)* -Defined in node_modules/@types/node/base.d.ts:396 +Defined in node_modules/@types/node/globals.d.ts:564 **Parameters:** @@ -349,13 +377,31 @@ Name | Type | ___ +### rawListeners + +▸ **rawListeners**(`event`: string | symbol): *Function[]* + +*Inherited from [SparseReadable](sparsereadable.md).[rawListeners](sparsereadable.md#rawlisteners)* + +Defined in node_modules/@types/node/globals.d.ts:559 + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | string | symbol | + +**Returns:** *Function[]* + +___ + ### removeAllListeners ▸ **removeAllListeners**(`event?`: string | symbol): *this* *Inherited from [SparseReadable](sparsereadable.md).[removeAllListeners](sparsereadable.md#removealllisteners)* -Defined in node_modules/@types/node/base.d.ts:388 +Defined in node_modules/@types/node/globals.d.ts:555 **Parameters:** @@ -373,7 +419,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[removeListener](sparsereadable.md#removelistener)* -Defined in node_modules/@types/node/base.d.ts:387 +Defined in node_modules/@types/node/globals.d.ts:553 **Parameters:** @@ -399,7 +445,7 @@ ___ *Inherited from [SparseReadable](sparsereadable.md).[setMaxListeners](sparsereadable.md#setmaxlisteners)* -Defined in node_modules/@types/node/base.d.ts:389 +Defined in node_modules/@types/node/globals.d.ts:556 **Parameters:** @@ -417,7 +463,7 @@ ___ *Inherited from [SparseWritable](sparsewritable.md).[write](sparsewritable.md#write)* -Defined in node_modules/@types/node/base.d.ts:416 +Defined in node_modules/@types/node/globals.d.ts:585 **Parameters:** @@ -432,7 +478,7 @@ Name | Type | *Inherited from [SparseWritable](sparsewritable.md).[write](sparsewritable.md#write)* -Defined in node_modules/@types/node/base.d.ts:417 +Defined in node_modules/@types/node/globals.d.ts:586 **Parameters:** diff --git a/doc/interfaces/tmpfileresult.md b/doc/interfaces/tmpfileresult.md index 482880b5..090800c5 100644 --- a/doc/interfaces/tmpfileresult.md +++ b/doc/interfaces/tmpfileresult.md @@ -10,16 +10,16 @@ ### Properties -* [fd](tmpfileresult.md#optional-fd) +* [fileHandle](tmpfileresult.md#optional-filehandle) * [path](tmpfileresult.md#path) ## Properties -### `Optional` fd +### `Optional` fileHandle -• **fd**? : *undefined | number* +• **fileHandle**? : *fs.FileHandle* -*Defined in [lib/tmp.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/tmp.ts#L34)* +*Defined in [lib/tmp.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/tmp.ts#L33)* ___ @@ -27,4 +27,4 @@ ___ • **path**: *string* -*Defined in [lib/tmp.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/tmp.ts#L33)* +*Defined in [lib/tmp.ts:32](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/tmp.ts#L32)* diff --git a/doc/interfaces/wificonfig.md b/doc/interfaces/wificonfig.md index 93ede8c1..10a79d87 100644 --- a/doc/interfaces/wificonfig.md +++ b/doc/interfaces/wificonfig.md @@ -23,7 +23,7 @@ • **gateway**? : *undefined | string* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L38)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:38](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L38)* ___ @@ -31,7 +31,7 @@ ___ • **ip**? : *undefined | string* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L36)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:36](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L36)* ___ @@ -39,7 +39,7 @@ ___ • **netmask**? : *undefined | string* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L37)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:37](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L37)* ___ @@ -47,7 +47,7 @@ ___ • **routeMetric**? : *number | string* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L35)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:35](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L35)* ___ @@ -55,7 +55,7 @@ ___ • **wifiKey**? : *undefined | string* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L34)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:34](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L34)* ___ @@ -63,4 +63,4 @@ ___ • **wifiSsid**: *string* -*Defined in [lib/source-destination/configured-source/operations/configure.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/1a7a17c/lib/source-destination/configured-source/operations/configure.ts#L33)* +*Defined in [lib/source-destination/configured-source/operations/configure.ts:33](https://github.com/balena-io-modules/etcher-sdk/blob/d395dec/lib/source-destination/configured-source/operations/configure.ts#L33)*