Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): remove NodeJS 10 and add callout for conditional exports #2675

Merged
merged 2 commits into from
May 7, 2024
Merged

fix(docs): remove NodeJS 10 and add callout for conditional exports #2675

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2a29fc
fix(docs): remove NodeJS 10
wolfy1339 May 7, 2024
45edbed
fix(docs): add callout for conditional exports
wolfy1339 May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ import { Octokit, App } from "https://esm.sh/octokit?dts";

</td></tr>
<tr><th>
Node 12+
Node
</th><td>

Install with <code>npm/pnpm install octokit</code>, or <code>yarn add octokit</code>
Expand All @@ -86,21 +86,16 @@ Install with <code>npm/pnpm install octokit</code>, or <code>yarn add octokit</c
import { Octokit, App } from "octokit";
```

</td></tr>
<tr><th>
Node 10 and below
</th><td>

Install with <code>npm/pnpm install octokit</code>, or <code>yarn add octokit</code>

```js
const { Octokit, App } = require("octokit");
```

</td></tr>
</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)

## `Octokit` API Client

**standalone minimal Octokit**: [`@octokit/core`](https://github.com/octokit/core.js/#readme).
Expand Down