Skip to content

Commit e7d4341

Browse files
committed
docs: add note on needed config changes for TypeScript
1 parent b678490 commit e7d4341

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ There is one method for each REST API endpoint documented at [https://developer.
5252

5353
Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`.
5454

55+
> [!IMPORTANT]
56+
> 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).
57+
5558
Example
5659

5760
```ts

0 commit comments

Comments
 (0)