Skip to content

Commit

Permalink
docs(README): add note on needed config changes for TypeScript
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfy1339 committed Apr 15, 2024
1 parent a1462d3 commit 3d8311b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ got[options.method](url, options);
axios(requestOptions);
```

> [!IMPORTANT]
> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json`. See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).
## API

### `endpoint(route, options)` or `endpoint(options)`
Expand Down

0 comments on commit 3d8311b

Please sign in to comment.