stream.md

@wholebuzz/fs / Exports / stream

Module: stream

Table of contents

Functions

• handleAsyncFunctionCallback
• hashStream
• openNullReadable
• openNullWritable
• pipeAsyncFilter
• pipeFilter
• pipeFromAsyncFilter
• pipeFromFilter
• pipeFromSyncFilter
• pipeSyncFilter
• readableToArray
• readableToBuffer
• readableToString
• readableToValue
• shardReadable
• shardWritables
• streamAsyncFilter
• streamFilter
• streamSyncFilter
• writableToString

Functions

handleAsyncFunctionCallback

▸ handleAsyncFunctionCallback<X>(running: X | Promise<X>, callback: (err?: Error) => void, success?: (x: X) => void): void

Type parameters

Name
X

Parameters

Name	Type
running	X | Promise<X>
callback	(err?: Error) => void
success?	(x: X) => void

Returns: void

Defined in: src/stream.ts:252

---

hashStream

▸ hashStream(stream: Readable): Promise<string | null>

Hashes a [[Readable]] stream.

Parameters

Name	Type	Description
stream	Readable	The stream to compute the hash of.

Returns: Promise<string | null>

Defined in: src/stream.ts:231

---

openNullReadable

▸ Const openNullReadable(options?: { objectMode?: boolean }): ReadableStreamTree

Parameters

Name	Type
options?	object
options.objectMode?	boolean

Returns: ReadableStreamTree

Defined in: src/stream.ts:5

---

openNullWritable

▸ Const openNullWritable(options?: { objectMode?: boolean }): WritableStreamTree

Parameters

Name	Type
options?	object
options.objectMode?	boolean

Returns: WritableStreamTree

Defined in: src/stream.ts:15

---

pipeAsyncFilter

▸ pipeAsyncFilter(stream: ReadableStreamTree, filter: (x: any) => any): ReadableStreamTree

Pipe async filter stream.

Parameters

Name	Type
stream	ReadableStreamTree
filter	(x: any) => any

Returns: ReadableStreamTree

Defined in: src/stream.ts:143

---

pipeFilter

▸ pipeFilter(stream: ReadableStreamTree, filter: (x: any) => any): ReadableStreamTree

Pipe filter stream.

Parameters

Name	Type
stream	ReadableStreamTree
filter	(x: any) => any

Returns: ReadableStreamTree

Defined in: src/stream.ts:129

---

pipeFromAsyncFilter

▸ pipeFromAsyncFilter(stream: WritableStreamTree, filter: (x: any) => any): WritableStreamTree

Pipe from async filter stream.

Parameters

Name	Type
stream	WritableStreamTree
filter	(x: any) => any

Returns: WritableStreamTree

Defined in: src/stream.ts:164

---

pipeFromFilter

▸ pipeFromFilter(stream: WritableStreamTree, filter: (x: any) => any): WritableStreamTree

Pipe from filter stream.

Parameters

Name	Type
stream	WritableStreamTree
filter	(x: any) => any

Returns: WritableStreamTree

Defined in: src/stream.ts:150

---

pipeFromSyncFilter

▸ pipeFromSyncFilter(stream: WritableStreamTree, filter: (x: any) => any): WritableStreamTree

Pipe from sync filter stream.

Parameters

Name	Type
stream	WritableStreamTree
filter	(x: any) => any

Returns: WritableStreamTree

Defined in: src/stream.ts:157

---

pipeSyncFilter

▸ pipeSyncFilter(stream: ReadableStreamTree, filter: (x: any) => any): ReadableStreamTree

Pipe sync filter stream.

Parameters

Name	Type
stream	ReadableStreamTree
filter	(x: any) => any

Returns: ReadableStreamTree

Defined in: src/stream.ts:136

---

readableToArray

▸ readableToArray(stream: ReadableStreamTree): Promise<unknown[]>

Parameters

Name	Type
stream	ReadableStreamTree

Returns: Promise<unknown[]>

Defined in: src/stream.ts:38

---

readableToBuffer

▸ readableToBuffer(stream: Readable): Promise<Buffer>

Parameters

Name	Type
stream	Readable

Returns: Promise<Buffer>

Defined in: src/stream.ts:29

---

readableToString

▸ readableToString(stream: Readable): Promise<string>

Parameters

Name	Type
stream	Readable

Returns: Promise<string>

Defined in: src/stream.ts:25

---

readableToValue

▸ readableToValue(stream: ReadableStreamTree): Promise<unknown>

Parameters

Name	Type
stream	ReadableStreamTree

Returns: Promise<unknown>

Defined in: src/stream.ts:52

---

shardReadable

▸ shardReadable(input: ReadableStreamTree, shards?: number, shardFunction?: (x: object, modulus: number) => number): ReadableStreamTree[]

Split input by shardFunction

Parameters

Name	Type
input	ReadableStreamTree
shards?	number
shardFunction?	(x: object, modulus: number) => number

Returns: ReadableStreamTree[]

Defined in: src/stream.ts:171

---

shardWritables

▸ shardWritables(writable: WritableStreamTree[], shards?: number, shardFunction?: (x: object, modulus: number) => number): WritableStreamTree

Split input by shardFunction

Parameters

Name	Type
writable	WritableStreamTree[]
shards?	number
shardFunction?	(x: object, modulus: number) => number

Returns: WritableStreamTree

Defined in: src/stream.ts:188

---

streamAsyncFilter

▸ streamAsyncFilter(filter: (x: any) => any): Transform

Create async filter stream.

Parameters

Name	Type
filter	(x: any) => any

Returns: Transform

Defined in: src/stream.ts:110

---

streamFilter

▸ streamFilter(filter: (x: any) => any): Transform

Create sync or async filter stream.

Parameters

Name	Type
filter	(x: any) => any

Returns: Transform

Defined in: src/stream.ts:82

---

streamSyncFilter

▸ streamSyncFilter(filter: (x: any) => any): Transform

Create sync filter stream.

Parameters

Name	Type
filter	(x: any) => any

Returns: Transform

Defined in: src/stream.ts:96

---

writableToString

▸ writableToString(target: { value: string }): WritableStreamTree

Parameters

Name	Type
target	object
target.value	string

Returns: WritableStreamTree

Defined in: src/stream.ts:67