typings

TypeScript Definition Installer

The TypeScript definition manager.

Installation

npm install typings --global

Usage

Typings provides a simple way for type dependencies to be installed and maintained. By resolving over various sources recursively, type definitions can be compiled into a single definition for bundling - avoiding any version conflicts.

typings install https://raw.githubusercontent.com/borisyankov/DefinitelyTyped/master/node/node.d.ts --name node --ambient

Init

typings init

Initialize a new typings project at this location.

Install

typings install [location] --name [name]

Install a type dependency, and optionally save it in the configuration file.

Flags

• --save, -S Save to typings.json
• --save-dev, -D Save as a dev dependency to typings.json
• --save-ambient, -A Save as an ambient dependency to typings.json
• --ambient Write as an ambient dependency
• --name The name of the dependency

Possible Locations

• http://<domain>/<path>
• file:<path>
• github:<org>/<repo>/<path>#<commit>
• bitbucket:<org>/<repo>/<path>#<commit>
• npm:<package>/<path>
• bower:<package>/<path>

Where path can either be typings.json file, a .d.ts file, or empty (it will automatically append typings.json when the path is not a .d.ts file).

Uninstall

typings uninstall [name]

Writing Type Dependencies

Writing a new type definition is as simple as creating a new package. Start by creating a new typings.json file, then add dependencies as you would normally. When you publish to GitHub, locally, alongside a package (NPM or Bower) or even on your own website, someone else can install it and use it.

{
  "name": "typings",
  "main": "path/to/definition.d.ts",
  "ambient": false,
  "author": "Blake Embrey <[e-mail]>",
  "description": "The TypeScript definition dependency manager",
  "dependencies": {},
  "devDependencies": {},
  "ambientDependencies": {}
}

• main The entry point to the definition
• browser A string or map of paths to override when resolving (just like browser in package.json)
• ambient Specify that this definition must be installed as ambient
• name The name of the definition
• dependencies A map of dependencies that need installing
• devDependencies A map of development dependencies that need installing
• ambientDependencies A map of environment dependencies that need installing

Multiple Dependency Sources

The dependencies map can accept either strings, or an array of strings, which points to the location of the dependency. For most people, a single string is more than enough. In some cases it's possible that a type definition is available from multiple locations and will be resolved to the first available. For example, publishing a type definition and referring to npm:<package> that might not be available. In this situation, you can have a second source as github:<org>/<package> to install from.

What Are Ambient Dependencies?

Ambient dependencies are definitions which provide an environment. Such dependencies could be node, browserify, window or even Array.prototype.map. These are globals that exist, you do not "require" them.

License

MIT