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.
- Follow the advice from the readme.
- Avoid common mistakes.
- Run
pnpm test <package to test>.
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.tsfiles 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
-
tsconfig.jsonshould havenoImplicitAny,noImplicitThis,strictNullChecks, andstrictFunctionTypesset totrue.
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
package.json.
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.