Skip to content

fix(node): Correct the signature of finished() in stream/promises #70918

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

Merged
typescript-bot merged 1 commit into from
Oct 22, 2024
Merged

fix(node): Correct the signature of finished() in stream/promises #70918

Show file tree
Hide file tree
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
9 changes: 8 additions & 1 deletion types/node/stream/promises.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
declare module "stream/promises" {
import {
FinishedOptions,
FinishedOptions as _FinishedOptions,
PipelineDestination,
PipelineOptions,
PipelinePromise,
PipelineSource,
PipelineTransform,
} from "node:stream";
interface FinishedOptions extends _FinishedOptions {
/**
* If true, removes the listeners registered by this function before the promise is fulfilled.
* @default false
*/
cleanup?: boolean | undefined;
}
function finished(
stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream,
options?: FinishedOptions,
Expand Down
14 changes: 13 additions & 1 deletion types/node/test/stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { Http2ServerResponse } from "node:http2";
import { performance } from "node:perf_hooks";
import { stdout } from "node:process";
import { arrayBuffer, blob, buffer, json, text } from "node:stream/consumers";
import { pipeline as pipelinePromise } from "node:stream/promises";
import { finished as finishedPromise, pipeline as pipelinePromise } from "node:stream/promises";
import { ReadableStream, TransformStream, WritableStream } from "node:stream/web";
import { setInterval as every, setTimeout as wait } from "node:timers/promises";
import { MessageChannel as NodeMC } from "node:worker_threads";
Expand Down Expand Up @@ -221,7 +221,19 @@ function streamPipelineFinished() {
async function asyncStreamPipelineFinished() {
const fin = promisify(finished);
await fin(process.stdin);
await fin(process.stdin, { error: false });
await fin(process.stdin, { readable: false });
await fin(process.stdin, { writable: false });
await fin(process.stdin, { signal: new AbortSignal() });
// @ts-expect-error -- callback version does not allow `options.cleanup`
await fin(process.stdin, { cleanup: false });

await finishedPromise(process.stdin);
await finishedPromise(process.stdin, { error: false });
await finishedPromise(process.stdin, { readable: false });
await finishedPromise(process.stdin, { writable: false });
await finishedPromise(process.stdin, { signal: new AbortSignal() });
await finishedPromise(process.stdin, { cleanup: false });

const pipe = promisify(pipeline);
await pipe(process.stdin, process.stdout);
Expand Down
9 changes: 8 additions & 1 deletion types/node/v18/stream/promises.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
declare module "stream/promises" {
import {
FinishedOptions,
FinishedOptions as _FinishedOptions,
PipelineDestination,
PipelineOptions,
PipelinePromise,
PipelineSource,
PipelineTransform,
} from "node:stream";
interface FinishedOptions extends _FinishedOptions {
/**
* If true, removes the listeners registered by this function before the promise is fulfilled.
* @default false
*/
cleanup?: boolean | undefined;
}
function finished(
stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream,
options?: FinishedOptions,
Expand Down
14 changes: 13 additions & 1 deletion types/node/v18/test/stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { Http2ServerResponse } from "node:http2";
import { performance } from "node:perf_hooks";
import { stdout } from "node:process";
import { arrayBuffer, blob, buffer, json, text } from "node:stream/consumers";
import { pipeline as pipelinePromise } from "node:stream/promises";
import { finished as finishedPromise, pipeline as pipelinePromise } from "node:stream/promises";
import { ReadableStream, TransformStream, WritableStream } from "node:stream/web";
import { setInterval as every } from "node:timers/promises";
import { MessageChannel as NodeMC } from "node:worker_threads";
Expand Down Expand Up @@ -219,7 +219,19 @@ function streamPipelineFinished() {
async function asyncStreamPipelineFinished() {
const fin = promisify(finished);
await fin(process.stdin);
await fin(process.stdin, { error: false });
await fin(process.stdin, { readable: false });
await fin(process.stdin, { writable: false });
await fin(process.stdin, { signal: new AbortSignal() });
// @ts-expect-error -- callback version does not allow `options.cleanup`
await fin(process.stdin, { cleanup: false });

await finishedPromise(process.stdin);
await finishedPromise(process.stdin, { error: false });
await finishedPromise(process.stdin, { readable: false });
await finishedPromise(process.stdin, { writable: false });
await finishedPromise(process.stdin, { signal: new AbortSignal() });
await finishedPromise(process.stdin, { cleanup: false });

const pipe = promisify(pipeline);
await pipe(process.stdin, process.stdout);
Expand Down
9 changes: 8 additions & 1 deletion types/node/v20/stream/promises.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
declare module "stream/promises" {
import {
FinishedOptions,
FinishedOptions as _FinishedOptions,
PipelineDestination,
PipelineOptions,
PipelinePromise,
PipelineSource,
PipelineTransform,
} from "node:stream";
interface FinishedOptions extends _FinishedOptions {
/**
* If true, removes the listeners registered by this function before the promise is fulfilled.
* @default false
*/
cleanup?: boolean | undefined;
}
function finished(
stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream,
options?: FinishedOptions,
Expand Down
14 changes: 13 additions & 1 deletion types/node/v20/test/stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { Http2ServerResponse } from "node:http2";
import { performance } from "node:perf_hooks";
import { stdout } from "node:process";
import { arrayBuffer, blob, buffer, json, text } from "node:stream/consumers";
import { pipeline as pipelinePromise } from "node:stream/promises";
import { finished as finishedPromise, pipeline as pipelinePromise } from "node:stream/promises";
import { ReadableStream, TransformStream, WritableStream } from "node:stream/web";
import { setInterval as every, setTimeout as wait } from "node:timers/promises";
import { MessageChannel as NodeMC } from "node:worker_threads";
Expand Down Expand Up @@ -220,7 +220,19 @@ function streamPipelineFinished() {
async function asyncStreamPipelineFinished() {
const fin = promisify(finished);
await fin(process.stdin);
await fin(process.stdin, { error: false });
await fin(process.stdin, { readable: false });
await fin(process.stdin, { writable: false });
await fin(process.stdin, { signal: new AbortSignal() });
// @ts-expect-error -- callback version does not allow `options.cleanup`
await fin(process.stdin, { cleanup: false });

await finishedPromise(process.stdin);
await finishedPromise(process.stdin, { error: false });
await finishedPromise(process.stdin, { readable: false });
await finishedPromise(process.stdin, { writable: false });
await finishedPromise(process.stdin, { signal: new AbortSignal() });
await finishedPromise(process.stdin, { cleanup: false });

const pipe = promisify(pipeline);
await pipe(process.stdin, process.stdout);
Expand Down