Skip to content

Commit 667581e

Browse files
authored
feat: package is now ESM (#233)
BREAKING CHANGE: package is now ESM
1 parent 91dead7 commit 667581e

28 files changed

+228
-136
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Node
5757
Install with `npm install @octokit/core @octokit/oauth-methods`
5858

5959
```js
60-
const {
60+
import {
6161
exchangeWebFlowCode,
6262
createDeviceCode,
6363
exchangeDeviceCode,
@@ -67,7 +67,7 @@ const {
6767
resetToken,
6868
deleteToken,
6969
deleteAuthorization,
70-
} = require("@octokit/oauth-methods");
70+
} from "@octokit/oauth-methods";
7171
```
7272

7373
</td></tr>
@@ -248,7 +248,7 @@ Defaults to `[]`.
248248
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
249249

250250
```js
251-
const { request } = require("@octokit/request");
251+
import { request } from "@octokit/request";
252252
const { url } = getWebFlowAuthorizationUrl({
253253
clientType: "oauth-app",
254254
clientId: "1234567890abcdef1234",
@@ -470,7 +470,7 @@ Options
470470
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
471471

472472
```js
473-
const { request } = require("@octokit/request");
473+
import { request } from "@octokit/request";
474474
const { data, authentication } = await exchangeWebFlowCode({
475475
clientType: "oauth-app",
476476
clientId: "1234567890abcdef1234",
@@ -564,7 +564,7 @@ Array of [scope names](https://docs.github.com/en/developers/apps/scopes-for-oau
564564
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
565565

566566
```js
567-
const { request } = require("@octokit/request");
567+
import { request } from "@octokit/request";
568568
const { data } = await createDeviceCode({
569569
clientType: "oauth-app",
570570
clientId: "1234567890abcdef1234",
@@ -651,7 +651,7 @@ const { data, authentication } = await exchangeDeviceCode({
651651
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
652652

653653
```js
654-
const { request } = require("@octokit/request");
654+
import { request } from "@octokit/request";
655655
const { data, authentication } = await exchangeDeviceCode({
656656
clientType: "oauth-app",
657657
clientId: "1234567890abcdef1234",
@@ -750,7 +750,7 @@ Options
750750
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
751751

752752
```js
753-
const { request } = require("@octokit/request");
753+
import { request } from "@octokit/request";
754754
const { data, authentication } = await checkToken({
755755
clientType: "oauth-app",
756756
clientId: "1234567890abcdef1234",
@@ -856,7 +856,7 @@ Options
856856
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
857857

858858
```js
859-
const { request } = require("@octokit/request");
859+
import { request } from "@octokit/request";
860860
const { data, authentication } = await refreshToken({
861861
clientType: "github-app",
862862
clientId: "lv1.1234567890abcdef",
@@ -1007,7 +1007,7 @@ Options
10071007
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
10081008

10091009
```js
1010-
const { request } = require("@octokit/request");
1010+
import { request } from "@octokit/request";
10111011
const { data, authentication } = await scopeToken({
10121012
clientType: "github-app",
10131013
clientId: "lv1.1234567890abcdef",
@@ -1113,7 +1113,7 @@ Options
11131113
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
11141114

11151115
```js
1116-
const { request } = require("@octokit/request");
1116+
import { request } from "@octokit/request";
11171117
const { data, authentication } = await resetToken({
11181118
clientId: "1234567890abcdef1234",
11191119
clientSecret: "secret",
@@ -1214,7 +1214,7 @@ Options
12141214
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
12151215

12161216
```js
1217-
const { request } = require("@octokit/request");
1217+
import { request } from "@octokit/request";
12181218
const { data, authentication } = await deleteToken({
12191219
clientId: "1234567890abcdef1234",
12201220
clientSecret: "secret",
@@ -1315,7 +1315,7 @@ Options
13151315
You can pass in your own <a href="https://github.com/octokit/request.js"><code>@octokit/request</code></a> instance. For usage with enterprise, set <code>baseUrl</code> to the REST API root endpoint. Example:
13161316

13171317
```js
1318-
const { request } = require("@octokit/request");
1318+
import { request } from "@octokit/request";
13191319
const { data, authentication } = await deleteAuthorization({
13201320
clientId: "1234567890abcdef1234",
13211321
clientSecret: "secret",

0 commit comments

Comments
 (0)