Skip to content

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

Merged
typescript-bot merged 1 commit intoDefinitelyTyped:masterfrom
hkleungai:node-correct-stream-finished
Oct 22, 2024
Merged

fix(node): Correct the signature of finished() in stream/promises#70918
typescript-bot merged 1 commit intoDefinitelyTyped:masterfrom
hkleungai:node-correct-stream-finished

Conversation

@hkleungai
Copy link
Copy Markdown
Contributor

@hkleungai hkleungai commented Oct 16, 2024

The cleanup option is added to the promise version of stream.finished(stream[, options]) since v19.1.0, v18.13.0. DT type should hence reflect this change.


Please fill in this template.

Select one of these and delete the others:

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>

@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented Oct 16, 2024

@hkleungai Thank you for submitting this PR!

This is a live comment that I will keep updated.

1 package in this PR

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Most recent commit is approved by a DT maintainer

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 70918,
  "author": "hkleungai",
  "headCommitOid": "3c52355929ce9c522a4bd1f5d0392a44f28ba435",
  "mergeBaseOid": "367fcd5cc72baeab1c7fa927f774a36ec7685c69",
  "lastPushDate": "2024-10-16T16:54:10.000Z",
  "lastActivityDate": "2024-10-22T02:12:36.000Z",
  "mergeOfferDate": "2024-10-21T23:21:03.000Z",
  "mergeRequestDate": "2024-10-22T02:12:36.000Z",
  "mergeRequestUser": "hkleungai",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "node",
      "kind": "edit",
      "files": [
        {
          "path": "types/node/stream/promises.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/test/stream.ts",
          "kind": "test"
        },
        {
          "path": "types/node/v18/stream/promises.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v18/test/stream.ts",
          "kind": "test"
        },
        {
          "path": "types/node/v20/stream/promises.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v20/test/stream.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "Microsoft",
        "jkomyno",
        "alvis",
        "r3nya",
        "btoueg",
        "smac89",
        "touffy",
        "DeividasBakanas",
        "eyqs",
        "Hannes-Magnusson-CK",
        "hoo29",
        "kjin",
        "ajafff",
        "islishude",
        "mwiktorczyk",
        "mohsen1",
        "galkin",
        "parambirs",
        "eps1lon",
        "ThomasdenH",
        "WilcoBakker",
        "wwwy3y3",
        "samuela",
        "kuehlein",
        "bhongy",
        "chyzwar",
        "trivikr",
        "yoursunny",
        "qwelias",
        "ExE-Boss",
        "peterblazejewicz",
        "addaleax",
        "victorperin",
        "ZYSzys",
        "NodeJS",
        "LinusU",
        "wafuwafu13",
        "mcollina",
        "Semigradsky"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "jakebailey",
      "date": "2024-10-21T23:20:27.000Z",
      "isMaintainer": true
    }
  ],
  "mainBotCommentID": 2417396365,
  "ciResult": "pass"
}

@typescript-bot
Copy link
Copy Markdown
Contributor

@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Oct 16, 2024
@typescript-bot
Copy link
Copy Markdown
Contributor

@hkleungai The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds that are failing do not end up on the list of PRs for the DT maintainers to review.

@hkleungai
Copy link
Copy Markdown
Contributor Author

Note: CI build fails due to downstream package. I am currently asking author of #70868 to see if he can help with this.

@jakebailey jakebailey closed this Oct 18, 2024
@jakebailey jakebailey reopened this Oct 18, 2024
@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Oct 18, 2024
@typescript-bot typescript-bot added the Revision needed This PR needs code changes before it can be merged. label Oct 19, 2024
@typescript-bot
Copy link
Copy Markdown
Contributor

@hkleungai One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits. Thank you!

@hkleungai hkleungai force-pushed the node-correct-stream-finished branch from af5459b to 16194ac Compare October 19, 2024 04:05
@hkleungai hkleungai requested a review from jakebailey October 19, 2024 04:06
@typescript-bot typescript-bot removed the Revision needed This PR needs code changes before it can be merged. label Oct 19, 2024
@typescript-bot
Copy link
Copy Markdown
Contributor

@jakebailey Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@hkleungai hkleungai force-pushed the node-correct-stream-finished branch from 16194ac to 3c52355 Compare October 20, 2024 04:32
@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Oct 21, 2024
@typescript-bot
Copy link
Copy Markdown
Contributor

@hkleungai: Everything looks good here. I am ready to merge this PR (at 3c52355) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@microsoft, @jkomyno, @alvis, @r3nya, @btoueg, @smac89, @Touffy, @DeividasBakanas, @eyqs, @Hannes-Magnusson-CK, @hoo29, @kjin, @ajafff, @islishude, @mwiktorczyk, @mohsen1, @galkin, @parambirs, @eps1lon, @ThomasdenH, @WilcoBakker, @wwwy3y3, @samuela, @kuehlein, @bhongy, @chyzwar, @trivikr, @yoursunny, @qwelias, @ExE-Boss, @peterblazejewicz, @addaleax, @victorperin, @ZYSzys, @nodejs, @LinusU, @wafuwafu13, @mcollina, @Semigradsky: you can do this too.)

@hkleungai
Copy link
Copy Markdown
Contributor Author

Ready to merge

@typescript-bot typescript-bot merged commit 928c16c into DefinitelyTyped:master Oct 22, 2024
@hkleungai hkleungai deleted the node-correct-stream-finished branch October 22, 2024 02:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Critical package Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants