TS 中文文档


The TypeScript Definition Manager.


Deprecation Notice: Regarding TypeScript@2.0


For users doing typings install dt~<package> --global and receiving errors.

Starting from TypeScript 2.0, users can install typings using npm install @types/<package>. These typings are coming from DefinitelyTyped. In the future, we hope redirects will be enabled to support existing maintainers to contribute effectively to NPM's @types as they did to typings/registry.

Typings on DefinitelyTyped have also moved to the external module format supported by TypeScript. This finally solved the real problem that Typings was trying to solve! It also means it will cause errors such as:

  1. ``` shell
  2. > typings install dt~angular --global

  4. typings ERR! message Attempted to compile "angular" as a global module,
  5. but it looks like an external module. You'll need to remove the global option to continue.
  6. ```

To resolve this, we recommend moving to TypeScript 2.0's official aquisition method (npm install @types/angular ). You can also drop the --global flag from typings, though some definitions on DefinitelyTyped may not work with the Typings approach because of new TypeScript features (namely UMD namespaces).

This project will remain operational for the foreseeable future, but is effectively deprecated. New projects should use @types from NPM.

Quick Start


  1. ``` shell
  2. # Install Typings CLI utility.
  3. npm install typings --global

  5. # Search for definitions.
  6. typings search tape

  8. # Find a definition by name.
  9. typings search --name react

  11. # If you use the package as a module:
  12. # Install non-global typings (defaults to "npm" source, configurable through `defaultSource` in `.typingsrc`).
  13. typings install debug --save

  15. # If you use the package through `<script>`, it is part of the environment, or
  16. # the module typings are not yet available, try searching and installing with `--global`:
  17. typings install dt~mocha --global --save

  19. # If you need a specific commit from github.
  20. typings install d3=github:DefinitelyTyped/DefinitelyTyped/d3/d3.d.ts#1c05872e7811235f43780b8b596bfd26fe8e7760 --global --save

  22. # Search and install by version.
  23. typings info env~node --versions
  24. typings install env~node@0.10 --global --save

  26. # Install typings from a particular source (use `<source>~<name>` or `--source <source>`).
  27. typings install env~atom --global --save
  28. typings install bluebird --source npm --save

  30. # Use `typings/index.d.ts` (in `tsconfig.json` or as a `///` reference).
  31. cat typings/index.d.ts
  32. ```

Usage


Typingsis the simple way to manage and install TypeScript definitions. It uses typings.json, which can resolve to the Typings Registry, GitHub, NPM, Bower, HTTP and local files. Packages can use type definitions from various sources and different versions, knowing they will neverconflict for users.

  1. ``` shell
  2. typings install debug --save
  3. ```

The public registry is maintained by the community, and is used to resolve official type definitions for JavaScript packages.

Read More


Commands
Coming from TSD?
Example typings
Why external modules?
About the registry
FAQ
Known Issues

Sources


npm - dependencies from NPM
github - dependencies directly from GitHub (E.g. Duo, JSPM )
bitbucket - dependencies directly from Bitbucket
jspm : - dependencies from installed JSPM packages with typings distributed. Requires jspm@0.17+.
bower - dependencies from Bower
common - "standard" libraries without a known "source"
shared - shared library functionality
lib - shared environment functionality (mirror of shared ) (--global )
env - environments (E.g. atom, electron ) (--global )
global - global (window.<var> ) libraries (--global )
dt - typings from DefinitelyTyped (usually --global )

Contributing


  1. ``` shell
  2. # Installation
  3. # Fork this repo (https://github.com/typings/typings)
  4. # Clone the fork (E.g. `https://github.com//typings.git`)
  5. cd typings

  7. # Install modules
  8. npm install

  10. # Build
  11. npm run build

  13. # Test
  14. npm run test
  15. ```

Change Log


License


MIT