2478 lines
84 KiB
Markdown
2478 lines
84 KiB
Markdown
<div align="center">
|
||
<br>
|
||
<br>
|
||
<img width="360" src="media/logo.svg" alt="Got">
|
||
<br>
|
||
<br>
|
||
<br>
|
||
<p align="center">Huge thanks to <a href="https://moxy.studio"><img src="https://sindresorhus.com/assets/thanks/moxy-logo.svg" valign="middle" width="150"></a> for sponsoring Sindre Sorhus!
|
||
</p>
|
||
<p align="center"><sup>(they love Got too!)</sup></p>
|
||
<br>
|
||
<br>
|
||
</div>
|
||
|
||
> Human-friendly and powerful HTTP request library for Node.js
|
||
|
||
[](https://travis-ci.com/github/sindresorhus/got)
|
||
[](https://coveralls.io/github/sindresorhus/got?branch=master)
|
||
[](https://npmjs.com/got)
|
||
[](https://packagephobia.now.sh/result?p=got)
|
||
|
||
[Moving from Request?](documentation/migration-guides.md) [*(Note that Request is unmaintained)*](https://github.com/request/request/issues/3142)
|
||
|
||
[See how Got compares to other HTTP libraries](#comparison)
|
||
|
||
For browser usage, we recommend [Ky](https://github.com/sindresorhus/ky) by the same people.
|
||
|
||
## Highlights
|
||
|
||
- [Promise API](#api)
|
||
- [Stream API](#streams)
|
||
- [Pagination API](#pagination)
|
||
- [HTTP2 support](#http2)
|
||
- [Request cancelation](#aborting-the-request)
|
||
- [RFC compliant caching](#cache-adapters)
|
||
- [Follows redirects](#followredirect)
|
||
- [Retries on failure](#retry)
|
||
- [Progress events](#onuploadprogress-progress)
|
||
- [Handles gzip/deflate/brotli](#decompress)
|
||
- [Timeout handling](#timeout)
|
||
- [Errors with metadata](#errors)
|
||
- [JSON mode](#json-mode)
|
||
- [WHATWG URL support](#url)
|
||
- [HTTPS API](#advanced-https-api)
|
||
- [Hooks](#hooks)
|
||
- [Instances with custom defaults](#instances)
|
||
- [Types](#types)
|
||
- [Composable](documentation/advanced-creation.md#merging-instances)
|
||
- [Plugins](documentation/lets-make-a-plugin.md)
|
||
- [Used by 4K+ packages and 1.8M+ repos](https://github.com/sindresorhus/got/network/dependents)
|
||
- [Actively maintained](https://github.com/sindresorhus/got/graphs/contributors)
|
||
- [Trusted by many companies](#widely-used)
|
||
|
||
## Install
|
||
|
||
```
|
||
$ npm install got
|
||
```
|
||
|
||
## Usage
|
||
|
||
###### Promise
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
try {
|
||
const response = await got('https://sindresorhus.com');
|
||
console.log(response.body);
|
||
//=> '<!doctype html> ...'
|
||
} catch (error) {
|
||
console.log(error.response.body);
|
||
//=> 'Internal server error ...'
|
||
}
|
||
})();
|
||
```
|
||
|
||
###### JSON
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
const {body} = await got.post('https://httpbin.org/anything', {
|
||
json: {
|
||
hello: 'world'
|
||
},
|
||
responseType: 'json'
|
||
});
|
||
|
||
console.log(body.data);
|
||
//=> {hello: 'world'}
|
||
})();
|
||
```
|
||
|
||
See [JSON mode](#json-mode) for more details.
|
||
|
||
###### Streams
|
||
|
||
```js
|
||
const stream = require('stream');
|
||
const {promisify} = require('util');
|
||
const fs = require('fs');
|
||
const got = require('got');
|
||
|
||
const pipeline = promisify(stream.pipeline);
|
||
|
||
(async () => {
|
||
await pipeline(
|
||
got.stream('https://sindresorhus.com'),
|
||
fs.createWriteStream('index.html')
|
||
);
|
||
|
||
// For POST, PUT, PATCH, and DELETE methods, `got.stream` returns a `stream.Writable`.
|
||
await pipeline(
|
||
fs.createReadStream('index.html'),
|
||
got.stream.post('https://sindresorhus.com')
|
||
);
|
||
})();
|
||
```
|
||
|
||
**Tip:** `from.pipe(to)` doesn't forward errors. Instead, use [`stream.pipeline(from, ..., to, callback)`](https://nodejs.org/api/stream.html#stream_stream_pipeline_streams_callback).
|
||
|
||
**Note:** While `got.post('https://example.com')` resolves, `got.stream.post('https://example.com')` will hang indefinitely until a body is provided. If there's no body on purpose, remember to `.end()` the stream or set the [`body`](#body) option to an empty string.
|
||
|
||
### API
|
||
|
||
It's a `GET` request by default, but can be changed by using different methods or via [`options.method`](#method).
|
||
|
||
**By default, Got will retry on failure. To disable this option, set [`options.retry`](#retry) to `0`.**
|
||
|
||
#### got(url?, options?)
|
||
|
||
Returns a Promise giving a [Response object](#response) or a [Got Stream](#streams-1) if `options.isStream` is set to true.
|
||
|
||
##### url
|
||
|
||
Type: `string | object`
|
||
|
||
The URL to request, as a string, a [`https.request` options object](https://nodejs.org/api/https.html#https_https_request_options_callback), or a [WHATWG `URL`](https://nodejs.org/api/url.html#url_class_url).
|
||
|
||
Properties from `options` will override properties in the parsed `url`.
|
||
|
||
If no protocol is specified, it will throw a `TypeError`.
|
||
|
||
**Note:** The query string is **not** parsed as search params. Example:
|
||
|
||
```js
|
||
got('https://example.com/?query=a b'); //=> https://example.com/?query=a%20b
|
||
got('https://example.com/', {searchParams: {query: 'a b'}}); //=> https://example.com/?query=a+b
|
||
|
||
// The query string is overridden by `searchParams`
|
||
got('https://example.com/?query=a b', {searchParams: {query: 'a b'}}); //=> https://example.com/?query=a+b
|
||
```
|
||
|
||
##### options
|
||
|
||
Type: `object`
|
||
|
||
Any of the [`https.request`](https://nodejs.org/api/https.html#https_https_request_options_callback) options.
|
||
|
||
**Note:** Legacy URL support is disabled. `options.path` is supported only for backwards compatibility. Use `options.pathname` and `options.searchParams` instead. `options.auth` has been replaced with `options.username` & `options.password`.
|
||
|
||
###### method
|
||
|
||
Type: `string`\
|
||
Default: `GET`
|
||
|
||
The HTTP method used to make the request.
|
||
|
||
###### prefixUrl
|
||
|
||
Type: `string | URL`
|
||
|
||
When specified, `prefixUrl` will be prepended to `url`. The prefix can be any valid URL, either relative or absolute.\
|
||
A trailing slash `/` is optional - one will be added automatically.
|
||
|
||
**Note:** `prefixUrl` will be ignored if the `url` argument is a URL instance.
|
||
|
||
**Note:** Leading slashes in `input` are disallowed when using this option to enforce consistency and avoid confusion. For example, when the prefix URL is `https://example.com/foo` and the input is `/bar`, there's ambiguity whether the resulting URL would become `https://example.com/foo/bar` or `https://example.com/bar`. The latter is used by browsers.
|
||
|
||
**Tip:** Useful when used with [`got.extend()`](#custom-endpoints) to create niche-specific Got instances.
|
||
|
||
**Tip:** You can change `prefixUrl` using hooks as long as the URL still includes the `prefixUrl`. If the URL doesn't include it anymore, it will throw.
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
await got('unicorn', {prefixUrl: 'https://cats.com'});
|
||
//=> 'https://cats.com/unicorn'
|
||
|
||
const instance = got.extend({
|
||
prefixUrl: 'https://google.com'
|
||
});
|
||
|
||
await instance('unicorn', {
|
||
hooks: {
|
||
beforeRequest: [
|
||
options => {
|
||
options.prefixUrl = 'https://cats.com';
|
||
}
|
||
]
|
||
}
|
||
});
|
||
//=> 'https://cats.com/unicorn'
|
||
})();
|
||
```
|
||
|
||
###### headers
|
||
|
||
Type: `object`\
|
||
Default: `{}`
|
||
|
||
Request headers.
|
||
|
||
Existing headers will be overwritten. Headers set to `undefined` will be omitted.
|
||
|
||
###### isStream
|
||
|
||
Type: `boolean`\
|
||
Default: `false`
|
||
|
||
Returns a `Stream` instead of a `Promise`. This is equivalent to calling `got.stream(url, options?)`.
|
||
|
||
###### body
|
||
|
||
Type: `string | Buffer | stream.Readable` or [`form-data` instance](https://github.com/form-data/form-data)
|
||
|
||
**Note #1:** The `body` option cannot be used with the `json` or `form` option.
|
||
|
||
**Note #2:** If you provide this option, `got.stream()` will be read-only.
|
||
|
||
**Note #3:** If you provide a payload with the `GET` or `HEAD` method, it will throw a `TypeError` unless the method is `GET` and the `allowGetBody` option is set to `true`.
|
||
|
||
**Note #4:** This option is not enumerable and will not be merged with the instance defaults.
|
||
|
||
The `content-length` header will be automatically set if `body` is a `string` / `Buffer` / `fs.createReadStream` instance / [`form-data` instance](https://github.com/form-data/form-data), and `content-length` and `transfer-encoding` are not manually set in `options.headers`.
|
||
|
||
###### json
|
||
|
||
Type: `object | Array | number | string | boolean | null` *(JSON-serializable values)*
|
||
|
||
**Note #1:** If you provide this option, `got.stream()` will be read-only.\
|
||
**Note #2:** This option is not enumerable and will not be merged with the instance defaults.
|
||
|
||
JSON body. If the `Content-Type` header is not set, it will be set to `application/json`.
|
||
|
||
###### context
|
||
|
||
Type: `object`
|
||
|
||
User data. In contrast to other options, `context` is not enumerable.
|
||
|
||
**Note:** The object is never merged, it's just passed through. Got will not modify the object in any way.
|
||
|
||
It's very useful for storing auth tokens:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
const instance = got.extend({
|
||
hooks: {
|
||
beforeRequest: [
|
||
options => {
|
||
if (!options.context || !options.context.token) {
|
||
throw new Error('Token required');
|
||
}
|
||
|
||
options.headers.token = options.context.token;
|
||
}
|
||
]
|
||
}
|
||
});
|
||
|
||
(async () => {
|
||
const context = {
|
||
token: 'secret'
|
||
};
|
||
|
||
const response = await instance('https://httpbin.org/headers', {context});
|
||
|
||
// Let's see the headers
|
||
console.log(response.body);
|
||
})();
|
||
```
|
||
|
||
###### responseType
|
||
|
||
Type: `string`\
|
||
Default: `'text'`
|
||
|
||
**Note:** When using streams, this option is ignored.
|
||
|
||
The parsing method. Can be `'text'`, `'json'` or `'buffer'`.
|
||
|
||
The promise also has `.text()`, `.json()` and `.buffer()` methods which return another Got promise for the parsed body.\
|
||
It's like setting the options to `{responseType: 'json', resolveBodyOnly: true}` but without affecting the main Got promise.
|
||
|
||
Example:
|
||
|
||
```js
|
||
(async () => {
|
||
const responsePromise = got(url);
|
||
const bufferPromise = responsePromise.buffer();
|
||
const jsonPromise = responsePromise.json();
|
||
|
||
const [response, buffer, json] = await Promise.all([responsePromise, bufferPromise, jsonPromise]);
|
||
// `response` is an instance of Got Response
|
||
// `buffer` is an instance of Buffer
|
||
// `json` is an object
|
||
})();
|
||
```
|
||
|
||
```js
|
||
// This
|
||
const body = await got(url).json();
|
||
|
||
// is semantically the same as this
|
||
const body = await got(url, {responseType: 'json', resolveBodyOnly: true});
|
||
```
|
||
|
||
**Note:** `buffer` will return the raw body buffer. Modifying it will also alter the result of `promise.text()` and `promise.json()`. Before overwritting the buffer, please copy it first via `Buffer.from(buffer)`. See https://github.com/nodejs/node/issues/27080
|
||
|
||
###### parseJson
|
||
|
||
Type: `(text: string) => unknown`\
|
||
Default: `(text: string) => JSON.parse(text)`
|
||
|
||
A function used to parse JSON responses.
|
||
|
||
<details>
|
||
<summary>Example</summary>
|
||
|
||
Using [`bourne`](https://github.com/hapijs/bourne) to prevent prototype pollution:
|
||
|
||
```js
|
||
const got = require('got');
|
||
const Bourne = require('@hapi/bourne');
|
||
|
||
(async () => {
|
||
const parsed = await got('https://example.com', {
|
||
parseJson: text => Bourne.parse(text)
|
||
}).json();
|
||
|
||
console.log(parsed);
|
||
})();
|
||
```
|
||
</details>
|
||
|
||
###### stringifyJson
|
||
|
||
Type: `(object: unknown) => string`\
|
||
Default: `(object: unknown) => JSON.stringify(object)`
|
||
|
||
A function used to stringify the body of JSON requests.
|
||
|
||
<details>
|
||
<summary>Examples</summary>
|
||
|
||
Ignore properties starting with `_`:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
await got.post('https://example.com', {
|
||
stringifyJson: object => JSON.stringify(object, (key, value) => {
|
||
if (key.startsWith('_')) {
|
||
return;
|
||
}
|
||
|
||
return value;
|
||
}),
|
||
json: {
|
||
some: 'payload',
|
||
_ignoreMe: 1234
|
||
}
|
||
});
|
||
})();
|
||
```
|
||
|
||
All numbers as strings:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
await got.post('https://example.com', {
|
||
stringifyJson: object => JSON.stringify(object, (key, value) => {
|
||
if (typeof value === 'number') {
|
||
return value.toString();
|
||
}
|
||
|
||
return value;
|
||
}),
|
||
json: {
|
||
some: 'payload',
|
||
number: 1
|
||
}
|
||
});
|
||
})();
|
||
```
|
||
</details>
|
||
|
||
###### resolveBodyOnly
|
||
|
||
Type: `boolean`\
|
||
Default: `false`
|
||
|
||
When set to `true` the promise will return the [Response body](#body-1) instead of the [Response](#response) object.
|
||
|
||
###### cookieJar
|
||
|
||
Type: `object` | [`tough.CookieJar` instance](https://github.com/salesforce/tough-cookie#cookiejar)
|
||
|
||
**Note:** If you provide this option, `options.headers.cookie` will be overridden.
|
||
|
||
Cookie support. You don't have to care about parsing or how to store them. [Example](#cookies).
|
||
|
||
###### cookieJar.setCookie
|
||
|
||
Type: `Function<Promise>`
|
||
|
||
The function takes two arguments: `rawCookie` (`string`) and `url` (`string`).
|
||
|
||
###### cookieJar.getCookieString
|
||
|
||
Type: `Function<Promise>`
|
||
|
||
The function takes one argument: `url` (`string`).
|
||
|
||
###### ignoreInvalidCookies
|
||
|
||
Type: `boolean`\
|
||
Default: `false`
|
||
|
||
Ignore invalid cookies instead of throwing an error. Only useful when the `cookieJar` option has been set. Not recommended.
|
||
|
||
###### encoding
|
||
|
||
Type: `string`\
|
||
Default: `'utf8'`
|
||
|
||
[Encoding](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings) to be used on `setEncoding` of the response data.
|
||
|
||
To get a [`Buffer`](https://nodejs.org/api/buffer.html), you need to set [`responseType`](#responseType) to `buffer` instead. Don't set this option to `null`.
|
||
|
||
**Note:** This doesn't affect streams! Instead, you need to do `got.stream(...).setEncoding(encoding)`.
|
||
|
||
###### form
|
||
|
||
Type: `object`
|
||
|
||
**Note #1:** If you provide this option, `got.stream()` will be read-only.\
|
||
**Note #2:** This option is not enumerable and will not be merged with the instance defaults.
|
||
|
||
The form body is converted to a query string using [`(new URLSearchParams(object)).toString()`](https://nodejs.org/api/url.html#url_constructor_new_urlsearchparams_obj).
|
||
|
||
If the `Content-Type` header is not present, it will be set to `application/x-www-form-urlencoded`.
|
||
|
||
###### searchParams
|
||
|
||
Type: `string | object<string, string | number> | URLSearchParams`
|
||
|
||
Query string that will be added to the request URL. This will override the query string in `url`.
|
||
|
||
If you need to pass in an array, you can do it using a `URLSearchParams` instance:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
const searchParams = new URLSearchParams([['key', 'a'], ['key', 'b']]);
|
||
|
||
got('https://example.com', {searchParams});
|
||
|
||
console.log(searchParams.toString());
|
||
//=> 'key=a&key=b'
|
||
```
|
||
|
||
There are some exceptions in regards to `URLSearchParams` behavior:
|
||
|
||
**Note #1:** `null` values are not stringified, an empty string is used instead.
|
||
|
||
**Note #2:** `undefined` values are not stringified, the entry is skipped instead.
|
||
|
||
###### timeout
|
||
|
||
Type: `number | object`
|
||
|
||
Milliseconds to wait for the server to end the response before aborting the request with [`got.TimeoutError`](#gottimeouterror) error (a.k.a. `request` property). By default, there's no timeout.
|
||
|
||
This also accepts an `object` with the following fields to constrain the duration of each phase of the request lifecycle:
|
||
|
||
- `lookup` starts when a socket is assigned and ends when the hostname has been resolved. Does not apply when using a Unix domain socket.
|
||
- `connect` starts when `lookup` completes (or when the socket is assigned if lookup does not apply to the request) and ends when the socket is connected.
|
||
- `secureConnect` starts when `connect` completes and ends when the handshaking process completes (HTTPS only).
|
||
- `socket` starts when the socket is connected. See [request.setTimeout](https://nodejs.org/api/http.html#http_request_settimeout_timeout_callback).
|
||
- `response` starts when the request has been written to the socket and ends when the response headers are received.
|
||
- `send` starts when the socket is connected and ends with the request has been written to the socket.
|
||
- `request` starts when the request is initiated and ends when the response's end event fires.
|
||
|
||
###### retry
|
||
|
||
Type: `number | object`\
|
||
Default:
|
||
- limit: `2`
|
||
- calculateDelay: `({attemptCount, retryOptions, error, computedValue}) => computedValue | Promise<computedValue>`
|
||
- methods: `GET` `PUT` `HEAD` `DELETE` `OPTIONS` `TRACE`
|
||
- statusCodes: [`408`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) [`413`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413) [`429`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) [`500`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) [`502`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) [`503`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) [`504`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) [`521`](https://support.cloudflare.com/hc/en-us/articles/115003011431#521error) [`522`](https://support.cloudflare.com/hc/en-us/articles/115003011431#522error) [`524`](https://support.cloudflare.com/hc/en-us/articles/115003011431#524error)
|
||
- maxRetryAfter: `undefined`
|
||
- errorCodes: `ETIMEDOUT` `ECONNRESET` `EADDRINUSE` `ECONNREFUSED` `EPIPE` `ENOTFOUND` `ENETUNREACH` `EAI_AGAIN`
|
||
|
||
An object representing `limit`, `calculateDelay`, `methods`, `statusCodes`, `maxRetryAfter` and `errorCodes` fields for maximum retry count, retry handler, allowed methods, allowed status codes, maximum [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) time and allowed error codes.
|
||
|
||
If `maxRetryAfter` is set to `undefined`, it will use `options.timeout`.\
|
||
If [`Retry-After`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After) header is greater than `maxRetryAfter`, it will cancel the request.
|
||
|
||
Delays between retries counts with function `1000 * Math.pow(2, retry - 1) + Math.random() * 100`, where `retry` is attempt number (starts from 1).
|
||
|
||
The `calculateDelay` property is a `function` that receives an object with `attemptCount`, `retryOptions`, `error` and `computedValue` properties for current retry count, the retry options, error and default computed value. The function must return a delay in milliseconds (or a Promise resolving with it) (`0` return value cancels retry).
|
||
|
||
**Note:** The `calculateDelay` function is responsible for the entire cache mechanism, including the `limit` property. To support it, you need to check whether `computedValue` is different than `0`.
|
||
|
||
By default, it retries *only* on the specified methods, status codes, and on these network errors:
|
||
- `ETIMEDOUT`: One of the [timeout](#timeout) limits were reached.
|
||
- `ECONNRESET`: Connection was forcibly closed by a peer.
|
||
- `EADDRINUSE`: Could not bind to any free port.
|
||
- `ECONNREFUSED`: Connection was refused by the server.
|
||
- `EPIPE`: The remote side of the stream being written has been closed.
|
||
- `ENOTFOUND`: Couldn't resolve the hostname to an IP address.
|
||
- `ENETUNREACH`: No internet connection.
|
||
- `EAI_AGAIN`: DNS lookup timed out.
|
||
|
||
<a name="retry-stream"></a>
|
||
|
||
You can retry Got streams too. The implementation looks like this:
|
||
|
||
```js
|
||
const got = require('got');
|
||
const fs = require('fs');
|
||
|
||
let writeStream;
|
||
|
||
const fn = (retryCount = 0) => {
|
||
const stream = got.stream('https://example.com');
|
||
stream.retryCount = retryCount;
|
||
|
||
if (writeStream) {
|
||
writeStream.destroy();
|
||
}
|
||
|
||
writeStream = fs.createWriteStream('example.com');
|
||
|
||
stream.pipe(writeStream);
|
||
|
||
// If you don't attach the listener, it will NOT make a retry.
|
||
// It automatically checks the listener count so it knows whether to retry or not :)
|
||
stream.once('retry', fn);
|
||
};
|
||
|
||
fn();
|
||
```
|
||
|
||
###### followRedirect
|
||
|
||
Type: `boolean`\
|
||
Default: `true`
|
||
|
||
Defines if redirect responses should be followed automatically.
|
||
|
||
Note that if a `303` is sent by the server in response to any request type (`POST`, `DELETE`, etc.), Got will automatically request the resource pointed to in the location header via `GET`. This is in accordance with [the spec](https://tools.ietf.org/html/rfc7231#section-6.4.4).
|
||
|
||
###### methodRewriting
|
||
|
||
Type: `boolean`\
|
||
Default: `true`
|
||
|
||
By default, redirects will use [method rewriting](https://tools.ietf.org/html/rfc7231#section-6.4). For example, when sending a POST request and receiving a `302`, it will resend the body to the new location using the same HTTP method (`POST` in this case).
|
||
|
||
###### allowGetBody
|
||
|
||
Type: `boolean`\
|
||
Default: `false`
|
||
|
||
**Note:** The [RFC 7321](https://tools.ietf.org/html/rfc7231#section-4.3.1) doesn't specify any particular behavior for the GET method having a payload, therefore **it's considered an [anti-pattern](https://en.wikipedia.org/wiki/Anti-pattern)**.
|
||
|
||
Set this to `true` to allow sending body for the `GET` method. However, the [HTTP/2 specification](https://tools.ietf.org/html/rfc7540#section-8.1.3) says that `An HTTP GET request includes request header fields and no payload body`, therefore when using the HTTP/2 protocol this option will have no effect. This option is only meant to interact with non-compliant servers when you have no other choice.
|
||
|
||
###### maxRedirects
|
||
|
||
Type: `number`\
|
||
Default: `10`
|
||
|
||
If exceeded, the request will be aborted and a `MaxRedirectsError` will be thrown.
|
||
|
||
###### decompress
|
||
|
||
Type: `boolean`\
|
||
Default: `true`
|
||
|
||
Decompress the response automatically. This will set the `accept-encoding` header to `gzip, deflate, br` on Node.js 11.7.0+ or `gzip, deflate` for older Node.js versions, unless you set it yourself.
|
||
|
||
Brotli (`br`) support requires Node.js 11.7.0 or later.
|
||
|
||
If this is disabled, a compressed response is returned as a `Buffer`. This may be useful if you want to handle decompression yourself or stream the raw compressed data.
|
||
|
||
###### cache
|
||
|
||
Type: `object | false`\
|
||
Default: `false`
|
||
|
||
[Cache adapter instance](#cache-adapters) for storing cached response data.
|
||
|
||
###### cacheOptions
|
||
|
||
Type: `object | undefined`\
|
||
Default: `{}`
|
||
|
||
[Cache options](https://github.com/kornelski/http-cache-semantics#constructor-options) used for the specified request.
|
||
|
||
###### dnsCache
|
||
|
||
Type: `CacheableLookup | false`\
|
||
Default: `false`
|
||
|
||
An instance of [`CacheableLookup`](https://github.com/szmarczak/cacheable-lookup) used for making DNS lookups. Useful when making lots of requests to different *public* hostnames.
|
||
|
||
**Note:** This should stay disabled when making requests to internal hostnames such as `localhost`, `database.local` etc.\
|
||
`CacheableLookup` uses `dns.resolver4(..)` and `dns.resolver6(...)` under the hood and fall backs to `dns.lookup(...)` when the first two fail, which may lead to additional delay.
|
||
|
||
###### dnsLookupIpVersion
|
||
|
||
Type: `'auto' | 'ipv4' | 'ipv6'`\
|
||
Default: `'auto'`
|
||
|
||
Indicates which DNS record family to use.\
|
||
Values:
|
||
- `auto`: IPv4 (if present) or IPv6
|
||
- `ipv4`: Only IPv4
|
||
- `ipv6`: Only IPv6
|
||
|
||
Note: If you are using the undocumented option `family`, `dnsLookupIpVersion` will override it.
|
||
|
||
```js
|
||
// `api6.ipify.org` will be resolved as IPv4 and the request will be over IPv4 (the website will respond with your public IPv4)
|
||
await got('https://api6.ipify.org', {
|
||
dnsLookupIpVersion: 'ipv4'
|
||
});
|
||
|
||
// `api6.ipify.org` will be resolved as IPv6 and the request will be over IPv6 (the website will respond with your public IPv6)
|
||
await got('https://api6.ipify.org', {
|
||
dnsLookupIpVersion: 'ipv6'
|
||
});
|
||
```
|
||
|
||
###### lookup
|
||
|
||
Type: `Function`\
|
||
Default: [`dns.lookup`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback)
|
||
|
||
Custom DNS resolution logic.
|
||
|
||
The function signature is the same as [`dns.lookup`](https://nodejs.org/api/dns.html#dns_dns_lookup_hostname_options_callback).
|
||
|
||
###### request
|
||
|
||
Type: `Function`\
|
||
Default: `http.request | https.request` *(Depending on the protocol)*
|
||
|
||
Custom request function. The main purpose of this is to [support HTTP2 using a wrapper](https://github.com/szmarczak/http2-wrapper).
|
||
|
||
###### http2
|
||
|
||
Type: `boolean`\
|
||
Default: `false`
|
||
|
||
If set to `true`, Got will additionally accept HTTP2 requests.\
|
||
It will choose either HTTP/1.1 or HTTP/2 depending on the ALPN protocol.
|
||
|
||
**Note:** Overriding `options.request` will disable HTTP2 support.
|
||
|
||
**Note:** This option will default to `true` in the next upcoming major release.
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
const {headers} = await got('https://nghttp2.org/httpbin/anything', {http2: true});
|
||
console.log(headers.via);
|
||
//=> '2 nghttpx'
|
||
})();
|
||
```
|
||
|
||
###### throwHttpErrors
|
||
|
||
Type: `boolean`\
|
||
Default: `true`
|
||
|
||
Determines if a [`got.HTTPError`](#gothttperror) is thrown for unsuccessful responses.
|
||
|
||
If this is disabled, requests that encounter an error status code will be resolved with the `response` instead of throwing. This may be useful if you are checking for resource availability and are expecting error responses.
|
||
|
||
###### agent
|
||
|
||
Type: `object`
|
||
|
||
An object representing `http`, `https` and `http2` keys for [`http.Agent`](https://nodejs.org/api/http.html#http_class_http_agent), [`https.Agent`](https://nodejs.org/api/https.html#https_class_https_agent) and [`http2wrapper.Agent`](https://github.com/szmarczak/http2-wrapper#new-http2agentoptions) instance. This is necessary because a request to one protocol might redirect to another. In such a scenario, Got will switch over to the right protocol agent for you.
|
||
|
||
If a key is not present, it will default to a global agent.
|
||
|
||
```js
|
||
const got = require('got');
|
||
const HttpAgent = require('agentkeepalive');
|
||
const {HttpsAgent} = HttpAgent;
|
||
|
||
got('https://sindresorhus.com', {
|
||
agent: {
|
||
http: new HttpAgent(),
|
||
https: new HttpsAgent()
|
||
}
|
||
});
|
||
```
|
||
|
||
###### hooks
|
||
|
||
Type: `object<string, Function[]>`
|
||
|
||
Hooks allow modifications during the request lifecycle. Hook functions may be async and are run serially.
|
||
|
||
###### hooks.init
|
||
|
||
Type: `Function[]`\
|
||
Default: `[]`
|
||
|
||
Called with plain [request options](#options), right before their normalization. This is especially useful in conjunction with [`got.extend()`](#instances) when the input needs custom handling.
|
||
|
||
See the [Request migration guide](documentation/migration-guides.md#breaking-changes) for an example.
|
||
|
||
**Note #1:** This hook must be synchronous!\
|
||
**Note #2:** Errors in this hook will be converted into an instances of [`RequestError`](#gotrequesterror).\
|
||
**Note #3:** The options object may not have a `url` property. To modify it, use a `beforeRequest` hook instead.
|
||
|
||
###### hooks.beforeRequest
|
||
|
||
Type: `Function[]`\
|
||
Default: `[]`
|
||
|
||
Called with [normalized](source/core/index.ts) [request options](#options). Got will make no further changes to the request before it is sent. This is especially useful in conjunction with [`got.extend()`](#instances) when you want to create an API client that, for example, uses HMAC-signing.
|
||
|
||
**Note:** Changing `options.json` or `options.form` has no effect on the request, you should change `options.body` instead. If needed, update the `options.headers` accordingly. Example:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
got.post({
|
||
json: {payload: 'old'},
|
||
hooks: {
|
||
beforeRequest: [
|
||
options => {
|
||
options.body = JSON.stringify({payload: 'new'});
|
||
options.headers['content-length'] = options.body.length.toString();
|
||
}
|
||
]
|
||
}
|
||
});
|
||
```
|
||
|
||
**Tip:** You can override the `request` function by returning a [`ClientRequest`-like](https://nodejs.org/api/http.html#http_class_http_clientrequest) instance or a [`IncomingMessage`-like](https://nodejs.org/api/http.html#http_class_http_incomingmessage) instance. This is very useful when creating a custom cache mechanism.
|
||
|
||
###### hooks.beforeRedirect
|
||
|
||
Type: `Function[]`\
|
||
Default: `[]`
|
||
|
||
Called with [normalized](source/core/index.ts) [request options](#options) and the redirect [response](#response). Got will make no further changes to the request. This is especially useful when you want to avoid dead sites. Example:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
got('https://example.com', {
|
||
hooks: {
|
||
beforeRedirect: [
|
||
(options, response) => {
|
||
if (options.hostname === 'deadSite') {
|
||
options.hostname = 'fallbackSite';
|
||
}
|
||
}
|
||
]
|
||
}
|
||
});
|
||
```
|
||
|
||
###### hooks.beforeRetry
|
||
|
||
Type: `Function[]`\
|
||
Default: `[]`
|
||
|
||
**Note:** When using streams, this hook is ignored.
|
||
|
||
Called with [normalized](source/normalize-arguments.ts) [request options](#options), the error and the retry count. Got will make no further changes to the request. This is especially useful when some extra work is required before the next try. Example:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
got.post('https://example.com', {
|
||
hooks: {
|
||
beforeRetry: [
|
||
(options, error, retryCount) => {
|
||
if (error.response.statusCode === 413) { // Payload too large
|
||
options.body = getNewBody();
|
||
}
|
||
}
|
||
]
|
||
}
|
||
});
|
||
```
|
||
|
||
**Note:** When retrying in a `afterResponse` hook, all remaining `beforeRetry` hooks will be called without the `error` and `retryCount` arguments.
|
||
|
||
###### hooks.afterResponse
|
||
|
||
Type: `Function[]`\
|
||
Default: `[]`
|
||
|
||
**Note:** When using streams, this hook is ignored.
|
||
|
||
Called with [response object](#response) and a retry function. Calling the retry function will trigger `beforeRetry` hooks.
|
||
|
||
Each function should return the response. This is especially useful when you want to refresh an access token. Example:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
const instance = got.extend({
|
||
hooks: {
|
||
afterResponse: [
|
||
(response, retryWithMergedOptions) => {
|
||
if (response.statusCode === 401) { // Unauthorized
|
||
const updatedOptions = {
|
||
headers: {
|
||
token: getNewToken() // Refresh the access token
|
||
}
|
||
};
|
||
|
||
// Save for further requests
|
||
instance.defaults.options = got.mergeOptions(instance.defaults.options, updatedOptions);
|
||
|
||
// Make a new retry
|
||
return retryWithMergedOptions(updatedOptions);
|
||
}
|
||
|
||
// No changes otherwise
|
||
return response;
|
||
}
|
||
],
|
||
beforeRetry: [
|
||
(options, error, retryCount) => {
|
||
// This will be called on `retryWithMergedOptions(...)`
|
||
}
|
||
]
|
||
},
|
||
mutableDefaults: true
|
||
});
|
||
```
|
||
|
||
###### hooks.beforeError
|
||
|
||
Type: `Function[]`\
|
||
Default: `[]`
|
||
|
||
Called with an `Error` instance. The error is passed to the hook right before it's thrown. This is especially useful when you want to have more detailed errors.
|
||
|
||
**Note:** Errors thrown while normalizing input options are thrown directly and not part of this hook.
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
got('https://api.github.com/some-endpoint', {
|
||
hooks: {
|
||
beforeError: [
|
||
error => {
|
||
const {response} = error;
|
||
if (response && response.body) {
|
||
error.name = 'GitHubError';
|
||
error.message = `${response.body.message} (${response.statusCode})`;
|
||
}
|
||
|
||
return error;
|
||
}
|
||
]
|
||
}
|
||
});
|
||
```
|
||
|
||
##### pagination
|
||
|
||
Type: `object`
|
||
|
||
**Note:** We're [looking for feedback](https://github.com/sindresorhus/got/issues/1052), any ideas on how to improve the API are welcome.
|
||
|
||
###### pagination.transform
|
||
|
||
Type: `Function`\
|
||
Default: `response => JSON.parse(response.body)`
|
||
|
||
A function that transform [`Response`](#response) into an array of items. This is where you should do the parsing.
|
||
|
||
###### pagination.paginate
|
||
|
||
Type: `Function`\
|
||
Default: [`Link` header logic](source/index.ts)
|
||
|
||
The function takes three arguments:
|
||
- `response` - The current response object.
|
||
- `allItems` - An array of the emitted items.
|
||
- `currentItems` - Items from the current response.
|
||
|
||
It should return an object representing Got options pointing to the next page. The options are merged automatically with the previous request, therefore the options returned `pagination.paginate(...)` must reflect changes only. If there are no more pages, `false` should be returned.
|
||
|
||
For example, if you want to stop when the response contains less items than expected, you can use something like this:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
const limit = 10;
|
||
|
||
const items = got.paginate('https://example.com/items', {
|
||
searchParams: {
|
||
limit,
|
||
offset: 0
|
||
},
|
||
pagination: {
|
||
paginate: (response, allItems, currentItems) => {
|
||
const previousSearchParams = response.request.options.searchParams;
|
||
const previousOffset = previousSearchParams.get('offset');
|
||
|
||
if (currentItems.length < limit) {
|
||
return false;
|
||
}
|
||
|
||
return {
|
||
searchParams: {
|
||
...previousSearchParams,
|
||
offset: Number(previousOffset) + limit,
|
||
}
|
||
};
|
||
}
|
||
}
|
||
});
|
||
|
||
console.log('Items from all pages:', items);
|
||
})();
|
||
```
|
||
|
||
###### pagination.filter
|
||
|
||
Type: `Function`\
|
||
Default: `(item, allItems, currentItems) => true`
|
||
|
||
Checks whether the item should be emitted or not.
|
||
|
||
###### pagination.shouldContinue
|
||
|
||
Type: `Function`\
|
||
Default: `(item, allItems, currentItems) => true`
|
||
|
||
Checks whether the pagination should continue.
|
||
|
||
For example, if you need to stop **before** emitting an entry with some flag, you should use `(item, allItems, currentItems) => !item.flag`. If you want to stop **after** emitting the entry, you should use `(item, allItems, currentItems) => allItems.some(entry => entry.flag)` instead.
|
||
|
||
###### pagination.countLimit
|
||
|
||
Type: `number`\
|
||
Default: `Infinity`
|
||
|
||
The maximum amount of items that should be emitted.
|
||
|
||
###### pagination.backoff
|
||
|
||
Type: `number`\
|
||
Default: `0`
|
||
|
||
Milliseconds to wait before the next request is triggered.
|
||
|
||
###### pagination.requestLimit
|
||
|
||
Type: `number`\
|
||
Default: `10000`
|
||
|
||
The maximum amount of request that should be triggered. [Retries on failure](#retry) are not counted towards this limit.
|
||
|
||
For example, it can be helpful during development to avoid an infinite number of requests.
|
||
|
||
###### pagination.stackAllItems
|
||
|
||
Type: `boolean`\
|
||
Default: `true`
|
||
|
||
Defines how the parameter `allItems` in [pagination.paginate](#pagination.paginate), [pagination.filter](#pagination.filter) and [pagination.shouldContinue](#pagination.shouldContinue) is managed. When set to `false`, the parameter `allItems` is always an empty array.
|
||
|
||
This option can be helpful to save on memory usage when working with a large dataset.
|
||
|
||
##### localAddress
|
||
|
||
Type: `string`
|
||
|
||
The IP address used to send the request from.
|
||
|
||
### Advanced HTTPS API
|
||
|
||
Note: If the request is not HTTPS, these options will be ignored.
|
||
|
||
##### https.certificateAuthority
|
||
|
||
Type: `string | Buffer | Array<string | Buffer>`
|
||
|
||
Override the default Certificate Authorities ([from Mozilla](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport))
|
||
|
||
```js
|
||
// Single Certificate Authority
|
||
got('https://example.com', {
|
||
https: {
|
||
certificateAuthority: fs.readFileSync('./my_ca.pem')
|
||
}
|
||
});
|
||
```
|
||
|
||
##### https.key
|
||
|
||
Type: `string | Buffer | Array<string | Buffer> | object[]`
|
||
|
||
Private keys in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.\
|
||
[PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) allows the option of private keys being encrypted. Encrypted keys will be decrypted with `options.https.passphrase`.\
|
||
Multiple keys with different passphrases can be provided as an array of `{pem: <string | Buffer>, passphrase: <string>}`
|
||
|
||
##### https.certificate
|
||
|
||
Type: `string | Buffer | (string | Buffer)[]`
|
||
|
||
[Certificate chains](https://en.wikipedia.org/wiki/X.509#Certificate_chains_and_cross-certification) in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.\
|
||
One cert chain should be provided per private key (`options.https.key`).\
|
||
When providing multiple cert chains, they do not have to be in the same order as their private keys in `options.https.key`.\
|
||
If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.
|
||
|
||
##### https.passphrase
|
||
|
||
Type: `string`
|
||
|
||
The passphrase to decrypt the `options.https.key` (if different keys have different passphrases refer to `options.https.key` documentation).
|
||
|
||
##### https.pfx
|
||
|
||
Type: `string | Buffer | Array<string | Buffer | object>`
|
||
|
||
[PFX or PKCS12](https://en.wikipedia.org/wiki/PKCS_12) encoded private key and certificate chain. Using `options.https.pfx` is an alternative to providing `options.https.key` and `options.https.certificate` individually. A PFX is usually encrypted, and if it is, `options.https.passphrase` will be used to decrypt it.
|
||
|
||
Multiple PFX's can be be provided as an array of unencrypted buffers or an array of objects like:
|
||
|
||
```ts
|
||
{
|
||
buffer: string | Buffer,
|
||
passphrase?: string
|
||
}
|
||
```
|
||
|
||
This object form can only occur in an array. If the provided buffers are encrypted, `object.passphrase` can be used to decrypt them. If `object.passphrase` is not provided, `options.https.passphrase` will be used for decryption.
|
||
|
||
##### Examples for `https.key`, `https.certificate`, `https.passphrase`, and `https.pfx`
|
||
|
||
```js
|
||
// Single key with certificate
|
||
got('https://example.com', {
|
||
https: {
|
||
key: fs.readFileSync('./client_key.pem'),
|
||
certificate: fs.readFileSync('./client_cert.pem')
|
||
}
|
||
});
|
||
|
||
// Multiple keys with certificates (out of order)
|
||
got('https://example.com', {
|
||
https: {
|
||
key: [
|
||
fs.readFileSync('./client_key1.pem'),
|
||
fs.readFileSync('./client_key2.pem')
|
||
],
|
||
certificate: [
|
||
fs.readFileSync('./client_cert2.pem'),
|
||
fs.readFileSync('./client_cert1.pem')
|
||
]
|
||
}
|
||
});
|
||
|
||
// Single key with passphrase
|
||
got('https://example.com', {
|
||
https: {
|
||
key: fs.readFileSync('./client_key.pem'),
|
||
certificate: fs.readFileSync('./client_cert.pem'),
|
||
passphrase: 'client_key_passphrase'
|
||
}
|
||
});
|
||
|
||
// Multiple keys with different passphrases
|
||
got('https://example.com', {
|
||
https: {
|
||
key: [
|
||
{pem: fs.readFileSync('./client_key1.pem'), passphrase: 'passphrase1'},
|
||
{pem: fs.readFileSync('./client_key2.pem'), passphrase: 'passphrase2'},
|
||
],
|
||
certificate: [
|
||
fs.readFileSync('./client_cert1.pem'),
|
||
fs.readFileSync('./client_cert2.pem')
|
||
]
|
||
}
|
||
});
|
||
|
||
// Single encrypted PFX with passphrase
|
||
got('https://example.com', {
|
||
https: {
|
||
pfx: fs.readFileSync('./fake.pfx'),
|
||
passphrase: 'passphrase'
|
||
}
|
||
});
|
||
|
||
// Multiple encrypted PFX's with different passphrases
|
||
got('https://example.com', {
|
||
https: {
|
||
pfx: [
|
||
{
|
||
buffer: fs.readFileSync('./key1.pfx'),
|
||
passphrase: 'passphrase1'
|
||
},
|
||
{
|
||
buffer: fs.readFileSync('./key2.pfx'),
|
||
passphrase: 'passphrase2'
|
||
}
|
||
]
|
||
}
|
||
});
|
||
|
||
// Multiple encrypted PFX's with single passphrase
|
||
got('https://example.com', {
|
||
https: {
|
||
passphrase: 'passphrase',
|
||
pfx: [
|
||
{
|
||
buffer: fs.readFileSync('./key1.pfx')
|
||
},
|
||
{
|
||
buffer: fs.readFileSync('./key2.pfx')
|
||
}
|
||
]
|
||
}
|
||
});
|
||
```
|
||
|
||
##### https.rejectUnauthorized
|
||
|
||
Type: `boolean`\
|
||
Default: `true`
|
||
|
||
If set to `false`, all invalid SSL certificates will be ignored and no error will be thrown.\
|
||
If set to `true`, it will throw an error whenever an invalid SSL certificate is detected.
|
||
|
||
We strongly recommend to have this set to `true` for security reasons.
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
// Correct:
|
||
await got('https://example.com', {
|
||
https: {
|
||
rejectUnauthorized: true
|
||
}
|
||
});
|
||
|
||
// You can disable it when developing an HTTPS app:
|
||
await got('https://localhost', {
|
||
https: {
|
||
rejectUnauthorized: false
|
||
}
|
||
});
|
||
|
||
// Never do this:
|
||
await got('https://example.com', {
|
||
https: {
|
||
rejectUnauthorized: false
|
||
}
|
||
});
|
||
```
|
||
|
||
##### https.checkServerIdentity
|
||
|
||
Type: `Function`\
|
||
Signature: `(hostname: string, certificate: DetailedPeerCertificate) => Error | undefined`\
|
||
Default: `tls.checkServerIdentity` (from the `tls` module)
|
||
|
||
This function enable a custom check of the certificate.\
|
||
Note: In order to have the function called the certificate must not be `expired`, `self-signed` or with an `untrusted-root`.\
|
||
The function parameters are:
|
||
- `hostname`: The server hostname (used when connecting)
|
||
- `certificate`: The server certificate
|
||
|
||
The function must return `undefined` if the check succeeded or an `Error` if it failed.
|
||
|
||
```js
|
||
await got('https://example.com', {
|
||
https: {
|
||
checkServerIdentity: (hostname, certificate) => {
|
||
if (hostname === 'example.com') {
|
||
return; // Certificate OK
|
||
}
|
||
|
||
return new Error('Invalid Hostname'); // Certificate NOT OK
|
||
}
|
||
}
|
||
});
|
||
```
|
||
|
||
#### Response
|
||
|
||
The response object will typically be a [Node.js HTTP response stream](https://nodejs.org/api/http.html#http_class_http_incomingmessage), however, if returned from the cache it will be a [response-like object](https://github.com/lukechilds/responselike) which behaves in the same way.
|
||
|
||
##### request
|
||
|
||
Type: `object`
|
||
|
||
**Note:** This is not a [http.ClientRequest](https://nodejs.org/api/http.html#http_class_http_clientrequest).
|
||
|
||
- `options` - The Got options that were set on this request.
|
||
|
||
##### body
|
||
|
||
Type: `string | object | Buffer` *(Depending on `options.responseType`)*
|
||
|
||
The result of the request.
|
||
|
||
##### rawBody
|
||
|
||
Type: `Buffer`
|
||
|
||
The raw result of the request.
|
||
|
||
##### url
|
||
|
||
Type: `string`
|
||
|
||
The request URL or the final URL after redirects.
|
||
|
||
##### ip
|
||
|
||
Type: `string`
|
||
|
||
The remote IP address.
|
||
|
||
**Note:** Not available when the response is cached. This is hopefully a temporary limitation, see [lukechilds/cacheable-request#86](https://github.com/lukechilds/cacheable-request/issues/86).
|
||
|
||
##### requestUrl
|
||
|
||
Type: `string`
|
||
|
||
The original request URL.
|
||
|
||
##### timings
|
||
|
||
Type: `object`
|
||
|
||
The object contains the following properties:
|
||
|
||
- `start` - Time when the request started.
|
||
- `socket` - Time when a socket was assigned to the request.
|
||
- `lookup` - Time when the DNS lookup finished.
|
||
- `connect` - Time when the socket successfully connected.
|
||
- `secureConnect` - Time when the socket securely connected.
|
||
- `upload` - Time when the request finished uploading.
|
||
- `response` - Time when the request fired `response` event.
|
||
- `end` - Time when the response fired `end` event.
|
||
- `error` - Time when the request fired `error` event.
|
||
- `abort` - Time when the request fired `abort` event.
|
||
- `phases`
|
||
- `wait` - `timings.socket - timings.start`
|
||
- `dns` - `timings.lookup - timings.socket`
|
||
- `tcp` - `timings.connect - timings.lookup`
|
||
- `tls` - `timings.secureConnect - timings.connect`
|
||
- `request` - `timings.upload - (timings.secureConnect || timings.connect)`
|
||
- `firstByte` - `timings.response - timings.upload`
|
||
- `download` - `timings.end - timings.response`
|
||
- `total` - `(timings.end || timings.error || timings.abort) - timings.start`
|
||
|
||
If something has not been measured yet, it will be `undefined`.
|
||
|
||
**Note:** The time is a `number` representing the milliseconds elapsed since the UNIX epoch.
|
||
|
||
##### isFromCache
|
||
|
||
Type: `boolean`
|
||
|
||
Whether the response was retrieved from the cache.
|
||
|
||
##### redirectUrls
|
||
|
||
Type: `string[]`
|
||
|
||
The redirect URLs.
|
||
|
||
##### retryCount
|
||
|
||
Type: `number`
|
||
|
||
The number of times the request was retried.
|
||
|
||
#### Streams
|
||
|
||
**Note:** Progress events, redirect events and request/response events can also be used with promises.
|
||
|
||
**Note:** To access `response.isFromCache` you need to use `got.stream(url, options).isFromCache`. The value will be undefined until the `response` event.
|
||
|
||
#### got.stream(url, options?)
|
||
|
||
Sets `options.isStream` to `true`.
|
||
|
||
Returns a [duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex) with additional events:
|
||
|
||
##### .on('request', request)
|
||
|
||
`request` event to get the request object of the request.
|
||
|
||
**Tip:** You can use `request` event to abort request:
|
||
|
||
```js
|
||
got.stream('https://github.com')
|
||
.on('request', request => setTimeout(() => request.destroy(), 50));
|
||
```
|
||
|
||
##### .on('response', response)
|
||
|
||
The `response` event to get the response object of the final request.
|
||
|
||
##### .on('redirect', response, nextOptions)
|
||
|
||
The `redirect` event to get the response object of a redirect. The second argument is options for the next request to the redirect location.
|
||
|
||
##### .on('uploadProgress', progress)
|
||
##### .uploadProgress
|
||
##### .on('downloadProgress', progress)
|
||
##### .downloadProgress
|
||
|
||
Progress events for uploading (sending a request) and downloading (receiving a response). The `progress` argument is an object like:
|
||
|
||
```js
|
||
{
|
||
percent: 0.1,
|
||
transferred: 1024,
|
||
total: 10240
|
||
}
|
||
```
|
||
|
||
If the `content-length` header is missing, `total` will be `undefined`.
|
||
|
||
```js
|
||
(async () => {
|
||
const response = await got('https://sindresorhus.com')
|
||
.on('downloadProgress', progress => {
|
||
// Report download progress
|
||
})
|
||
.on('uploadProgress', progress => {
|
||
// Report upload progress
|
||
});
|
||
|
||
console.log(response);
|
||
})();
|
||
```
|
||
|
||
##### .once('retry', retryCount, error)
|
||
|
||
To enable retrying on a Got stream, it is required to have a `retry` handler attached.\
|
||
When this event is emitted, you should reset the stream you were writing to and prepare the body again.
|
||
|
||
See the [`retry`](#retry-stream) option for an example implementation.
|
||
|
||
##### .ip
|
||
|
||
Type: `string`
|
||
|
||
The remote IP address.
|
||
|
||
##### .aborted
|
||
|
||
Type: `boolean`
|
||
|
||
Indicates whether the request has been aborted or not.
|
||
|
||
##### .timings
|
||
|
||
The same as `response.timings`.
|
||
|
||
##### .isFromCache
|
||
|
||
The same as `response.isFromCache`.
|
||
|
||
##### .socket
|
||
|
||
The same as `response.socket`.
|
||
|
||
##### .on('error', error)
|
||
|
||
The emitted `error` is an instance of [`RequestError`](#gotrequesterror).
|
||
|
||
#### Pagination
|
||
|
||
#### got.paginate(url, options?)
|
||
#### got.paginate.each(url, options?)
|
||
|
||
Returns an async iterator:
|
||
|
||
```js
|
||
(async () => {
|
||
const countLimit = 10;
|
||
|
||
const pagination = got.paginate('https://api.github.com/repos/sindresorhus/got/commits', {
|
||
pagination: {countLimit}
|
||
});
|
||
|
||
console.log(`Printing latest ${countLimit} Got commits (newest to oldest):`);
|
||
|
||
for await (const commitData of pagination) {
|
||
console.log(commitData.commit.message);
|
||
}
|
||
})();
|
||
```
|
||
|
||
See [`options.pagination`](#pagination) for more pagination options.
|
||
|
||
#### got.paginate.all(url, options?)
|
||
|
||
Returns a Promise for an array of all results:
|
||
|
||
```js
|
||
(async () => {
|
||
const countLimit = 10;
|
||
|
||
const results = await got.paginate.all('https://api.github.com/repos/sindresorhus/got/commits', {
|
||
pagination: {countLimit}
|
||
});
|
||
|
||
console.log(`Printing latest ${countLimit} Got commits (newest to oldest):`);
|
||
console.log(results);
|
||
})();
|
||
```
|
||
|
||
See [`options.pagination`](#pagination) for more pagination options.
|
||
|
||
#### got.get(url, options?)
|
||
#### got.post(url, options?)
|
||
#### got.put(url, options?)
|
||
#### got.patch(url, options?)
|
||
#### got.head(url, options?)
|
||
#### got.delete(url, options?)
|
||
|
||
Sets [`options.method`](#method) to the method name and makes a request.
|
||
|
||
### Instances
|
||
|
||
#### got.extend(...options)
|
||
|
||
Configure a new `got` instance with default `options`. The `options` are merged with the parent instance's `defaults.options` using [`got.mergeOptions`](#gotmergeoptionsparentoptions-newoptions). You can access the resolved options with the `.defaults` property on the instance.
|
||
|
||
```js
|
||
const client = got.extend({
|
||
prefixUrl: 'https://example.com',
|
||
headers: {
|
||
'x-unicorn': 'rainbow'
|
||
}
|
||
});
|
||
|
||
client.get('demo');
|
||
|
||
/* HTTP Request =>
|
||
* GET /demo HTTP/1.1
|
||
* Host: example.com
|
||
* x-unicorn: rainbow
|
||
*/
|
||
```
|
||
|
||
```js
|
||
(async () => {
|
||
const client = got.extend({
|
||
prefixUrl: 'httpbin.org',
|
||
headers: {
|
||
'x-foo': 'bar'
|
||
}
|
||
});
|
||
const {headers} = await client.get('headers').json();
|
||
//=> headers['x-foo'] === 'bar'
|
||
|
||
const jsonClient = client.extend({
|
||
responseType: 'json',
|
||
resolveBodyOnly: true,
|
||
headers: {
|
||
'x-baz': 'qux'
|
||
}
|
||
});
|
||
const {headers: headers2} = await jsonClient.get('headers');
|
||
//=> headers2['x-foo'] === 'bar'
|
||
//=> headers2['x-baz'] === 'qux'
|
||
})();
|
||
```
|
||
|
||
Additionally, `got.extend()` accepts two properties from the `defaults` object: `mutableDefaults` and `handlers`. Example:
|
||
|
||
```js
|
||
// You can now modify `mutableGot.defaults.options`.
|
||
const mutableGot = got.extend({mutableDefaults: true});
|
||
|
||
const mergedHandlers = got.extend({
|
||
handlers: [
|
||
(options, next) => {
|
||
delete options.headers.referer;
|
||
|
||
return next(options);
|
||
}
|
||
]
|
||
});
|
||
```
|
||
|
||
**Note:** Handlers can be asynchronous. The recommended approach is:
|
||
|
||
```js
|
||
const handler = (options, next) => {
|
||
if (options.isStream) {
|
||
// It's a Stream
|
||
return next(options);
|
||
}
|
||
|
||
// It's a Promise
|
||
return (async () => {
|
||
try {
|
||
const response = await next(options);
|
||
response.yourOwnProperty = true;
|
||
return response;
|
||
} catch (error) {
|
||
// Every error will be replaced by this one.
|
||
// Before you receive any error here,
|
||
// it will be passed to the `beforeError` hooks first.
|
||
// Note: this one won't be passed to `beforeError` hook. It's final.
|
||
throw new Error('Your very own error.');
|
||
}
|
||
})();
|
||
};
|
||
|
||
const instance = got.extend({handlers: [handler]});
|
||
```
|
||
|
||
#### got.extend(...options, ...instances, ...)
|
||
|
||
Merges many instances into a single one:
|
||
- options are merged using [`got.mergeOptions()`](#gotmergeoptionsparentoptions-newoptions) (including hooks),
|
||
- handlers are stored in an array (you can access them through `instance.defaults.handlers`).
|
||
|
||
```js
|
||
const a = {headers: {cat: 'meow'}};
|
||
const b = got.extend({
|
||
options: {
|
||
headers: {
|
||
cow: 'moo'
|
||
}
|
||
}
|
||
});
|
||
|
||
// The same as `got.extend(a).extend(b)`.
|
||
// Note `a` is options and `b` is an instance.
|
||
got.extend(a, b);
|
||
//=> {headers: {cat: 'meow', cow: 'moo'}}
|
||
```
|
||
|
||
#### got.mergeOptions(parent, ...sources)
|
||
|
||
Extends parent options. Avoid using [object spread](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax#Spread_in_object_literals) as it doesn't work recursively:
|
||
|
||
```js
|
||
const a = {headers: {cat: 'meow', wolf: ['bark', 'wrrr']}};
|
||
const b = {headers: {cow: 'moo', wolf: ['auuu']}};
|
||
|
||
{...a, ...b} // => {headers: {cow: 'moo', wolf: ['auuu']}}
|
||
got.mergeOptions(a, b) // => {headers: {cat: 'meow', cow: 'moo', wolf: ['auuu']}}
|
||
```
|
||
|
||
**Note:** Only Got options are merged! Custom user options should be defined via [`options.context`](#context).
|
||
|
||
Options are deeply merged to a new object. The value of each key is determined as follows:
|
||
|
||
- If the new property is not defined, the old value is used.
|
||
- If the new property is explicitly set to `undefined`:
|
||
- If the parent property is a plain `object`, the parent value is deeply cloned.
|
||
- Otherwise, `undefined` is used.
|
||
- If the parent value is an instance of `URLSearchParams`:
|
||
- If the new value is a `string`, an `object` or an instance of `URLSearchParams`, a new `URLSearchParams` instance is created. The values are merged using [`urlSearchParams.append(key, value)`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams/append). The keys defined in the new value override the keys defined in the parent value. Please note that `null` values point to an empty string and `undefined` values will exclude the entry.
|
||
- Otherwise, the only available value is `undefined`.
|
||
- If the new property is a plain `object`:
|
||
- If the parent property is a plain `object` too, both values are merged recursively into a new `object`.
|
||
- Otherwise, only the new value is deeply cloned.
|
||
- If the new property is an `Array`, it overwrites the old one with a deep clone of the new property.
|
||
- Properties that are not enumerable, such as `context`, `body`, `json`, and `form`, will not be merged.
|
||
- Otherwise, the new value is assigned to the key.
|
||
|
||
```js
|
||
const a = {json: {cat: 'meow'}};
|
||
const b = {json: {cow: 'moo'}};
|
||
|
||
got.mergeOptions(a, b);
|
||
//=> {json: {cow: 'moo'}}
|
||
```
|
||
|
||
#### got.defaults
|
||
|
||
Type: `object`
|
||
|
||
The Got defaults used in that instance.
|
||
|
||
##### [options](#options)
|
||
|
||
##### handlers
|
||
|
||
Type: `Function[]`\
|
||
Default: `[]`
|
||
|
||
An array of functions. You execute them directly by calling `got()`. They are some sort of "global hooks" - these functions are called first. The last handler (*it's hidden*) is either [`asPromise`](source/core/as-promise/index.ts) or [`asStream`](source/core/index.ts), depending on the `options.isStream` property.
|
||
|
||
Each handler takes two arguments:
|
||
|
||
###### [options](#options)
|
||
|
||
###### next()
|
||
|
||
Returns a `Promise` or a `Stream` depending on [`options.isStream`](#isstream).
|
||
|
||
```js
|
||
const settings = {
|
||
handlers: [
|
||
(options, next) => {
|
||
if (options.isStream) {
|
||
// It's a Stream, so we can perform stream-specific actions on it
|
||
return next(options)
|
||
.on('request', request => {
|
||
setTimeout(() => {
|
||
request.abort();
|
||
}, 50);
|
||
});
|
||
}
|
||
|
||
// It's a Promise
|
||
return next(options);
|
||
}
|
||
],
|
||
options: got.mergeOptions(got.defaults.options, {
|
||
responseType: 'json'
|
||
})
|
||
};
|
||
|
||
const jsonGot = got.extend(settings);
|
||
```
|
||
|
||
##### mutableDefaults
|
||
|
||
Type: `boolean`\
|
||
Default: `false`
|
||
|
||
A read-only boolean describing whether the defaults are mutable or not. If set to `true`, you can [update headers over time](#hooksafterresponse), for example, update an access token when it expires.
|
||
|
||
## Types
|
||
|
||
Got exports some handy TypeScript types and interfaces. See the type definition for all the exported types.
|
||
|
||
### Got
|
||
|
||
TypeScript will automatically infer types for Got instances, but in case you want to define something like dependencies, you can import the available types directly from Got.
|
||
|
||
```ts
|
||
import {GotRequestFunction} from 'got';
|
||
|
||
interface Dependencies {
|
||
readonly post: GotRequestFunction
|
||
}
|
||
```
|
||
|
||
### Hooks
|
||
|
||
When writing hooks, you can refer to their types to keep your interfaces consistent.
|
||
|
||
```ts
|
||
import {BeforeRequestHook} from 'got';
|
||
|
||
const addAccessToken = (accessToken: string): BeforeRequestHook => options => {
|
||
options.path = `${options.path}?access_token=${accessToken}`;
|
||
}
|
||
```
|
||
|
||
## Errors
|
||
|
||
Each error contains an `options` property which are the options Got used to create a request - just to make debugging easier.\
|
||
Additionaly, the errors may have `request` (Got Stream) and `response` (Got Response) properties depending on which phase of the request failed.
|
||
|
||
#### got.RequestError
|
||
|
||
When a request fails. Contains a `code` property with error class code, like `ECONNREFUSED`. If there is no specific code supplied, `code` defaults to `ERR_GOT_REQUEST_ERROR`. All the errors below inherit this one.
|
||
|
||
#### got.CacheError
|
||
|
||
When a cache method fails, for example, if the database goes down or there's a filesystem error. Contains a `code` property with `ERR_CACHE_ACCESS` or a more specific failure code.
|
||
|
||
#### got.ReadError
|
||
|
||
When reading from response stream fails. Contains a `code` property with `ERR_READING_RESPONSE_STREAM` or a more specific failure code.
|
||
|
||
#### got.ParseError
|
||
|
||
When server response code is 2xx, and parsing body fails. Includes a `response` property. Contains a `code` property with `ERR_BODY_PARSE_FAILURE` or a more specific failure code.
|
||
|
||
#### got.UploadError
|
||
|
||
When the request body is a stream and an error occurs while reading from that stream. Contains a `code` property with `ERR_UPLOAD` or a more specific failure code.
|
||
|
||
#### got.HTTPError
|
||
|
||
When the server response code is not 2xx nor 3xx if `options.followRedirect` is `true`, but always except for 304. Includes a `response` property. Contains a `code` property with `ERR_NON_2XX_3XX_RESPONSE` or a more specific failure code.
|
||
|
||
|
||
#### got.MaxRedirectsError
|
||
|
||
When the server redirects you more than ten times. Includes a `response` property. Contains a `code` property with `ERR_TOO_MANY_REDIRECTS`.
|
||
|
||
#### got.UnsupportedProtocolError
|
||
|
||
When given an unsupported protocol. Contains a `code` property with `ERR_UNSUPPORTED_PROTOCOL`.
|
||
|
||
#### got.TimeoutError
|
||
|
||
When the request is aborted due to a [timeout](#timeout). Includes an `event` and `timings` property. Contains a `code` property with `ETIMEDOUT`.
|
||
|
||
#### got.CancelError
|
||
|
||
When the request is aborted with `.cancel()`. Contains a `code` property with `ERR_CANCELED`.
|
||
|
||
## Aborting the request
|
||
|
||
The promise returned by Got has a [`.cancel()`](https://github.com/sindresorhus/p-cancelable) method which when called, aborts the request.
|
||
|
||
```js
|
||
(async () => {
|
||
const request = got(url, options);
|
||
|
||
// …
|
||
|
||
// In another part of the code
|
||
if (something) {
|
||
request.cancel();
|
||
}
|
||
|
||
// …
|
||
|
||
try {
|
||
await request;
|
||
} catch (error) {
|
||
if (request.isCanceled) { // Or `error instanceof got.CancelError`
|
||
// Handle cancelation
|
||
}
|
||
|
||
// Handle other errors
|
||
}
|
||
})();
|
||
```
|
||
|
||
When using hooks, simply throw an error to abort the request.
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
const request = got(url, {
|
||
hooks: {
|
||
beforeRequest: [
|
||
() => {
|
||
throw new Error('Oops. Request canceled.');
|
||
}
|
||
]
|
||
}
|
||
});
|
||
|
||
try {
|
||
await request;
|
||
} catch (error) {
|
||
// …
|
||
}
|
||
})();
|
||
```
|
||
|
||
To abort the Got Stream request, just call `stream.destroy()`.
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
const stream = got.stream(url);
|
||
stream.destroy();
|
||
```
|
||
|
||
<a name="cache-adapters"></a>
|
||
## Cache
|
||
|
||
Got implements [RFC 7234](https://httpwg.org/specs/rfc7234.html) compliant HTTP caching which works out of the box in-memory and is easily pluggable with a wide range of storage adapters. Fresh cache entries are served directly from the cache, and stale cache entries are revalidated with `If-None-Match`/`If-Modified-Since` headers. You can read more about the underlying cache behavior in the [`cacheable-request` documentation](https://github.com/lukechilds/cacheable-request). For DNS cache, Got uses [`cacheable-lookup`](https://github.com/szmarczak/cacheable-lookup).
|
||
|
||
You can use the JavaScript `Map` type as an in-memory cache:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
const map = new Map();
|
||
|
||
(async () => {
|
||
let response = await got('https://sindresorhus.com', {cache: map});
|
||
console.log(response.isFromCache);
|
||
//=> false
|
||
|
||
response = await got('https://sindresorhus.com', {cache: map});
|
||
console.log(response.isFromCache);
|
||
//=> true
|
||
})();
|
||
```
|
||
|
||
Got uses [Keyv](https://github.com/lukechilds/keyv) internally to support a wide range of storage adapters. For something more scalable you could use an [official Keyv storage adapter](https://github.com/lukechilds/keyv#official-storage-adapters):
|
||
|
||
```
|
||
$ npm install @keyv/redis
|
||
```
|
||
|
||
```js
|
||
const got = require('got');
|
||
const KeyvRedis = require('@keyv/redis');
|
||
|
||
const redis = new KeyvRedis('redis://user:pass@localhost:6379');
|
||
|
||
got('https://sindresorhus.com', {cache: redis});
|
||
```
|
||
|
||
Got supports anything that follows the Map API, so it's easy to write your own storage adapter or use a third-party solution.
|
||
|
||
For example, the following are all valid storage adapters:
|
||
|
||
```js
|
||
const storageAdapter = new Map();
|
||
// Or
|
||
const storageAdapter = require('./my-storage-adapter');
|
||
// Or
|
||
const QuickLRU = require('quick-lru');
|
||
const storageAdapter = new QuickLRU({maxSize: 1000});
|
||
|
||
got('https://sindresorhus.com', {cache: storageAdapter});
|
||
```
|
||
|
||
View the [Keyv docs](https://github.com/lukechilds/keyv) for more information on how to use storage adapters.
|
||
|
||
## Proxies
|
||
|
||
You can use the [`tunnel`](https://github.com/koichik/node-tunnel) package with the `agent` option to work with proxies:
|
||
|
||
```js
|
||
const got = require('got');
|
||
const tunnel = require('tunnel');
|
||
|
||
got('https://sindresorhus.com', {
|
||
agent: {
|
||
https: tunnel.httpsOverHttp({
|
||
proxy: {
|
||
host: 'localhost'
|
||
}
|
||
})
|
||
}
|
||
});
|
||
```
|
||
|
||
Otherwise, you can use the [`hpagent`](https://github.com/delvedor/hpagent) package, which keeps the internal sockets alive to be reused.
|
||
|
||
```js
|
||
const got = require('got');
|
||
const {HttpsProxyAgent} = require('hpagent');
|
||
|
||
got('https://sindresorhus.com', {
|
||
agent: {
|
||
https: new HttpsProxyAgent({
|
||
keepAlive: true,
|
||
keepAliveMsecs: 1000,
|
||
maxSockets: 256,
|
||
maxFreeSockets: 256,
|
||
scheduling: 'lifo',
|
||
proxy: 'https://localhost:8080'
|
||
})
|
||
}
|
||
});
|
||
```
|
||
|
||
Alternatively, use [`global-agent`](https://github.com/gajus/global-agent) to configure a global proxy for all HTTP/HTTPS traffic in your program.
|
||
|
||
Read the [`http2-wrapper`](https://github.com/szmarczak/http2-wrapper/#proxy-support) docs to learn about proxying for HTTP/2.
|
||
|
||
## Cookies
|
||
|
||
You can use the [`tough-cookie`](https://github.com/salesforce/tough-cookie) package:
|
||
|
||
```js
|
||
const {promisify} = require('util');
|
||
const got = require('got');
|
||
const {CookieJar} = require('tough-cookie');
|
||
|
||
(async () => {
|
||
const cookieJar = new CookieJar();
|
||
const setCookie = promisify(cookieJar.setCookie.bind(cookieJar));
|
||
|
||
await setCookie('foo=bar', 'https://example.com');
|
||
await got('https://example.com', {cookieJar});
|
||
})();
|
||
```
|
||
|
||
## Form data
|
||
|
||
You can use the [`form-data`](https://github.com/form-data/form-data) package to create POST request with form data:
|
||
|
||
```js
|
||
const fs = require('fs');
|
||
const got = require('got');
|
||
const FormData = require('form-data');
|
||
|
||
const form = new FormData();
|
||
|
||
form.append('my_file', fs.createReadStream('/foo/bar.jpg'));
|
||
|
||
got.post('https://example.com', {
|
||
body: form
|
||
});
|
||
```
|
||
|
||
## OAuth
|
||
|
||
You can use the [`oauth-1.0a`](https://github.com/ddo/oauth-1.0a) package to create a signed OAuth request:
|
||
|
||
```js
|
||
const got = require('got');
|
||
const crypto = require('crypto');
|
||
const OAuth = require('oauth-1.0a');
|
||
|
||
const oauth = OAuth({
|
||
consumer: {
|
||
key: process.env.CONSUMER_KEY,
|
||
secret: process.env.CONSUMER_SECRET
|
||
},
|
||
signature_method: 'HMAC-SHA1',
|
||
hash_function: (baseString, key) => crypto.createHmac('sha1', key).update(baseString).digest('base64')
|
||
});
|
||
|
||
const token = {
|
||
key: process.env.ACCESS_TOKEN,
|
||
secret: process.env.ACCESS_TOKEN_SECRET
|
||
};
|
||
|
||
const url = 'https://api.twitter.com/1.1/statuses/home_timeline.json';
|
||
|
||
got(url, {
|
||
headers: oauth.toHeader(oauth.authorize({url, method: 'GET'}, token)),
|
||
responseType: 'json'
|
||
});
|
||
```
|
||
|
||
## Unix Domain Sockets
|
||
|
||
Requests can also be sent via [unix domain sockets](http://serverfault.com/questions/124517/whats-the-difference-between-unix-socket-and-tcp-ip-socket). Use the following URL scheme: `PROTOCOL://unix:SOCKET:PATH`.
|
||
|
||
- `PROTOCOL` - `http` or `https` *(optional)*
|
||
- `SOCKET` - Absolute path to a unix domain socket, for example: `/var/run/docker.sock`
|
||
- `PATH` - Request path, for example: `/v2/keys`
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
got('http://unix:/var/run/docker.sock:/containers/json');
|
||
|
||
// Or without protocol (HTTP by default)
|
||
got('unix:/var/run/docker.sock:/containers/json');
|
||
```
|
||
|
||
## AWS
|
||
|
||
Requests to AWS services need to have their headers signed. This can be accomplished by using the [`got4aws`](https://www.npmjs.com/package/got4aws) package. This is an example for querying an ["API Gateway"](https://docs.aws.amazon.com/apigateway/api-reference/signing-requests/) with a signed request.
|
||
|
||
```js
|
||
const got4aws = require('got4aws');;
|
||
|
||
const awsClient = got4aws();
|
||
|
||
const response = await awsClient('https://<api-id>.execute-api.<api-region>.amazonaws.com/<stage>/endpoint/path', {
|
||
// Request-specific options
|
||
});
|
||
```
|
||
|
||
## Testing
|
||
|
||
You can test your requests by using the [`nock`](https://github.com/node-nock/nock) package to mock an endpoint:
|
||
|
||
```js
|
||
const got = require('got');
|
||
const nock = require('nock');
|
||
|
||
nock('https://sindresorhus.com')
|
||
.get('/')
|
||
.reply(200, 'Hello world!');
|
||
|
||
(async () => {
|
||
const response = await got('https://sindresorhus.com');
|
||
console.log(response.body);
|
||
//=> 'Hello world!'
|
||
})();
|
||
```
|
||
|
||
Bear in mind, that by default `nock` mocks only one request. Got will [retry](#retry) on failed requests by default, causing a `No match for request ...` error. The solution is to either disable retrying (set `options.retry` to `0`) or call `.persist()` on the mocked request.
|
||
|
||
```js
|
||
const got = require('got');
|
||
const nock = require('nock');
|
||
|
||
const scope = nock('https://sindresorhus.com')
|
||
.get('/')
|
||
.reply(500, 'Internal server error')
|
||
.persist();
|
||
|
||
(async () => {
|
||
try {
|
||
await got('https://sindresorhus.com')
|
||
} catch (error) {
|
||
console.log(error.response.body);
|
||
//=> 'Internal server error'
|
||
|
||
console.log(error.response.retryCount);
|
||
//=> 2
|
||
}
|
||
|
||
scope.persist(false);
|
||
})();
|
||
```
|
||
|
||
For real integration testing we recommend using [`ava`](https://github.com/avajs/ava) with [`create-test-server`](https://github.com/lukechilds/create-test-server). We're using a macro so we don't have to `server.listen()` and `server.close()` every test. Take a look at one of our tests:
|
||
|
||
```js
|
||
test('retry function gets iteration count', withServer, async (t, server, got) => {
|
||
let knocks = 0;
|
||
server.get('/', (request, response) => {
|
||
if (knocks++ === 1) {
|
||
response.end('who`s there?');
|
||
}
|
||
});
|
||
|
||
await got({
|
||
retry: {
|
||
calculateDelay: ({attemptCount}) => {
|
||
t.true(is.number(attemptCount));
|
||
return attemptCount < 2 ? 1 : 0;
|
||
}
|
||
}
|
||
});
|
||
});
|
||
```
|
||
|
||
## Tips
|
||
|
||
### JSON mode
|
||
|
||
To pass an object as the body, you need to use the `json` option. It will be stringified using `JSON.stringify`. Example:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
const {body} = await got.post('https://httpbin.org/anything', {
|
||
json: {
|
||
hello: 'world'
|
||
},
|
||
responseType: 'json'
|
||
});
|
||
|
||
console.log(body.data);
|
||
//=> '{"hello":"world"}'
|
||
})();
|
||
```
|
||
|
||
To receive a JSON body you can either set `responseType` option to `json` or use `promise.json()`. Example:
|
||
|
||
```js
|
||
const got = require('got');
|
||
|
||
(async () => {
|
||
const body = await got.post('https://httpbin.org/anything', {
|
||
json: {
|
||
hello: 'world'
|
||
}
|
||
}).json();
|
||
|
||
console.log(body);
|
||
//=> {…}
|
||
})();
|
||
```
|
||
|
||
### User Agent
|
||
|
||
It's a good idea to set the `'user-agent'` header so the provider can more easily see how their resource is used. By default, it's the URL to this repo. You can omit this header by setting it to `undefined`.
|
||
|
||
```js
|
||
const got = require('got');
|
||
const pkg = require('./package.json');
|
||
|
||
got('https://sindresorhus.com', {
|
||
headers: {
|
||
'user-agent': `my-package/${pkg.version} (https://github.com/username/my-package)`
|
||
}
|
||
});
|
||
|
||
got('https://sindresorhus.com', {
|
||
headers: {
|
||
'user-agent': undefined
|
||
}
|
||
});
|
||
```
|
||
|
||
### 304 Responses
|
||
|
||
Bear in mind; if you send an `if-modified-since` header and receive a `304 Not Modified` response, the body will be empty. It's your responsibility to cache and retrieve the body contents.
|
||
|
||
### Custom endpoints
|
||
|
||
Use `got.extend()` to make it nicer to work with REST APIs. Especially if you use the `prefixUrl` option.
|
||
|
||
```js
|
||
const got = require('got');
|
||
const pkg = require('./package.json');
|
||
|
||
const custom = got.extend({
|
||
prefixUrl: 'example.com',
|
||
responseType: 'json',
|
||
headers: {
|
||
'user-agent': `my-package/${pkg.version} (https://github.com/username/my-package)`
|
||
}
|
||
});
|
||
|
||
// Use `custom` exactly how you use `got`
|
||
(async () => {
|
||
const list = await custom('v1/users/list');
|
||
})();
|
||
```
|
||
|
||
## FAQ
|
||
|
||
### Why yet another HTTP client?
|
||
|
||
Got was created because the popular [`request`](https://github.com/request/request) package is bloated: [](https://packagephobia.now.sh/result?p=request)\
|
||
Furthermore, Got is fully written in TypeScript and actively maintained.
|
||
|
||
### Electron support has been removed
|
||
|
||
The Electron `net` module is not consistent with the Node.js `http` module. See [#899](https://github.com/sindresorhus/got/issues/899) for more info.
|
||
|
||
## Comparison
|
||
|
||
| | `got` | [`request`][r0] | [`node-fetch`][n0] | [`ky`][k0] | [`axios`][a0] | [`superagent`][s0] |
|
||
|-----------------------|:------------------:|:------------------:|:--------------------:|:------------------------:|:------------------:|:----------------------:|
|
||
| HTTP/2 support | :sparkle: | :x: | :x: | :x: | :x: | :heavy_check_mark:\*\* |
|
||
| Browser support | :x: | :x: | :heavy_check_mark:\* | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||
| Promise API | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||
| Stream API | :heavy_check_mark: | :heavy_check_mark: | Node.js only | :x: | :x: | :heavy_check_mark: |
|
||
| Pagination API | :heavy_check_mark: | :x: | :x: | :x: | :x: | :x: |
|
||
| Request cancelation | :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||
| RFC compliant caching | :heavy_check_mark: | :x: | :x: | :x: | :x: | :x: |
|
||
| Cookies (out-of-box) | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | :x: | :x: |
|
||
| Follows redirects | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||
| Retries on failure | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||
| Progress events | :heavy_check_mark: | :x: | :x: | :heavy_check_mark:\*\*\* | Browser only | :heavy_check_mark: |
|
||
| Handles gzip/deflate | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||
| Advanced timeouts | :heavy_check_mark: | :x: | :x: | :x: | :x: | :x: |
|
||
| Timings | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: | :x: | :x: |
|
||
| Errors with metadata | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||
| JSON mode | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||
| Custom defaults | :heavy_check_mark: | :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||
| Composable | :heavy_check_mark: | :x: | :x: | :x: | :x: | :heavy_check_mark: |
|
||
| Hooks | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||
| Issues open | [![][gio]][g1] | [![][rio]][r1] | [![][nio]][n1] | [![][kio]][k1] | [![][aio]][a1] | [![][sio]][s1] |
|
||
| Issues closed | [![][gic]][g2] | [![][ric]][r2] | [![][nic]][n2] | [![][kic]][k2] | [![][aic]][a2] | [![][sic]][s2] |
|
||
| Downloads | [![][gd]][g3] | [![][rd]][r3] | [![][nd]][n3] | [![][kd]][k3] | [![][ad]][a3] | [![][sd]][s3] |
|
||
| Coverage | [![][gc]][g4] | [![][rc]][r4] | [![][nc]][n4] | [![][kc]][k4] | [![][ac]][a4] | [![][sc]][s4] |
|
||
| Build | [![][gb]][g5] | [![][rb]][r5] | [![][nb]][n5] | [![][kb]][k5] | [![][ab]][a5] | [![][sb]][s5] |
|
||
| Bugs | [![][gbg]][g6] | [![][rbg]][r6] | [![][nbg]][n6] | [![][kbg]][k6] | [![][abg]][a6] | [![][sbg]][s6] |
|
||
| Dependents | [![][gdp]][g7] | [![][rdp]][r7] | [![][ndp]][n7] | [![][kdp]][k7] | [![][adp]][a7] | [![][sdp]][s7] |
|
||
| Install size | [![][gis]][g8] | [![][ris]][r8] | [![][nis]][n8] | [![][kis]][k8] | [![][ais]][a8] | [![][sis]][s8] |
|
||
| GitHub stars | [![][gs]][g9] | [![][rs]][r9] | [![][ns]][n9] | [![][ks]][k9] | [![][as]][a9] | [![][ss]][s9] |
|
||
| TypeScript support | [![][gts]][g10] | [![][rts]][r10] | [![][nts]][n10] | [![][kts]][k10] | [![][ats]][a10] | [![][sts]][s11] |
|
||
| Last commit | [![][glc]][g11] | [![][rlc]][r11] | [![][nlc]][n11] | [![][klc]][k11] | [![][alc]][a11] | [![][slc]][s11] |
|
||
|
||
\* It's almost API compatible with the browser `fetch` API.\
|
||
\*\* Need to switch the protocol manually. Doesn't accept PUSH streams and doesn't reuse HTTP/2 sessions.\
|
||
\*\*\* Currently, only `DownloadProgress` event is supported, `UploadProgress` event is not supported.\
|
||
:sparkle: Almost-stable feature, but the API may change. Don't hesitate to try it out!\
|
||
:grey_question: Feature in early stage of development. Very experimental.
|
||
|
||
<!-- GITHUB -->
|
||
[k0]: https://github.com/sindresorhus/ky
|
||
[r0]: https://github.com/request/request
|
||
[n0]: https://github.com/node-fetch/node-fetch
|
||
[a0]: https://github.com/axios/axios
|
||
[s0]: https://github.com/visionmedia/superagent
|
||
|
||
<!-- ISSUES OPEN -->
|
||
[gio]: https://badgen.net/github/open-issues/sindresorhus/got?label
|
||
[kio]: https://badgen.net/github/open-issues/sindresorhus/ky?label
|
||
[rio]: https://badgen.net/github/open-issues/request/request?label
|
||
[nio]: https://badgen.net/github/open-issues/bitinn/node-fetch?label
|
||
[aio]: https://badgen.net/github/open-issues/axios/axios?label
|
||
[sio]: https://badgen.net/github/open-issues/visionmedia/superagent?label
|
||
|
||
[g1]: https://github.com/sindresorhus/got/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
|
||
[k1]: https://github.com/sindresorhus/ky/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
|
||
[r1]: https://github.com/request/request/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
|
||
[n1]: https://github.com/bitinn/node-fetch/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
|
||
[a1]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
|
||
[s1]: https://github.com/visionmedia/superagent/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
|
||
|
||
<!-- ISSUES CLOSED -->
|
||
[gic]: https://badgen.net/github/closed-issues/sindresorhus/got?label
|
||
[kic]: https://badgen.net/github/closed-issues/sindresorhus/ky?label
|
||
[ric]: https://badgen.net/github/closed-issues/request/request?label
|
||
[nic]: https://badgen.net/github/closed-issues/bitinn/node-fetch?label
|
||
[aic]: https://badgen.net/github/closed-issues/axios/axios?label
|
||
[sic]: https://badgen.net/github/closed-issues/visionmedia/superagent?label
|
||
|
||
[g2]: https://github.com/sindresorhus/got/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc
|
||
[k2]: https://github.com/sindresorhus/ky/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc
|
||
[r2]: https://github.com/request/request/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc
|
||
[n2]: https://github.com/bitinn/node-fetch/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc
|
||
[a2]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc
|
||
[s2]: https://github.com/visionmedia/superagent/issues?q=is%3Aissue+is%3Aclosed+sort%3Aupdated-desc
|
||
|
||
<!-- DOWNLOADS -->
|
||
[gd]: https://badgen.net/npm/dm/got?label
|
||
[kd]: https://badgen.net/npm/dm/ky?label
|
||
[rd]: https://badgen.net/npm/dm/request?label
|
||
[nd]: https://badgen.net/npm/dm/node-fetch?label
|
||
[ad]: https://badgen.net/npm/dm/axios?label
|
||
[sd]: https://badgen.net/npm/dm/superagent?label
|
||
|
||
[g3]: https://www.npmjs.com/package/got
|
||
[k3]: https://www.npmjs.com/package/ky
|
||
[r3]: https://www.npmjs.com/package/request
|
||
[n3]: https://www.npmjs.com/package/node-fetch
|
||
[a3]: https://www.npmjs.com/package/axios
|
||
[s3]: https://www.npmjs.com/package/superagent
|
||
|
||
<!-- COVERAGE -->
|
||
[gc]: https://badgen.net/coveralls/c/github/sindresorhus/got?label
|
||
[kc]: https://badgen.net/codecov/c/github/sindresorhus/ky?label
|
||
[rc]: https://badgen.net/coveralls/c/github/request/request?label
|
||
[nc]: https://badgen.net/coveralls/c/github/bitinn/node-fetch?label
|
||
[ac]: https://badgen.net/coveralls/c/github/mzabriskie/axios?label
|
||
[sc]: https://badgen.net/codecov/c/github/visionmedia/superagent?label
|
||
|
||
[g4]: https://coveralls.io/github/sindresorhus/got
|
||
[k4]: https://codecov.io/gh/sindresorhus/ky
|
||
[r4]: https://coveralls.io/github/request/request
|
||
[n4]: https://coveralls.io/github/bitinn/node-fetch
|
||
[a4]: https://coveralls.io/github/mzabriskie/axios
|
||
[s4]: https://codecov.io/gh/visionmedia/superagent
|
||
|
||
<!-- BUILD -->
|
||
[gb]: https://badgen.net/travis/sindresorhus/got?label
|
||
[kb]: https://badgen.net/travis/sindresorhus/ky?label
|
||
[rb]: https://badgen.net/travis/request/request?label
|
||
[nb]: https://badgen.net/travis/bitinn/node-fetch?label
|
||
[ab]: https://badgen.net/travis/axios/axios?label
|
||
[sb]: https://badgen.net/travis/visionmedia/superagent?label
|
||
|
||
[g5]: https://travis-ci.com/github/sindresorhus/got
|
||
[k5]: https://travis-ci.com/github/sindresorhus/ky
|
||
[r5]: https://travis-ci.org/github/request/request
|
||
[n5]: https://travis-ci.org/github/bitinn/node-fetch
|
||
[a5]: https://travis-ci.org/github/axios/axios
|
||
[s5]: https://travis-ci.org/github/visionmedia/superagent
|
||
|
||
<!-- BUGS -->
|
||
[gbg]: https://badgen.net/github/label-issues/sindresorhus/got/bug/open?label
|
||
[kbg]: https://badgen.net/github/label-issues/sindresorhus/ky/bug/open?label
|
||
[rbg]: https://badgen.net/github/label-issues/request/request/Needs%20investigation/open?label
|
||
[nbg]: https://badgen.net/github/label-issues/bitinn/node-fetch/bug/open?label
|
||
[abg]: https://badgen.net/github/label-issues/axios/axios/type:confirmed%20bug/open?label
|
||
[sbg]: https://badgen.net/github/label-issues/visionmedia/superagent/Bug/open?label
|
||
|
||
[g6]: https://github.com/sindresorhus/got/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
|
||
[k6]: https://github.com/sindresorhus/ky/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
|
||
[r6]: https://github.com/request/request/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A"Needs+investigation"
|
||
[n6]: https://github.com/bitinn/node-fetch/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Abug
|
||
[a6]: https://github.com/axios/axios/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3Aconfirmed+bug%22
|
||
[s6]: https://github.com/visionmedia/superagent/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3ABug
|
||
|
||
<!-- DEPENDENTS -->
|
||
[gdp]: https://badgen.net/npm/dependents/got?label
|
||
[kdp]: https://badgen.net/npm/dependents/ky?label
|
||
[rdp]: https://badgen.net/npm/dependents/request?label
|
||
[ndp]: https://badgen.net/npm/dependents/node-fetch?label
|
||
[adp]: https://badgen.net/npm/dependents/axios?label
|
||
[sdp]: https://badgen.net/npm/dependents/superagent?label
|
||
|
||
[g7]: https://www.npmjs.com/package/got?activeTab=dependents
|
||
[k7]: https://www.npmjs.com/package/ky?activeTab=dependents
|
||
[r7]: https://www.npmjs.com/package/request?activeTab=dependents
|
||
[n7]: https://www.npmjs.com/package/node-fetch?activeTab=dependents
|
||
[a7]: https://www.npmjs.com/package/axios?activeTab=dependents
|
||
[s7]: https://www.npmjs.com/package/visionmedia?activeTab=dependents
|
||
|
||
<!-- INSTALL SIZE -->
|
||
[gis]: https://badgen.net/packagephobia/install/got?label
|
||
[kis]: https://badgen.net/packagephobia/install/ky?label
|
||
[ris]: https://badgen.net/packagephobia/install/request?label
|
||
[nis]: https://badgen.net/packagephobia/install/node-fetch?label
|
||
[ais]: https://badgen.net/packagephobia/install/axios?label
|
||
[sis]: https://badgen.net/packagephobia/install/superagent?label
|
||
|
||
[g8]: https://packagephobia.now.sh/result?p=got
|
||
[k8]: https://packagephobia.now.sh/result?p=ky
|
||
[r8]: https://packagephobia.now.sh/result?p=request
|
||
[n8]: https://packagephobia.now.sh/result?p=node-fetch
|
||
[a8]: https://packagephobia.now.sh/result?p=axios
|
||
[s8]: https://packagephobia.now.sh/result?p=superagent
|
||
|
||
<!-- GITHUB STARS -->
|
||
[gs]: https://badgen.net/github/stars/sindresorhus/got?label
|
||
[ks]: https://badgen.net/github/stars/sindresorhus/ky?label
|
||
[rs]: https://badgen.net/github/stars/request/request?label
|
||
[ns]: https://badgen.net/github/stars/bitinn/node-fetch?label
|
||
[as]: https://badgen.net/github/stars/axios/axios?label
|
||
[ss]: https://badgen.net/github/stars/visionmedia/superagent?label
|
||
|
||
[g9]: https://github.com/sindresorhus/got
|
||
[k9]: https://github.com/sindresorhus/ky
|
||
[r9]: https://github.com/request/request
|
||
[n9]: https://github.com/node-fetch/node-fetch
|
||
[a9]: https://github.com/axios/axios
|
||
[s9]: https://github.com/visionmedia/superagent
|
||
|
||
<!-- TYPESCRIPT SUPPORT -->
|
||
[gts]: https://badgen.net/npm/types/got?label
|
||
[kts]: https://badgen.net/npm/types/ky?label
|
||
[rts]: https://badgen.net/npm/types/request?label
|
||
[nts]: https://badgen.net/npm/types/node-fetch?label
|
||
[ats]: https://badgen.net/npm/types/axios?label
|
||
[sts]: https://badgen.net/npm/types/superagent?label
|
||
|
||
[g10]: https://github.com/sindresorhus/got
|
||
[k10]: https://github.com/sindresorhus/ky
|
||
[r10]: https://github.com/request/request
|
||
[n10]: https://github.com/node-fetch/node-fetch
|
||
[a10]: https://github.com/axios/axios
|
||
[s10]: https://github.com/visionmedia/superagent
|
||
|
||
<!-- LAST COMMIT -->
|
||
[glc]: https://badgen.net/github/last-commit/sindresorhus/got?label
|
||
[klc]: https://badgen.net/github/last-commit/sindresorhus/ky?label
|
||
[rlc]: https://badgen.net/github/last-commit/request/request?label
|
||
[nlc]: https://badgen.net/github/last-commit/bitinn/node-fetch?label
|
||
[alc]: https://badgen.net/github/last-commit/axios/axios?label
|
||
[slc]: https://badgen.net/github/last-commit/visionmedia/superagent?label
|
||
|
||
[g11]: https://github.com/sindresorhus/got/commits
|
||
[k11]: https://github.com/sindresorhus/ky/commits
|
||
[r11]: https://github.com/request/request/commits
|
||
[n11]: https://github.com/node-fetch/node-fetch/commits
|
||
[a11]: https://github.com/axios/axios/commits
|
||
[s11]: https://github.com/visionmedia/superagent/commits
|
||
|
||
[Click here][InstallSizeOfTheDependencies] to see the install size of the Got dependencies.
|
||
|
||
[InstallSizeOfTheDependencies]: https://packagephobia.com/result?p=@sindresorhus/is@3.0.0,@szmarczak/http-timer@4.0.5,@types/cacheable-request@6.0.1,@types/responselike@1.0.0,cacheable-lookup@5.0.3,cacheable-request@7.0.1,decompress-response@6.0.0,http2-wrapper@1.0.0,lowercase-keys@2.0.0,p-cancelable@2.0.0,responselike@2.0.0
|
||
|
||
## Related
|
||
|
||
- [gh-got](https://github.com/sindresorhus/gh-got) - Got convenience wrapper to interact with the GitHub API
|
||
- [gl-got](https://github.com/singapore/gl-got) - Got convenience wrapper to interact with the GitLab API
|
||
- [travis-got](https://github.com/samverschueren/travis-got) - Got convenience wrapper to interact with the Travis API
|
||
- [graphql-got](https://github.com/kevva/graphql-got) - Got convenience wrapper to interact with GraphQL
|
||
- [GotQL](https://github.com/khaosdoctor/gotql) - Got convenience wrapper to interact with GraphQL using JSON-parsed queries instead of strings
|
||
- [got-fetch](https://github.com/alexghr/got-fetch) - Got with a `fetch` interface
|
||
|
||
## Maintainers
|
||
|
||
[](https://sindresorhus.com) | [](https://github.com/szmarczak) | [](https://github.com/Giotino)
|
||
---|---|---
|
||
[Sindre Sorhus](https://sindresorhus.com) | [Szymon Marczak](https://github.com/szmarczak) | [Giovanni Minotti](https://github.com/Giotino)
|
||
|
||
###### Former
|
||
|
||
- [Vsevolod Strukchinsky](https://github.com/floatdrop)
|
||
- [Alexander Tesfamichael](https://github.com/alextes)
|
||
- [Brandon Smith](https://github.com/brandon93s)
|
||
- [Luke Childs](https://github.com/lukechilds)
|
||
|
||
<a name="widely-used"></a>
|
||
## These amazing companies are using Got
|
||
|
||
<a href="https://segment.com"><img width="90" valign="middle" src="https://user-images.githubusercontent.com/697676/47693700-ddb62500-dbb7-11e8-8332-716a91010c2d.png"></a>
|
||
|
||
<a href="https://antora.org"><img width="100" valign="middle" src="https://user-images.githubusercontent.com/79351/47706840-d874cc80-dbef-11e8-87c6-5f0c60cbf5dc.png"></a>
|
||
|
||
<a href="https://getvoip.com"><img width="150" valign="middle" src="https://user-images.githubusercontent.com/10832620/47869404-429e9480-dddd-11e8-8a7a-ca43d7f06020.png"></a>
|
||
|
||
<a href="https://github.com/exoframejs/exoframe"><img width="150" valign="middle" src="https://user-images.githubusercontent.com/365944/47791460-11a95b80-dd1a-11e8-9070-e8f2a215e03a.png"></a>
|
||
|
||
<a href="http://karaokes.moe"><img width="140" valign="middle" src="https://camo.githubusercontent.com/6860e5fa4684c14d8e1aa65df0aba4e6808ea1a9/687474703a2f2f6b6172616f6b65732e6d6f652f6173736574732f696d616765732f696e6465782e706e67"></a>
|
||
|
||
<a href="https://github.com/renovatebot/renovate"><img width="150" valign="middle" src="https://camo.githubusercontent.com/206d470ac709b9a702a97b0c08d6f389a086793d/68747470733a2f2f72656e6f76617465626f742e636f6d2f696d616765732f6c6f676f2e737667"></a>
|
||
|
||
<a href="https://resist.bot"><img width="150" valign="middle" src="https://user-images.githubusercontent.com/3322287/51992724-28736180-2473-11e9-9764-599cfda4b012.png"></a>
|
||
|
||
<a href="https://www.naturalcycles.com"><img width="150" valign="middle" src="https://user-images.githubusercontent.com/170270/92244143-d0a8a200-eec2-11ea-9fc0-1c07f90b2113.png"></a>
|
||
|
||
<a href="https://microlink.io"><img width="150" valign="middle" src="https://user-images.githubusercontent.com/36894700/91992974-1cc5dc00-ed35-11ea-9d04-f58b42ce6a5e.png"></a>
|
||
|
||
<a href="https://radity.com"><img width="150" valign="middle" src="https://user-images.githubusercontent.com/29518613/91814036-97fb9500-ec44-11ea-8c6c-d198cc23ca29.png"></a>
|
||
|
||
<br>
|
||
|
||
> Segment is a happy user of Got! Got powers the main backend API that our app talks to. It's used by our in-house RPC client that we use to communicate with all microservices.
|
||
>
|
||
> — <a href="https://github.com/vadimdemedes">Vadim Demedes</a>
|
||
|
||
> Antora, a static site generator for creating documentation sites, uses Got to download the UI bundle. In Antora, the UI bundle (aka theme) is maintained as a separate project. That project exports the UI as a zip file we call the UI bundle. The main site generator downloads that UI from a URL using Got and streams it to vinyl-zip to extract the files. Those files go on to be used to create the HTML pages and supporting assets.
|
||
>
|
||
> — <a href="https://github.com/mojavelinux">Dan Allen</a>
|
||
|
||
> GetVoIP is happily using Got in production. One of the unique capabilities of Got is the ability to handle Unix sockets which enables us to build a full control interfaces for our docker stack.
|
||
>
|
||
> — <a href="https://github.com/danielkalen">Daniel Kalen</a>
|
||
|
||
> We're using Got inside of Exoframe to handle all the communication between CLI and server. Exoframe is a self-hosted tool that allows simple one-command deployments using Docker.
|
||
>
|
||
> — <a href="https://github.com/yamalight">Tim Ermilov</a>
|
||
|
||
> Karaoke Mugen uses Got to fetch content updates from its online server.
|
||
>
|
||
> — <a href="https://github.com/AxelTerizaki">Axel Terizaki</a>
|
||
|
||
> Renovate uses Got, gh-got and gl-got to send millions of queries per day to GitHub, GitLab, npmjs, PyPi, Packagist, Docker Hub, Terraform, CircleCI, and more.
|
||
>
|
||
> — <a href="https://github.com/rarkins">Rhys Arkins</a>
|
||
|
||
> Resistbot uses Got to communicate from the API frontend where all correspondence ingresses to the officials lookup database in back.
|
||
>
|
||
> — <a href="https://github.com/chris-erickson">Chris Erickson</a>
|
||
|
||
> Natural Cycles is using Got to communicate with all kinds of 3rd-party REST APIs (over 9000!).
|
||
>
|
||
> — <a href="https://github.com/kirillgroshkov">Kirill Groshkov</a>
|
||
|
||
> Microlink is a cloud browser as an API service that uses Got widely as the main HTTP client, serving ~22M requests a month, every time a network call needs to be performed.
|
||
>
|
||
> — <a href="https://github.com/Kikobeats">Kiko Beats</a>
|
||
|
||
> We’re using Got at Radity. Thanks for such an amazing work!
|
||
>
|
||
> — <a href="https://github.com/MirzayevFarid">Mirzayev Farid</a>
|
||
|
||
## For enterprise
|
||
|
||
Available as part of the Tidelift Subscription.
|
||
|
||
The maintainers of `got` and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-got?utm_source=npm-got&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
|