Merge pull request #423 from pusher/typescript-support-in-readme

mention ts declarations in README
pusher · Feb 11, 2020 · ca65b2a · ca65b2a
2 parents 44c92a1 + 62c1e7e
commit ca65b2a
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -98,6 +98,20 @@ and then:
 <script src="bower_components/pusher/dist/web/pusher.min.js"></script>
 ```
 
+### Typescript
+
+We've provided typescript declarations since v5.1.0. Most things should work
+out of the box but if you need access to specific types you can import them
+like so:
+
+```
+import Pusher from 'pusher-js';
+import * as PusherTypes from 'pusher-js';
+
+var presenceChannel: PusherTypes.PresenceChannel;
+...
+```
+
 ### React Native
 
 **Warning it's now necessary to install