Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.56 KB

README.md

File metadata and controls

33 lines (21 loc) · 1.56 KB

Typings Registry

The registry of type definitions for TypeScript.

Contributing

  1. Write a typings definition and upload to GitHub - here's an example using debug
  2. Make a pull request, using semver to specify which version the typing is valid for - here's debug again
  3. Once the pull request is merged, it is used as the canonical reference - typings install debug

Structure

/{package manager}/{package name}.json

Where "package manager" is one of:

  • npm for NPM dependencies
  • github for Duo, JSPM, etc. using GitHub as a registry
  • bower for Bower dependencies
  • ambient for ambient dependencies (typings that describe our programming environment)
  • common for dependencies not on any specific registry, but have a standardized library in JS

And "package name" is the name of the package in the registry. For GitHub and scoped NPM packages, it's valid to make a folder such as @example/entry.json.

Requests

An up-to-date list of typings requests are labelled in the meta repo.

Questions?

For typings issues, questions or general help, you can always open an issue in the meta repo. To add an entry to the registry, please open a pull request with the update.