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

Types + tests for existing npm module multiaddr #41413

Merged
merged 1 commit into from
Jan 7, 2020

Conversation

carsonfarmer
Copy link
Contributor

@carsonfarmer carsonfarmer commented Jan 6, 2020

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

Signed-off-by: Carson Farmer <carson.farmer@gmail.com>
@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 multiaddr with its source on master.

Comparison details 📊
Batch compilation
Type count 9595
Assignability cache size 3089
Language service measurements
Samples taken 210
Identifiers in tests 210
getCompletionsAtPosition
    Mean duration (ms) 336.2
    Mean CV 10.2%
    Worst duration (ms) 404.5
    Worst identifier isName
getQuickInfoAtPosition
    Mean duration (ms) 339.8
    Mean CV 10.7%
    Worst duration (ms) 436.8
    Worst identifier Buffer
System information
Node version v12.13.1
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-1064-azure

@typescript-bot typescript-bot added New Definition This PR creates a new definition package. Awaiting reviewer feedback labels Jan 6, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Jan 6, 2020

@carsonfarmer 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!

@armanio123 armanio123 merged commit 56c1ea2 into DefinitelyTyped:master Jan 7, 2020
Pull Request Status Board automation moved this from Review to Done Jan 7, 2020
@typescript-bot
Copy link
Contributor

I just published @types/multiaddr@7.2.0 to npm.

@carsonfarmer carsonfarmer deleted the carson/multiaddr branch January 7, 2020 18:01
@carsonfarmer
Copy link
Contributor Author

Thanks!

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