Skip to content

Commit 4bfe728

Browse files
committed
docs(readme): examples use ESM
1 parent 3bedf48 commit 4bfe728

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,20 @@ the passed options and sends the request using [fetch](https://developer.mozilla
1616

1717
<!-- toc -->
1818

19-
- [Features](#features)
20-
- [Usage](#usage)
21-
- [REST API example](#rest-api-example)
22-
- [GraphQL example](#graphql-example)
23-
- [Alternative: pass `method` & `url` as part of options](#alternative-pass-method--url-as-part-of-options)
24-
- [Authentication](#authentication)
25-
- [request()](#request)
26-
- [`request.defaults()`](#requestdefaults)
27-
- [`request.endpoint`](#requestendpoint)
28-
- [Special cases](#special-cases)
29-
- [The `data` parameter – set request body directly](#the-data-parameter-%E2%80%93-set-request-body-directly)
30-
- [Set parameters for both the URL/query and the request body](#set-parameters-for-both-the-urlquery-and-the-request-body)
31-
- [LICENSE](#license)
19+
- [request.js](#requestjs)
20+
- [Features](#features)
21+
- [Usage](#usage)
22+
- [REST API example](#rest-api-example)
23+
- [GraphQL example](#graphql-example)
24+
- [Alternative: pass `method` \& `url` as part of options](#alternative-pass-method--url-as-part-of-options)
25+
- [Authentication](#authentication)
26+
- [request()](#request)
27+
- [`request.defaults()`](#requestdefaults)
28+
- [`request.endpoint`](#requestendpoint)
29+
- [Special cases](#special-cases)
30+
- [The `data` parameter – set request body directly](#the-data-parameter--set-request-body-directly)
31+
- [Set parameters for both the URL/query and the request body](#set-parameters-for-both-the-urlquery-and-the-request-body)
32+
- [LICENSE](#license)
3233

3334
<!-- tocstop -->
3435

@@ -85,8 +86,8 @@ Node
8586
Install with <code>npm install @octokit/request</code>
8687

8788
```js
88-
const { request } = require("@octokit/request");
89-
// or: import { request } from "@octokit/request";
89+
import { request } from "@octokit/request";
90+
// or: const { request } = require("@octokit/request");
9091
```
9192

9293
</td></tr>
@@ -163,7 +164,7 @@ const result = await requestWithAuth("GET /user");
163164
For more complex authentication strategies such as GitHub Apps or Basic, we recommend the according authentication library exported by [`@octokit/auth`](https://github.com/octokit/auth.js).
164165

165166
```js
166-
const { createAppAuth } = require("@octokit/auth-app");
167+
import { createAppAuth } from "@octokit/auth-app";
167168
const auth = createAppAuth({
168169
appId: process.env.APP_ID,
169170
privateKey: process.env.PRIVATE_KEY,
@@ -405,7 +406,8 @@ If the error is due to an `AbortSignal` being used, the resulting `AbortError` i
405406
Override or set default options. Example:
406407

407408
```js
408-
const myrequest = require("@octokit/request").defaults({
409+
import { request } from "@octokit/request";
410+
const myrequest = request.defaults({
409411
baseUrl: "https://github-enterprise.acme-inc.com/api/v3",
410412
headers: {
411413
"user-agent": "myApp/1.2.3",

0 commit comments

Comments
 (0)