Stream overview
Added in v1.0.0
Table of contents
combinators
pipeThroughDuplex
Signature
export declare const pipeThroughDuplex: {
<E2, B = Uint8Array>(
duplex: LazyArg<Duplex>,
onError: (error: unknown) => E2,
options?: FromReadableOptions & FromWritableOptions
): <R, E, A>(self: Stream<R, E, A>) => Stream<R, E2 | E, B>
<R, E, A, E2, B = Uint8Array>(
self: Stream<R, E, A>,
duplex: LazyArg<Duplex>,
onError: (error: unknown) => E2,
options?: FromReadableOptions & FromWritableOptions
): Stream<R, E | E2, B>
}
Added in v1.0.0
pipeThroughSimple
Signature
export declare const pipeThroughSimple: {
(duplex: LazyArg<Duplex>): <R, E>(self: Stream<R, E, string | Uint8Array>) => Stream<R, E | PlatformError, Uint8Array>
<R, E>(self: Stream<R, E, string | Uint8Array>, duplex: LazyArg<Duplex>): Stream<R, E | PlatformError, Uint8Array>
}
Added in v1.0.0
constructors
fromDuplex
Signature
export declare const fromDuplex: <IE, E, I = Uint8Array, O = Uint8Array>(
evaluate: LazyArg<Duplex>,
onError: (error: unknown) => E,
options?: FromReadableOptions & FromWritableOptions
) => Channel<never, IE, Chunk<I>, unknown, IE | E, Chunk<O>, void>
Added in v1.0.0
fromReadable
Signature
export declare const fromReadable: <E, A = Uint8Array>(
evaluate: LazyArg<Readable | NodeJS.ReadableStream>,
onError: (error: unknown) => E,
{ chunkSize }?: FromReadableOptions
) => Stream<never, E, A>
Added in v1.0.0
fromReadableChannel
Signature
export declare const fromReadableChannel: <E, A = Uint8Array>(
evaluate: LazyArg<Readable | NodeJS.ReadableStream>,
onError: (error: unknown) => E,
chunkSize: number | undefined
) => Channel<never, unknown, unknown, unknown, E, Chunk<A>, void>
Added in v1.0.0
conversions
toString
Signature
export declare const toString: <E>(
readable: LazyArg<Readable | NodeJS.ReadableStream>,
options: {
readonly onFailure: (error: unknown) => E
readonly encoding?: BufferEncoding | undefined
readonly maxBytes?: SizeInput | undefined
}
) => Effect<never, E, string>
Added in v1.0.0
toUint8Array
Signature
export declare const toUint8Array: <E>(
readable: LazyArg<Readable | NodeJS.ReadableStream>,
options: { readonly onFailure: (error: unknown) => E; readonly maxBytes?: SizeInput | undefined }
) => Effect<never, E, Uint8Array>
Added in v1.0.0
model
FromWritableOptions (interface)
Signature
export interface FromWritableOptions {
readonly endOnDone?: boolean
readonly encoding?: BufferEncoding
}
Added in v1.0.0
models
FromReadableOptions (interface)
Signature
export interface FromReadableOptions {
/** Defaults to undefined, which lets Node.js decide the chunk size */
readonly chunkSize?: SizeInput
}
Added in v1.0.0