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

feat: add missing config for server #39295

Merged
merged 3 commits into from Oct 24, 2019

Conversation

@quinnlangille
Copy link
Contributor

quinnlangille commented Oct 21, 2019

Please fill in this template.

  • Use a meaningful title for the pull request. Include the name of the package modified.
  • Test the change in your own code. (Compile and run.)
  • Add or edit tests to reflect the change. (Run with npm test.)
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run npm run lint package-name (or tsc if no tslint.json is present).

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 be present and it shouldn't have any additional or disabling of rules. Just content as { "extends": "dtslint/dt.json" }. If for reason the some rule need to be disabled, disable it for that line using // tslint:disable-next-line [ruleName] and not for whole package so that the need for disabling can be reviewed.
  • 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 you are making substantial changes, consider adding a tslint.json containing { "extends": "dtslint/dt.json" }. If for reason the any rule need to be disabled, disable it for that line using // tslint:disable-next-line [ruleName] and not for whole package so that the need for disabling can be reviewed.

If removing a declaration:

  • If a package was never on DefinitelyTyped, 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.
@quinnlangille

This comment has been minimized.

Copy link
Contributor Author

quinnlangille commented Oct 21, 2019

Param is referenced here: restify/node-restify#1677

Also tested in my own code, and it works as expected by declaring like so:

restify.createServer(<any> {maxParamLength: 1000 })
@typescript-bot

This comment has been minimized.

Copy link
Contributor

typescript-bot commented Oct 21, 2019

@quinnlangille Thank you for submitting this PR!

🔔 @blittle @stevehipwell @leanazulyoro @mgebundy @alcmoraes - 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.

If no reviewer appears after a week, a DefinitelyTyped maintainer will review the PR instead.

@typescript-bot

This comment has been minimized.

Copy link
Contributor

typescript-bot commented Oct 21, 2019

👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings.

Let’s review the numbers, shall we?

Comparison details 📊
master #39295 diff
Batch compilation
Memory usage (MiB) 69.9 69.9 0.0%
Type count 9768 9768 0%
Assignability cache size 3160 3160 0%
Language service
Samples taken 496 496 0%
Identifiers in tests 496 496 0%
getCompletionsAtPosition
    Mean duration (ms) 410.9 415.2 +1.0%
    Mean CV 12.0% 11.8%
    Worst duration (ms) 503.7 548.3 +8.9%
    Worst identifier restify use
getQuickInfoAtPosition
    Mean duration (ms) 416.5 421.8 +1.3%
    Mean CV 12.7% 12.6% -0.8%
    Worst duration (ms) 513.7 572.3 +11.4%
    Worst identifier jsonp server

It looks like nothing changed too much. I won’t post performance data again unless it gets worse.

@typescript-bot typescript-bot moved this from Waiting for Reviewers to Review in Pull Request Status Board Oct 23, 2019
@typescript-bot

This comment has been minimized.

Copy link
Contributor

typescript-bot commented Oct 23, 2019

A definition owner has approved this PR ⭐️. A maintainer will merge this PR shortly. If it shouldn't be merged yet, please leave a comment saying so and we'll wait. Thank you for your contribution to DefinitelyTyped!

@weswigham

This comment has been minimized.

Copy link
Contributor

weswigham commented Oct 23, 2019

@blittle @stevehipwell @leanazulyoro @mgebundy @alcmoraes would you like the help? @quinnlangille is adding themselves as an author here, so I'd like to give the existing authors a bit more time to OK the change.

types/restify/index.d.ts Outdated Show resolved Hide resolved
Co-Authored-By: Mitchell Bundy <mitch@bundy.ca>
@typescript-bot typescript-bot moved this from Review to Check and Merge in Pull Request Status Board Oct 24, 2019
@weswigham weswigham merged commit a0c20a3 into DefinitelyTyped:master Oct 24, 2019
3 checks passed
3 checks passed
DefinitelyTyped.BenchmarkPR Build #19898 succeeded
Details
DefinitelyTyped.DefinitelyTyped Build #20191024.42 succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Pull Request Status Board automation moved this from Check and Merge to Done Oct 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.