Skip to content

Commit

Permalink
docs(README): add note about ESM usage with TS
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfy1339 committed Apr 30, 2024
1 parent e8959a3 commit c3410c0
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 @@ -35,6 +35,12 @@ import { Octokit } from "@octokit/rest";
</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 octokit = new Octokit();

Expand Down

0 comments on commit c3410c0

Please sign in to comment.