Skip to content

Commit 5ad3ed4

Browse files
committed
docs: add note on needed config changes for TypeScript
1 parent f2546fa commit 5ad3ed4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ octokit.rest.repos
5151

5252
See https://octokit.github.io/rest.js for full documentation.
5353

54+
> [!IMPORTANT]
55+
> 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"`.
56+
>
57+
> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).<br>
58+
> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
59+
5460
## Contributing
5561

5662
We would love you to contribute to `@octokit/rest`, pull requests are very welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

0 commit comments

Comments
 (0)