Skip to content

Commit

Permalink
Merge pull request #16 from pjotrsavitski/typescript-docs
Browse files Browse the repository at this point in the history
Added TypeScript instructions
  • Loading branch information
niftylettuce committed Nov 23, 2021
2 parents 2b104fa + 7f26e65 commit ba20ed2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -98,6 +98,12 @@ This is the solution for you if you're just using `<script>` tags everywhere!

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

#### TypeScript

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.

```sh
npm install --save-dev @types/url-regex-safe

## Options

Expand Down

0 comments on commit ba20ed2

Please sign in to comment.