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

Update Request to include rawBody property #56766

Merged
merged 2 commits into from
Nov 5, 2021

Conversation

dzhang-ssense
Copy link
Contributor

@dzhang-ssense dzhang-ssense commented Oct 25, 2021

The rawBody property is a property which the restify team intend to support:
restify/node-restify#928
restify/plugins#6
Having it available in the typing enables access to this property.

Please fill in this template.

Select one of these and delete the others:

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tslint.json should contain { "extends": "dtslint/dt.json" }, and no additional rules.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

If removing a declaration:

  • If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
  • Delete the package's directory.
  • Add it to notNeededPackages.json.

The `rawBody` property is a property which the restify team intend to support:
restify/node-restify#928
restify/plugins#6
Having it available in the typing enables access to this property.
@typescript-bot
Copy link
Contributor

typescript-bot commented Oct 25, 2021

@dzhang-ssense 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.

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

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Only a DT maintainer can approve changes without tests

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": 56766,
  "author": "dzhang-ssense",
  "headCommitOid": "9fad6da8e9ab51248265b31a114c83a2c477e353",
  "lastPushDate": "2021-10-25T19:16:32.000Z",
  "lastActivityDate": "2021-11-05T16:55:48.000Z",
  "maintainerBlessed": "Waiting for Author to Merge",
  "mergeOfferDate": "2021-11-02T20:25:18.000Z",
  "mergeRequestDate": "2021-11-05T16:55:48.000Z",
  "mergeRequestUser": "dzhang-ssense",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "restify",
      "kind": "edit",
      "files": [
        {
          "path": "types/restify/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "blittle",
        "stevehipwell",
        "leanazulyoro",
        "mgebundy",
        "alcmoraes",
        "quinnlangille",
        "GaikwadPratik"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "quinnlangille",
      "date": "2021-10-27T01:15:53.000Z",
      "isMaintainer": false
    },
    {
      "type": "stale",
      "reviewer": "phaubertinssense",
      "date": "2021-10-25T19:01:53.000Z",
      "abbrOid": "afb0d13"
    }
  ],
  "mainBotCommentID": 951216482,
  "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 Oct 25, 2021
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Oct 25, 2021
@typescript-bot
Copy link
Contributor

🔔 @blittle @stevehipwell @leanazulyoro @mgebundy @alcmoraes @quinnlangille @GaikwadPratik — 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 Other Approved This PR was reviewed and signed-off by a community member. The CI failed When GH Actions fails labels Oct 25, 2021
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Oct 25, 2021
@typescript-bot
Copy link
Contributor

@dzhang-ssense 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 which are failing do not end up on the list of PRs for the DT maintainers to review.

@typescript-bot typescript-bot removed Other Approved This PR was reviewed and signed-off by a community member. The CI failed When GH Actions fails labels Oct 25, 2021
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Oct 25, 2021
@typescript-bot
Copy link
Contributor

@phaubertinssense 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?

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Oct 25, 2021
@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Oct 27, 2021
Copy link
Contributor

@quinnlangille quinnlangille left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good too add a test in the restify-tests.ts file, just asserting that rawBody should be available

@typescript-bot
Copy link
Contributor

⏳ Hi @dzhang-ssense,

It's been a few days since this PR was approved by quinnlangille and we're waiting for a DT maintainer to give a review.

If you would like to short-circuit this wait, you can edit some of the test files in the package which verify how the .d.ts files work. This would allow the PR to be merged by you or the DT module owners after a re-review.

@elibarzilay
Copy link
Contributor

For future reference, adding tests would have made this quicker.

@elibarzilay elibarzilay moved this from Needs Maintainer Review to Waiting for Author to Merge in New Pull Request Status Board Nov 2, 2021
@typescript-bot typescript-bot added the Self Merge This PR can now be self-merged by the PR author or an owner label Nov 2, 2021
@dzhang-ssense
Copy link
Contributor Author

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Nov 5, 2021
@typescript-bot typescript-bot merged commit 66029dc into DefinitelyTyped:master Nov 5, 2021
@dzhang-ssense dzhang-ssense deleted the patch-1 branch November 5, 2021 16:56
@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Nov 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Owner Approved A listed owner of this package signed off on the pull request. Popular package This PR affects a popular package (as counted by NPM download counts). Self Merge This PR can now be self-merged by the PR author or an owner Untested Change This PR does not touch tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants