Skip to content

Commit 0da7c88

Browse files
authored
docs(readme): use 'user-agent' instead of 'agent' as 'header' option in 'Sentible defauls' section (#608)
1 parent 3bedf48 commit 0da7c88

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 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

@@ -56,7 +57,7 @@ request("POST /repos/{owner}/{repo}/issues/{number}/labels", {
5657

5758
- `baseUrl`: `https://api.github.com`
5859
- `headers.accept`: `application/vnd.github.v3+json`
59-
- `headers.agent`: `octokit-request.js/<current version> <OS information>`, e.g. `octokit-request.js/1.2.3 Node.js/10.15.0 (macOS Mojave; x64)`
60+
- `headers['user-agent']`: `octokit-request.js/<current version> <OS information>`, e.g. `octokit-request.js/1.2.3 Node.js/10.15.0 (macOS Mojave; x64)`
6061

6162
👌 Simple to test: mock requests by passing a custom fetch method.
6263

0 commit comments

Comments
 (0)