sparseStream.md

etcher-sdk / sparseStream

Namespace: sparseStream

Table of contents

Classes

• SparseFilterStream
• SparseReadStream
• SparseWriteStream

Interfaces

• Block
• BlocksWithChecksum
• SparseReadable
• SparseReaderState
• SparseStreamChunk
• SparseWritable

Type Aliases

• ChecksumType

Variables

• ProgressSparseWriteStream

Functions

• blocksLength
• createSparseReaderStateIterator

Type Aliases

ChecksumType

Ƭ ChecksumType: "crc32" | "sha1" | "sha256" | "xxhash3"

Defined in

lib/sparse-stream/shared.ts:25

Variables

ProgressSparseWriteStream

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

Defined in

lib/sparse-stream/sparse-write-stream.ts:137

Functions

blocksLength

▸ blocksLength(blocks): number

Parameters

Name	Type
blocks	BlocksWithChecksum[]

Returns

number

Defined in

lib/sparse-stream/shared.ts:117

---

createSparseReaderStateIterator

▸ createSparseReaderStateIterator(blocks, verify, generateChecksums): Iterator<SparseReaderState>

Parameters

Name	Type
blocks	BlocksWithChecksum[]
verify	boolean
generateChecksums	boolean

Returns

Iterator<SparseReaderState>

Defined in

lib/sparse-stream/shared.ts:75