UNPKG

@kawaz/stream-bridge

Version:

A utility library that provides bidirectional conversion between Node.js streams and Web Stream API streams

github.com/kawaz/stream-bridge

kawaz/stream-bridge

54 lines (53 loc) • 2.84 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import { Duplex, Readable, Transform, Writable } from 'node:stream'; /** * Converts a Node.js Readable stream to a Web ReadableStream * @param readable The Node.js Readable stream to convert * @returns A Web ReadableStream with the same functionality */ export declare function toReadableStream<T = Uint8Array>(readable: Readable): ReadableStream<T>; /** * Converts a Node.js Writable stream to a Web WritableStream * @param writable The Node.js Writable stream to convert * @returns A Web WritableStream with the same functionality */ export declare function toWritableStream<T = Uint8Array>(writable: Writable): WritableStream<T>; /** * Converts a Node.js Transform or Duplex stream to a Web TransformStream * @param duplex The Node.js Transform or Duplex stream to convert * @returns A Web TransformStream with the same functionality */ export declare function toTransformStream<T = Uint8Array, O = Uint8Array>(duplex: Transform | Duplex): TransformStream<T, O>; /** * Converts a Node.js Duplex stream to a Web ReadableWritablePair * @param duplex The Node.js Duplex stream to convert * @returns A Web ReadableWritablePair with the same functionality */ export declare function toReadableWritablePair<R = unknown, W = unknown>(duplex: Duplex): ReadableWritablePair<R, W>; /** * Converts a Web ReadableStream to a Node.js Readable stream * @param readableStream The Web ReadableStream to convert * @param options Options passed to the Readable.fromWeb method * @returns A Node.js Readable stream with the same functionality */ export declare function toReadable(readableStream: ReadableStream, options?: Parameters<typeof Readable.fromWeb>[1]): Readable; /** * Converts a Web WritableStream to a Node.js Writable stream * @param writableStream The Web WritableStream to convert * @param options Options passed to the Writable.fromWeb method * @returns A Node.js Writable stream with the same functionality */ export declare function toWritable(writableStream: WritableStream, options?: Parameters<typeof Writable.fromWeb>[1]): Writable; /** * Converts a Web TransformStream to a Node.js Transform stream * @param transformStream The Web TransformStream to convert * @param options Options passed to the Transform.fromWeb method * @returns A Node.js Transform stream with the same functionality */ export declare function toTransform(transformStream: TransformStream, options?: Parameters<typeof Transform.fromWeb>[1]): Transform; /** * Converts a Web TransformStream to a Node.js Duplex stream * @param transformStream The Web TransformStream to convert * @param options Options passed to the Duplex.fromWeb method * @returns A Node.js Duplex stream with the same functionality */ export declare function toDuplex(transformStream: TransformStream, options?: Parameters<typeof Duplex.fromWeb>[1]): Duplex;