Skip to content

Commit

Permalink
added typescript section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iyegoroff authored Feb 3, 2018
1 parent 1707cad commit 41b23a5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,16 @@ Will result in
className="user-name" />
```

## Typescript

This library has typescript typings, import them the same way as in javascript:

```typescript
import {DebounceInput} from 'react-debounce-input';
```

Also there are helper types `DebounceTextArea` and `Debounced` to provide strict interfaces for wrapping components different from standard `<input />`. Check usage examples in `example/typescript-example.tsx`.

## Development and testing

Currently is being developed and tested with the latest stable `Node 8` on `OSX`.
Expand Down

0 comments on commit 41b23a5

Please sign in to comment.