83 lines
2.5 KiB
Markdown
83 lines
2.5 KiB
Markdown
|
# 
|
||
|
|
|
||
|
|
[![NPM version][npm-image]][npm-url]
|
||
|
|
[![NPM downloads][downloads-image]][downloads-url]
|
||
|
|
[![Build status][travis-image]][travis-url]
|
||
|
|
[![Test coverage][coveralls-image]][coveralls-url]
|
||
|
|
[![Gitter][gitter-image]][gitter-url]
|
||
|
|
|
||
|
|
> The TypeScript Definition Manager.
|
||
|
|
|
||
|
|
**Updating from 0.6 to 0.7?** Make sure you `rm -rf typings/` and re-install them, the directory structure has changed.
|
||
|
|
|
||
|
|
## Quick Start
|
||
|
|
|
||
|
|
```sh
|
||
|
|
# Install Typings CLI utility.
|
||
|
|
npm install typings --global
|
||
|
|
|
||
|
|
# Search for definitions.
|
||
|
|
typings search tape
|
||
|
|
|
||
|
|
# Find an available definition (by name).
|
||
|
|
typings search --name react
|
||
|
|
|
||
|
|
# Install typings (DT is "ambient", make sure to enable the flag and persist the selection in `typings.json`).
|
||
|
|
typings install react --ambient --save
|
||
|
|
|
||
|
|
# Use `main.d.ts` (in `tsconfig.json` or as a `///` reference).
|
||
|
|
cat typings/main.d.ts
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
**Typings** is the simple way to manage and install TypeScript definitions. It uses `typings.json`, which can resolve to GitHub, NPM, Bower, HTTP and local files. Packages can use type definitions from various sources and different versions, and know they will _never_ cause a conflict for users.
|
||
|
|
|
||
|
|
```sh
|
||
|
|
typings install debug --save
|
||
|
|
```
|
||
|
|
|
||
|
|
A [public registry](https://github.com/typings/registry) is maintained by the community, and is used to resolve official type definitions for JavaScript packages.
|
||
|
|
|
||
|
|
## Read More
|
||
|
|
|
||
|
|
* [Commands](docs/commands.md)
|
||
|
|
* [Coming from TSD?](docs/tsd.md)
|
||
|
|
* [Example typings](docs/examples.md)
|
||
|
|
* [Why external modules?](docs/external-modules.md)
|
||
|
|
* [About the registry](docs/registry.md)
|
||
|
|
* [FAQ](docs/faq.md)
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
```sh
|
||
|
|
# Installation
|
||
|
|
# Fork this repo (https://github.com/typings/typings)
|
||
|
|
# Clone the fork (E.g. `https://github.com/<your_username>/typings.git`)
|
||
|
|
cd typings
|
||
|
|
|
||
|
|
# Install modules
|
||
|
|
npm install
|
||
|
|
|
||
|
|
# Build
|
||
|
|
npm run build
|
||
|
|
|
||
|
|
# Test
|
||
|
|
npm run test
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT
|
||
|
|
|
||
|
|
[npm-image]: https://img.shields.io/npm/v/typings.svg?style=flat
|
||
|
|
[npm-url]: https://npmjs.org/package/typings
|
||
|
|
[downloads-image]: https://img.shields.io/npm/dm/typings.svg?style=flat
|
||
|
|
[downloads-url]: https://npmjs.org/package/typings
|
||
|
|
[travis-image]: https://img.shields.io/travis/typings/typings.svg?style=flat
|
||
|
|
[travis-url]: https://travis-ci.org/typings/typings
|
||
|
|
[coveralls-image]: https://img.shields.io/coveralls/typings/typings.svg?style=flat
|
||
|
|
[coveralls-url]: https://coveralls.io/r/typings/typings?branch=master
|
||
|
|
[gitter-image]: https://badges.gitter.im/typings/typings.svg
|
||
|
|
[gitter-url]: https://gitter.im/typings/typings?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
|