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 types for naja #39092

Merged
merged 8 commits into from
Oct 15, 2019
Merged

Add types for naja #39092

merged 8 commits into from
Oct 15, 2019

Conversation

rozsival
Copy link
Contributor

@rozsival rozsival commented Oct 13, 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.

@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 naja with its source on master.

Comparison details 📊
Batch compilation
Type count 10278
Assignability cache size 34601
Language service measurements
Samples taken 156
Identifiers in tests 156
getCompletionsAtPosition
    Mean duration (ms) 344.8
    Mean CV 13.2%
    Worst duration (ms) 464.1
    Worst identifier document
getQuickInfoAtPosition
    Mean duration (ms) 340.0
    Mean CV 14.5%
    Worst duration (ms) 462.0
    Worst identifier clickElement
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

@typescript-bot typescript-bot added New Definition This PR creates a new definition package. Awaiting reviewer feedback labels Oct 13, 2019
@typescript-bot
Copy link
Contributor

typescript-bot commented Oct 13, 2019

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

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.

Thanks!

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

I just published @types/naja@1.6.0 to npm.

chivesrs pushed a commit to chivesrs/DefinitelyTyped that referenced this pull request Nov 19, 2019
* Add types for naja

* Follow PR rules

* Change interface name

* Extend EventTarget

* Include all event types in map

* Improve events typing

* Add naja options interface

* Make options readonly
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