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

Add typings for proper-url-join #39197

Merged
merged 1 commit into from Oct 17, 2019
Merged

Add typings for proper-url-join #39197

merged 1 commit into from Oct 17, 2019

Conversation

jsamr
Copy link
Contributor

@jsamr jsamr commented Oct 17, 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:

  • 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.

@typescript-bot
Copy link
Contributor

typescript-bot commented Oct 17, 2019

@jsamr Thank you for submitting this PR!

Because this is a new definition, a DefinitelyTyped maintainer will be reviewing this PR in the next few days once the Travis CI build passes.

In the meantime, if the build fails or a merge conflict occurs, I'll let you know. Have a nice day!

@typescript-bot
Copy link
Contributor

typescript-bot commented Oct 17, 2019

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

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

jsamr added a commit to jsamr/types-publisher that referenced this pull request Oct 17, 2019
@typescript-bot
Copy link
Contributor

typescript-bot commented Oct 17, 2019

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

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

sandersn pushed a commit to microsoft/types-publisher that referenced this pull request Oct 17, 2019
@typescript-bot
Copy link
Contributor

👋 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?

These typings are for a package that doesn’t yet exist on master, so I don’t have anything to compare against yet! In the future, I’ll be able to compare PRs to proper-url-join with its source on master.

Comparison details 📊
Batch compilation
Type count 2173
Assignability cache size 133
Language service measurements
Samples taken 32
Identifiers in tests 32
getCompletionsAtPosition
    Mean duration (ms) 90.1
    Mean CV 18.2%
    Worst duration (ms) 126.8
    Worst identifier biz
getQuickInfoAtPosition
    Mean duration (ms) 87.0
    Mean CV 16.8%
    Worst duration (ms) 112.6
    Worst identifier urlJoin
System information
Node version v10.16.3
CPU count 2
CPU speed 2.294 GHz
CPU model Intel(R) Xeon(R) CPU E5-2673 v4 @ 2.30GHz
CPU Architecture x64
Memory 6.8 GiB
Platform linux
Release 4.15.0-1059-azure

// Project: https://github.com/moxystudio/js-proper-url-join
// Definitions by: Jules Sam. Randolph <https://github.com/jsamr>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Typescript prior to v3 compilation will fail at query-string import.

Copy link
Member

@andrewbranch andrewbranch left a comment

Choose a reason for hiding this comment

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

Seems right to me. Thanks!

@andrewbranch andrewbranch merged commit dca759d into DefinitelyTyped:master Oct 17, 2019
Pull Request Status Board automation moved this from Review to Done Oct 17, 2019
@typescript-bot
Copy link
Contributor

I just published @types/proper-url-join@2.0.0 to npm.

chivesrs pushed a commit to chivesrs/DefinitelyTyped that referenced this pull request Nov 19, 2019
blueskyleader01 added a commit to blueskyleader01/Types-Publisher that referenced this pull request Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New Definition This PR creates a new definition package.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants