Skip to content

Commit f0aaee6

Browse files
committed
docs(README): update info for typescript
1 parent e7d4341 commit f0aaee6

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,13 @@ There is one method for each REST API endpoint documented at [https://developer.
5050

5151
## TypeScript
5252

53-
Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`.
54-
5553
> [!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).
54+
> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`.
55+
>
56+
> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).<br>
57+
> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
58+
59+
Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`.
5760

5861
Example
5962

0 commit comments

Comments
 (0)