Skip to content

Commit 40ea32a

Browse files
committed
docs: add note on needed config changes for TypeScript
1 parent 65cc6e9 commit 40ea32a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ const { App, createNodeMiddleware } = require("@octokit/app");
5454
</tbody>
5555
</table>
5656

57+
> [!IMPORTANT]
58+
> 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"`.
59+
>
60+
> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).<br>
61+
> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
62+
5763
```js
5864
const app = new App({
5965
appId: 123,

0 commit comments

Comments
 (0)