Skip to content

Add Flow lib defs for Node.js streams fromWeb/toWeb #54615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
robhogan wants to merge 1 commit into from
Closed

Add Flow lib defs for Node.js streams fromWeb/toWeb #54615

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 37 additions & 5 deletions flow-typed/environment/node.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2539,7 +2539,14 @@ declare class stream$Readable extends stream$Stream {
static from(
iterable: Iterable<any> | AsyncIterable<any>,
options?: readableStreamOptions,
): stream$Readable;
): this;

static fromWeb(
readableStream: ReadableStream,
options?: readableStreamOptions,
): this;

static toWeb(streamReadable: stream$Readable): ReadableStream;

constructor(options?: readableStreamOptions): void;
destroy(error?: Error): this;
Expand Down Expand Up @@ -2586,6 +2593,13 @@ type writableStreamOptions = {
...
};
declare class stream$Writable extends stream$Stream {
static fromWeb(
writableStream: WritableStream,
options?: writableStreamOptions,
): this;

static toWeb(streamWritable: stream$Writable): WritableStream;

constructor(options?: writableStreamOptions): void;
cork(): void;
destroy(error?: Error): this;
Expand Down Expand Up @@ -2627,10 +2641,6 @@ declare class stream$Writable extends stream$Stream {
_final(callback: (error?: Error) => void): void;
}

//According to the NodeJS docs:
//"Since JavaScript doesn't have multiple prototypal inheritance, this class
//prototypally inherits from Readable, and then parasitically from Writable."
//Source: <https://nodejs.org/api/stream.html#stream_class_stream_duplex_1
type duplexStreamOptions = writableStreamOptions &
readableStreamOptions & {
allowHalfOpen?: boolean,
Expand All @@ -2641,6 +2651,28 @@ type duplexStreamOptions = writableStreamOptions &
...
};
declare class stream$Duplex extends stream$Readable mixins stream$Writable {
// This is an unusual class at runtime, per the docs it "prototypally extends from Readable,
// and then parasitically from Writable." Its static methods have incompatible signatures
// with Readable's, which Flow doesn't like.
// See https://nodejs.org/api/stream.html#stream_class_stream_duplex_1

// $FlowFixMe[incompatible-exact] See above
// $FlowFixMe[incompatible-type] See above
static fromWeb(
pair: $ReadOnly<{
readable: ReadableStream,
writable: WritableStream,
}>,
options?: duplexStreamOptions,
): this;

// $FlowFixMe[incompatible-type] See above
static toWeb(streamDuplex: stream$Duplex): {
readable: ReadableStream,
writable: WritableStream,
...
};

constructor(options?: duplexStreamOptions): void;
}
type transformStreamOptions = duplexStreamOptions & {
Expand Down
Loading