Skip to content
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.

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

fix(@types/k6): exact optional property type mismatch #69636

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

wuhkuh
Copy link

@wuhkuh wuhkuh commented May 18, 2024

The provided type did not compile when exactOptionalPropertyTypes is configured. This commit resolves the compiler error encountered when compiling in this mode.


Please fill in this template.

If changing an existing definition:


I can't seem to get the packages tested individually (my Node+TS setup is segfaulting since a recent upgrade).
So I'll try to rely on CI to test my changes; my goal here is to make my local patch available to the repository, no strings attached.

Do note that Node's types also had this typing problem a while ago.
I opted for this solution to not break the signature of the typing library, but there are other solutions, too, such as allowing explicit undefineds in the extended types.

The provided type did not compile when `exactOptionalPropertyTypes`
is configured. This commit resolves the compiler error encountered
when compiling in this mode.
@typescript-bot
Copy link
Contributor

typescript-bot commented May 18, 2024

@wuhkuh 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

This PR can be merged once it's reviewed.

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 or DT maintainers

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

Inactive

This PR has been inactive for 15 days — please try to get reviewers!


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 69636,
  "author": "wuhkuh",
  "headCommitOid": "aaf2e9157676f34a3191f24bdfcd7793ef22e305",
  "mergeBaseOid": "acac6a1f25ff44f786b1f21216fb55d0699b7dd3",
  "lastPushDate": "2024-05-18T10:07:10.000Z",
  "lastActivityDate": "2024-05-28T19:47:11.000Z",
  "maintainerBlessed": "Waiting for Code Reviews",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "k6",
      "kind": "edit",
      "files": [
        {
          "path": "types/k6/http.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "MStoykov",
        "codebien",
        "oleiade",
        "olegbespalov",
        "nicolevanderhoeven",
        "ankur22",
        "inancgumus",
        "ka3de",
        "joanlopez"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 2118757576,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added Popular package This PR affects a popular package (as counted by NPM download counts). Untested Change This PR does not touch tests labels May 18, 2024
@typescript-bot
Copy link
Contributor

Hey @wuhkuh,

😒 Your PR doesn't modify any tests, so it's hard to know what's being fixed, and your changes might regress in the future. Please consider adding tests to cover the change you're making. Including tests allows this PR to be merged by yourself and the owners of this module.

This can potentially save days of time for you!

@typescript-bot
Copy link
Contributor

🔔 @mstoykov @codebien @oleiade @olegbespalov @nicolevanderhoeven @ankur22 @inancgumus @ka3de @joanlopez — 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 this to Waiting for Code Reviews in New Pull Request Status Board May 18, 2024
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board May 18, 2024
@sheetalkamat sheetalkamat moved this from Needs Maintainer Review to Waiting for Code Reviews in New Pull Request Status Board May 28, 2024
@typescript-bot
Copy link
Contributor

Re-ping @mstoykov, @codebien, @oleiade, @olegbespalov, @nicolevanderhoeven, @ankur22, @inancgumus, @ka3de, @joanlopez:

This PR has been out for over a week, yet I haven't seen any reviews.

Could someone please give it some attention? Thanks!

@typescript-bot typescript-bot added the Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. label May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Popular package This PR affects a popular package (as counted by NPM download counts). Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. Untested Change This PR does not touch tests
Projects
New Pull Request Status Board
Waiting for Code Reviews
Development

Successfully merging this pull request may close these issues.

None yet

2 participants