Skip to content

Commit ba20ed2

Browse files
authored
Merge pull request #16 from pjotrsavitski/typescript-docs
Added TypeScript instructions
2 parents 2b104fa + 7f26e65 commit ba20ed2

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ This is the solution for you if you're just using `<script>` tags everywhere!
9898

9999
Assuming you are using [browserify][], [webpack][], [rollup][], or another bundler, you can simply follow [Node](#node) usage above.
100100

101+
#### TypeScript
102+
103+
To use this package with [TypeScript](https://www.typescriptlang.org/), you can install the [`@types/url-regex-safe`](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/url-regex-safe) package for type definitions.
104+
105+
```sh
106+
npm install --save-dev @types/url-regex-safe
101107

102108
## Options
103109

0 commit comments

Comments
 (0)