Skip to content

Commit 402001f

Browse files
robhoganmeta-codesync[bot]
authored andcommitted
Add missing stream state properties to Flow defs (#56224)
Summary: Pull Request resolved: #56224 Add standard Node.js stream properties to the Flow type definitions for `stream$Readable` and `stream$Writable` that were previously missing: - `stream$Readable`: - [`closed: boolean`](https://nodejs.org/api/stream.html#readableclosed) - [`destroyed: boolean`](https://nodejs.org/api/stream.html#readabledestroyed) - [`errored: ?Error`](https://nodejs.org/api/stream.html#readableerrored) - [`readableEnded: boolean`](https://nodejs.org/api/stream.html#readablereadableended) - [`readableAborted: boolean`](https://nodejs.org/api/stream.html#readablereadableaborted) - [`readableDidRead: boolean`](https://nodejs.org/api/stream.html#readablereadabledidread) - [`readableFlowing: ?boolean`](https://nodejs.org/api/stream.html#readablereadableflowing) - [`readableObjectMode: boolean`](https://nodejs.org/api/stream.html#readablereadableobjectmode) - `stream$Writable`: - [`closed: boolean`](https://nodejs.org/api/stream.html#writableclosed) - [`destroyed: boolean`](https://nodejs.org/api/stream.html#writabledestroyed) - [`errored: ?Error`](https://nodejs.org/api/stream.html#writableerrored) - [`writableEnded: boolean`](https://nodejs.org/api/stream.html#writablewritableended) - [`writableAborted: boolean`](https://nodejs.org/api/stream.html#writablewritableaborted) - [`writableFinished: boolean`](https://nodejs.org/api/stream.html#writablewritablefinished) - [`writableNeedDrain: boolean`](https://nodejs.org/api/stream.html#writablewritableneeddrain) - [`writableObjectMode: boolean`](https://nodejs.org/api/stream.html#writablewritableobjectmode) Docs: https://nodejs.org/api/stream.html These properties exist on all Node.js streams and are needed by Metro to detect when HTTP response streams have been closed by a client disconnect. Changelog: [Internal] Reviewed By: christophpurrer Differential Revision: D98176491 fbshipit-source-id: 2407367c52e5ece9099289ffd18642bdc4a7047d
1 parent 6e7797d commit 402001f

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

flow-typed/environment/node.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3610,14 +3610,22 @@ declare class stream$Readable extends stream$Stream {
36103610
static toWeb(streamReadable: stream$Readable): ReadableStream;
36113611

36123612
constructor(options?: readableStreamOptions): void;
3613+
closed: boolean;
36133614
destroy(error?: Error): this;
3615+
destroyed: boolean;
3616+
errored: ?Error;
36143617
isPaused(): boolean;
36153618
pause(): this;
36163619
pipe<T extends stream$Writable>(dest: T, options?: {end?: boolean, ...}): T;
36173620
read(size?: number): ?(string | Buffer);
36183621
readable: boolean;
3622+
readableAborted: boolean;
3623+
readableDidRead: boolean;
3624+
readableEnded: boolean;
3625+
readableFlowing: boolean | null;
36193626
readableHighWaterMark: number;
36203627
readableLength: number;
3628+
readableObjectMode: boolean;
36213629
resume(): this;
36223630
setEncoding(encoding: string): this;
36233631
unpipe(dest?: stream$Writable): this;
@@ -3662,20 +3670,28 @@ declare class stream$Writable extends stream$Stream {
36623670
static toWeb(streamWritable: stream$Writable): WritableStream;
36633671

36643672
constructor(options?: writableStreamOptions): void;
3673+
closed: boolean;
36653674
cork(): void;
36663675
destroy(error?: Error): this;
3676+
destroyed: boolean;
36673677
end(callback?: () => void): this;
36683678
end(chunk?: string | Buffer | Uint8Array, callback?: () => void): this;
36693679
end(
36703680
chunk?: string | Buffer | Uint8Array,
36713681
encoding?: string,
36723682
callback?: () => void,
36733683
): this;
3684+
errored: ?Error;
36743685
setDefaultEncoding(encoding: string): this;
36753686
uncork(): void;
36763687
writable: boolean;
3688+
writableAborted: boolean;
3689+
writableEnded: boolean;
3690+
writableFinished: boolean;
36773691
writableHighWaterMark: number;
36783692
writableLength: number;
3693+
writableNeedDrain: boolean;
3694+
writableObjectMode: boolean;
36793695
write(
36803696
chunk: string | Buffer | Uint8Array,
36813697
callback?: (error?: Error) => void,

0 commit comments

Comments
 (0)