Skip to content

fix(wktohtml): fix callback and return types#69493

Merged
typescript-bot merged 5 commits intoDefinitelyTyped:masterfrom
marievidal360:wktohtml-fixes
May 2, 2024
Merged

fix(wktohtml): fix callback and return types#69493
typescript-bot merged 5 commits intoDefinitelyTyped:masterfrom
marievidal360:wktohtml-fixes

Conversation

@marievidal360
Copy link
Copy Markdown
Contributor

@marievidal360 marievidal360 commented May 1, 2024

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: Sources of node-wkhtmltopdf
  • If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the package.json.
    • the fix is not linked to a change in the version of node-wkhtmltopdf (the current version is 3 years old)

In this PR, I:

  • fix the callback type
    • error is nullable
    • stream is optional
  • fix the return type
    • in the sources of node-wkhtmltopdf: wkhtmltopdf returns a ChildProcess.stdout which is a stream.Readable
    • stream.Readable is a subclass of NodeJS.ReadWriteStream

@marievidal360
fix(wkhtmltopdf): fix callback type
c9f9760 
In the sources of node-wkhtmltopdf
- error is nullable
- stream is optional
@marievidal360
fix(wkhtmltopdf): add optional callback in inputStream case
f0ed20a
@marievidal360
fix(wkhtmltopdf): fix return type
ad5c93a 
- in the sources of node-wkhtmltopdf: wkhtmltopdf returns a `ChildProcess.stdout` which is a `stream.Readable`
- `stream.Readable` is a subclass of `NodeJS.ReadWriteStream`
@marievidal360
refactor(wkhtmltopdf): move $ExpectType before tested expression
0273f5b 
On the same line, it was not always failing in case of error
@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented May 1, 2024 •
edited
Loading

@marievidal360 Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

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 type definition owners, DT maintainers or others

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": 69493,
  "author": "marievidal360",
  "headCommitOid": "9047c9cf3b793290bc89baeed3e386444a2a526a",
  "mergeBaseOid": "89bf9961959cf31dab577035bf475693cc9461a8",
  "lastPushDate": "2024-05-01T21:58:32.000Z",
  "lastActivityDate": "2024-05-02T14:05:41.000Z",
  "mergeOfferDate": "2024-05-02T14:02:36.000Z",
  "mergeRequestDate": "2024-05-02T14:05:41.000Z",
  "mergeRequestUser": "marievidal360",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "wkhtmltopdf",
      "kind": "edit",
      "files": [
        {
          "path": "types/wkhtmltopdf/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/wkhtmltopdf/wkhtmltopdf-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "digijap",
        "rensdewolf"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "rensdewolf",
      "date": "2024-05-02T14:02:59.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 2089200333,
  "ciResult": "pass"
}

@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented May 1, 2024

🔔 @digijap @rensdewolf — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

@typescript-bot typescript-bot added Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner labels May 2, 2024
@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented May 2, 2024

@marievidal360: Everything looks good here. I am ready to merge this PR (at 9047c9c) 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! ❤️

(@digijap, @rensdewolf: you can do this too.)

@rensdewolf
Copy link
Copy Markdown

rensdewolf commented May 2, 2024

Thank you for your changes.

@marievidal360
Copy link
Copy Markdown
Contributor Author

marievidal360 commented May 2, 2024

Ready to merge

@typescript-bot typescript-bot merged commit bc8f834 into DefinitelyTyped:master May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@rensdewolf rensdewolf rensdewolf approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@marievidal360 @typescript-bot @rensdewolf