Sketch-Typings

<h1 align="center">Sketch-Typings</h1>

<div align="center">

[![NPM version][npm-image]][npm-url] [![NPM version][npm-next-image]][npm-url] [![NPM downloads][download-image]][download-url] [![install size][npm-size]][npm-size-url]

[![david deps][david-image]][david-url] [![david devDeps][david-dev-image]][david-dev-url]

<!-- npm url -->

[npm-image]: http://img.shields.io/npm/v/sketch-typings.svg?style=flat-square&color=deepgreen&label=latest
[npm-next-image]: https://img.shields.io/npm/v/sketch-typings/next?label=next&style=flat-square
[npm-url]: http://npmjs.org/package/sketch-typings
[npm-size]: https://packagephobia.com/badge?p=sketch-typings
[npm-size-url]: https://packagephobia.com/result?p=sketch-typings

<!-- coverage -->

[coverage]: https://codecov.io/gh/arvinxx/sketch-typings/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/arvinxx/sketch-typings/branch/master

<!-- Github CI -->

[test-ci]: https://github.com/arvinxx/sketch-typings/workflows/Test%20CI/badge.svg
[deploy-ci]: https://github.com/arvinxx/sketch-typings/workflows/Deploy%20CI/badge.svg
[test-ci-url]: https://github.com/arvinxx/sketch-typings/actions?query=workflow%3ATest%20CI
[deploy-ci-ci]: https://github.com/arvinxx/sketch-typings/actions?query=workflow%3ADeploy%20CI
[david-image]: https://img.shields.io/david/arvinxx/sketch-typings?style=flat-square
[david-dev-url]: https://david-dm.org/arvinxx/sketch-typings?type=dev
[david-dev-image]: https://img.shields.io/david/dev/arvinxx/sketch-typings?style=flat-square
[david-url]: https://david-dm.org/arvinxx/sketch-typings
[download-image]: https://img.shields.io/npm/dm/sketch-typings.svg?style=flat-square
[download-url]: https://npmjs.org/package/sketch-typings

</div>

------

Community built set of [typescript declarations][dec] for writing [Sketch plugins][sketch-api].

[dec]: https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html
[sketch-api]: https://developer.sketch.com/reference/api/

## Usage

First, install sketch-typings

```sh
$ npm i sketch-typings -D
```

or 

```sh
$ yarn add sketch-typings -D
```


Then you need to add the typings directory to your tsconfig.json using the types option:
```json5
{
  "compilerOptions": {
    // ...
    "types": ["sketch-typings"]
  }
}
```
## More types about sketch or macOS

if you just want sketch internal types or cocoascript types, please check:
- [sketch-internal-types](https://github.com/sketch-community/sketch-internal-types)
- [cocoascript-types](https://github.com/sketch-community/cocoascript-types)

## License

[MIT](./LICENSE)