Skip to content

Commit 5322c78

Browse files
committed
updated description to include how to install typescript definitions
1 parent 5bab922 commit 5322c78

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,23 @@ jQuery Mask Plugin has been tested with jQuery 1.7+ on all major browsers:
7171
* Opera 8+ (Win, Mac, Linux, Android, iPhone).
7272
* Android Default Browser v4+
7373

74+
## Typescript support
75+
Definition can be found [here](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/jquery-mask-plugin).
76+
77+
To install, open terminal and navigate to your working directory.
78+
79+
### Typescript 1.x users
80+
* Install [typings](https://github.com/typings/typings) by running `npm install typings --global`.
81+
* Then install the definition by running `typings install dt~jquery-mask-plugin --global --save`.
82+
### Typescript 2.x users
83+
* Use npm `npm install --save-dev @types/jquery-mask-plugin`.
84+
85+
For configuration options and troubleshooting refer to these repositories:
86+
* [Typings](https://github.com/typings/typings)
87+
* [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)
88+
* [Typescript](https://github.com/Microsoft/TypeScript)
89+
90+
7491
## Problems or Questions?
7592
Before opening a new [issue](https://github.com/igorescobar/jQuery-Mask-Plugin/issues) take a look on those frequently asked questions:
7693
#### [How to integrate with React.js?](https://github.com/igorescobar/jQuery-Mask-Plugin/issues/498)

0 commit comments

Comments
 (0)