Skip to content

Commit

Permalink
docs: 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 16, 2024
1 parent 65cc6e9 commit 40ea32a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@ const { App, createNodeMiddleware } = require("@octokit/app");
</tbody>
</table>

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

0 comments on commit 40ea32a

Please sign in to comment.