npm · #1225 most downloaded on npm

got

16.0.0171M downloads/mosindresorhus/got ↗New releases in your daily digest, changelog included.

Human-friendly and powerful HTTP request library for Node.js

Last release 1 months ago
30 Aug 2026
Release timing varies
gaps range from 8 days to 3 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
13 years old
201 releases · first in 2014

Release timeline

201 releases since 2014

2014201620182020

Releases

16.0.030 Aug 2026Deprecated
Remove the deprecated searchParameters , followRedirects , and auth option stubs 1d233ba
Breaking changes

Rewrite HTTP/2 support and drop the http2-wrapper dependency (#2464) 1e157c4

Got now has a built-in HTTP/2 client: ALPN negotiation, a pooled session cache with multiplexing, GOAWAY retirement, request and response trailers, informational (1xx) responses, abort signals, response caching, IPv6 authorities, and h2c through h2session.

agent.http2 is no longer an agent slot. It is only an opt-out flag now: pass false to skip session pooling. Passing an agent instance throws.

Response headers no longer contain HTTP/2 pseudo-headers. Use response.statusCode instead of response.headers[':status'].

A custom agent.https combined with http2: true makes Got use the native HTTP/1.1 path, because the built-in session pool does not support custom HTTPS agents.

HTTP/2 proxy support is gone. It came from http2-wrapper. It was very buggy anyway.

If options.request returns a request or response, it controls the transport and the HTTP/2 client is bypassed. Return undefined to fall back to Got's own transport.

Rewrite DNS cache and drop the cacheable-lookup dependency (#2463) bfc400b

dnsCache: true now uses Got's own cache. The option accepts any object with a lookup function and an optional clear(hostname?) function, so an existing CacheableLookup instance still works if you keep the dependency yourself.

The built-in cache resolves A and AAAA records separately, so it cannot preserve OS-specific verbatim address ordering from dns.lookup().

A beforeRequest hook, an afterResponse retry, or a pagination step that moves the request to a different origin now strips credentials and drops the body (#2465) dd3b295

authorization, cookie, cookie2, host, and proxy-authorization are removed, URL credentials are dropped, and an unchanged body is cleared. Set the headers or body explicitly inside the hook if you want them to cross the origin boundary.

This applies whether the origin changes through url or through prefixUrl.

copyPipedHeaders no longer copies credentials 1d233ba

authorization, cookie, cookie2, set-cookie, and set-cookie2 are now omitted along with host, the hop-by-hop headers, and anything nominated by Connection / Proxy-Connection. Pass credentials explicitly in headers when the upstream is trusted.

Remove the deprecated searchParameters, followRedirects, and auth option stubs 1d233ba

They only existed to throw a guidance message. Passing them now throws Unexpected option: ….

Remove the OptionsOfUnknownResponseBody type 1d233ba

It was a pure alias for StrictOptions.

Improvements

Add support for the QUERY HTTP method (#2466) e3924aa

Adds got.query() and got.stream.query(). QUERY is safe and idempotent, so it is retried by default and keeps a replayable body across 301 and 302 redirects as well as 307 and 308. It is not stored by the built-in cache, because correct QUERY caching needs cache keys that include the request content.

allowGetBody now also works over HTTP/2 1e157c4

timeout.socket now applies during HTTP/2 TLS negotiation and session setup c6bbb8a

It was previously folded into the connection setup timeout and reported as a request timeout. It now produces a real socket timeout and no longer counts DNS lookup time.

Two fewer dependencies: cacheable-lookup and http2-wrapper bfc400b 1e157c4

Fixes

Retry on connection errors reported by request.end() instead of failing the request (#2470) 67919b2

Retry immediately when the server answers with Retry-After: 0 instead of falling back to the backoff delay (#2471) d35ce87

Preserve the response body when a cookie jar write throws c6bbb8a

error.response.body is now complete, decompressed, and decoded with the configured encoding, and a decoding failure no longer masks the original error.

Wait for async cookie jar writes on terminal redirect responses, for example with followRedirect: false c6bbb8a

Only buffer the response body for cookie handling when the response actually sends set-cookie c6bbb8a

Fix got.stream finalizing the response before the response event and before piped server response headers are set c6bbb8a

Fix strictContentLength counting bytes from responses that were not actually decompressed c6bbb8a

Freeze hooks.beforeCache along with the other hook arrays on non-mutable defaults 1d233ba

Keep URL credentials when prefixUrl is changed to a same-origin value, and treat credentials in prefixUrl as explicit dd3b295

Migration guide

HTTP/2

Remove http2-wrapper from your code. Got's HTTP/2 client is built in.

Before:

import http2wrapper from 'http2-wrapper'; const {headers} = await got(url, { http2: true, request: http2wrapper.auto, agent: { http2: new http2wrapper.Agent() } }); console.log(headers[':status']);

After:

const {statusCode} = await got(url, {http2: true}); console.log(statusCode);

To opt out of HTTP/2 session pooling for a request, set agent.http2 to false.

If you need an HTTP/2 proxy, keep using http2-wrapper through the request option. Returning a request from request bypasses Got's HTTP/2 client.

h2c

The h2session hook example no longer needs request or http2.

Before:

import http2 from 'http2-wrapper'; got.extend({ hooks: { beforeRequest: [ options => { options.h2session = getSession(options.url); options.http2 = true; options.request = http2.request; } ] } });

After:

got.extend({ hooks: { beforeRequest: [ options => { options.h2session = getSession(options.url); } ] } });

dnsCache

dnsCache: true keeps working and now uses Got's built-in cache. If you depend on cacheable-lookup specific options, install it yourself and pass the instance:

import CacheableLookup from 'cacheable-lookup'; const dnsCache = new CacheableLookup({maxTtl: 60}); await got(url, {dnsCache});

Cross-origin hooks

If a beforeRequest hook, an afterResponse retry, or a pagination step sends the request to a different origin, set the headers and body you want to keep explicitly:

got.extend({ hooks: { beforeRequest: [ options => { options.url = new URL('https://other.example.com/path'); options.headers.authorization = 'Bearer …'; } ] } });

copyPipedHeaders

Credentials are no longer forwarded from a piped request. Pass them explicitly when the upstream is trusted:

got.stream(url, { copyPipedHeaders: true, headers: { authorization: request.headers.authorization } });

v15.1.0...v16.0.0

One column per quarter.

15.1.02 Jul 2026

Add allowAbsoluteUrls option ( #2462 ) 1c88e88

Add allowAbsoluteUrls option (#2462) 1c88e88

v15.0.7...v15.1.0

Open source →

15.0.728 Jun 2026

Fix: Preserve request body on cross-origin 307 and 308 redirects ( #2460 ) aee9249

Fix: Preserve request body on cross-origin 307 and 308 redirects (#2460) aee9249

v15.0.6...v15.0.7

Open source →

15.0.621 Jun 2026

Fix searchParams setter dropping the value when a URL is set ( #2454 ) 5772bf2

Fix searchParams setter dropping the value when a URL is set (#2454) 5772bf2

v15.0.5...v15.0.6

Open source →

15.0.56 May 2026

Fix: Handle abort signals added by handlers 74e3167

Fix: Handle abort signals added by handlers 74e3167

v15.0.4...v15.0.5

Open source →

15.0.46 May 2026

Fix aborting during download progress 11a2202

Fix aborting during download progress 11a2202

v15.0.3...v15.0.4

Open source →

15.0.321 Apr 2026

Fix false ReadError on responses without Content-Length 071ea07

Fix false ReadError on responses without Content-Length 071ea07

v15.0.2...v15.0.3

Open source →

15.0.213 Apr 2026

Fix stream cookie jar completion race b170125

Fix stream cookie jar completion race b170125

v15.0.1...v15.0.2

Open source →

15.0.18 Apr 2026

Fix init types 20633bc v15.0.0...v15.0.1

Fix init types 20633bc

v15.0.0...v15.0.1

Open source →

15.0.01 Apr 2026

Remove promise cancel API a06ac6c

Breaking changes

Require Node.js 22 b933476
Remove promise cancel API a06ac6c
- promise.cancel() is gone. Use the signal option with AbortController instead.
Remove isStream option c241c6c
- Use got.stream() directly.
Use native FormData global 670b228
- Use the Web API FormData global directly (available in Node.js 18+).
responseType: 'buffer' returns Uint8Array instead of Buffer 309e36d
- response.rawBody and promise.buffer() now return a Uint8Array. Buffer is a subclass of Uint8Array, so most code will continue to work, but strict type checks will need updating.
strictContentLength defaults to true 08e9dff
- Got now throws a ContentLengthMismatchError by default if Content-Length doesn't match the actual body size. Set {strictContentLength: false} to restore the old behavior.
retry.enforceRetryRules defaults to true 9bc8dfb
- Custom calculateDelay functions are now only called when a retry is actually allowed by limit, methods, statusCodes, and errorCodes. If your calculateDelay was previously used to override retry eligibility unconditionally, set {retry: {enforceRetryRules: false}}.
Piped header copying is now opt-in 8e392f3
- Got no longer automatically copies headers from a piped stream. Set {copyPipedHeaders: true} to re-enable. Hop-by-hop headers are never copied even when enabled (RFC 9110 §7.6.1).
url removed from public options objects 87de8d6
- The url property is no longer present on the options object passed to hooks. Use response.url or request.requestUrl instead.
300 and 304 responses are no longer auto-followed 5fccaab
- Per RFC 9110, 304 is a conditional-GET hint, not a redirect, and 300 is only a SHOULD for user agents. Got now returns these responses as-is. Handle them manually if needed.
Removed the undocumented named export for Got.
- Got has always been a default export. The named export was there only for buggy build tools during the ESM migration times.

Improvements

Stream decode large text/json bodies incrementally for lower peak memory usage c9a95b1
uploadProgress now emits granular per-chunk events for json and form request bodies 13c889d

Migration guide

Replace `promise.cancel()` with `AbortController`

Before:

const promise = got(url);
promise.cancel();

After:

const controller = new AbortController();
const promise = got(url, {signal: controller.signal});
controller.abort();

Replace `isStream: true` with `got.stream()`

Before:

got(url, {isStream: true});

After:

got.stream(url);

Replace `form-data` / `form-data-encoder` with native `FormData`

Before:

import {FormData} from 'formdata-node';
// or: import {FormData} from 'formdata-polyfill/esm.min.js';

const form = new FormData();
form.set('name', 'value');
await got.post(url, {body: form});

After:

const form = new FormData();
form.set('name', 'value');
await got.post(url, {body: form});

Update `Buffer` usage to `Uint8Array`

response.rawBody and promise.buffer() now return Uint8Array instead of Buffer.

Before:

const data = await got(url).buffer();
const copy = Buffer.from(data);

After:

const data = await got(url).buffer();
const copy = new Uint8Array(data);

If you need Buffer-specific APIs, wrap with Buffer.from(data.buffer, data.byteOffset, data.byteLength).

`strictContentLength` is now on by default

If you send requests where the Content-Length header might not match the actual body size, opt out:

got.extend({strictContentLength: false});

`retry.enforceRetryRules` is now on by default

If your calculateDelay function was overriding retry eligibility (e.g. retrying on methods or status codes outside the defaults), opt out:

got.extend({
	retry: {
		enforceRetryRules: false,
		calculateDelay: ({computedValue}) => {
			// computedValue is 0 when retry is not allowed
			if (computedValue === 0) {
				return 0;
			}

			return computedValue;
		},
	},
});

Piped header copying is now opt-in

If you pipe streams into Got and rely on automatic header forwarding (e.g. Content-Type), re-enable it:

got.extend({copyPipedHeaders: true});

300 and 304 responses are no longer followed

If your code depended on Got auto-following 300 Multi-Choice or handling 304 Not Modified as a redirect, you now need to handle them yourself in an afterResponse hook or check response.statusCode manually.

v14.6.6...v15.0.0

Open source →

14.6.630 Dec 2025

Fix stream auto-end for empty PATCH/DELETE/OPTIONS 4d5168c

Fix stream auto-end for empty PATCH/DELETE/OPTIONS 4d5168c
- The bug was introduced in b65b0e1, where it incorrectly auto-closed streams for empty PATCH/DELETE/OPTIONS when using streams. This broke the documented use case of piping data to a got stream for these methods.
- Docs:
  
  got.stream does not auto-end for OPTIONS, DELETE, or PATCH so you can pipe or write a body without getting write after end. Call stream.end() when you are not piping a body.

v14.6.5...v14.6.6

Open source →

14.6.522 Nov 2025

Fix TypeScript type inference for got.extend() with responseType option f7ab6e9

Fix TypeScript type inference for got.extend() with responseType option f7ab6e9

https://github.com/sindresorhus/got/compare/v14.6.4...v14.6.5

Open source →

14.6.414 Nov 2025

Fix dnsLookup option type to accept Node.js dns.lookup 47c3155

Fix dnsLookup option type to accept Node.js dns.lookup 47c3155

https://github.com/sindresorhus/got/compare/v14.6.3...v14.6.4

Open source →

14.6.37 Nov 2025

Fix socket reuse timing and DNS timing fb03d84 61d5e3b

Fix socket reuse timing and DNS timing fb03d84 61d5e3b

https://github.com/sindresorhus/got/compare/v14.6.2...v14.6.3

Open source →

14.6.22 Nov 2025

Fix path segments containing colons being misidentified as absolute URLs 0a16a9c

Fix path segments containing colons being misidentified as absolute URLs 0a16a9c

https://github.com/sindresorhus/got/compare/v14.6.1...v14.6.2

Open source →

14.6.125 Oct 2025

Fix the TS code not being built in 14.6.0.

Fix the TS code not being built in 14.6.0.

https://github.com/sindresorhus/got/compare/v14.6.0...v14.6.1

Open source →

14.6.016 Oct 2025

Add retryCount to beforeRequest hook context 91cdc48

Improvements

Add beforeCache hook 1c3a041
Add retryCount to beforeRequest hook context 91cdc48
Improve HTTPError message to include method and URL 6dd7574
Add support for typed arrays as request body ecf5633
Add Node.js diagnostic channel support 3e2a781
Allow custom Error classes in beforeError hook 1c71194
Add zstd (Zstandard) compression support 449833a
Improve validation error messages by including option names f5c54a3
Add strictContentLength option 4206f0e
Add support for https.secureOptions option 7ec1714
Add copyPipedHeaders option to control automatic header copying from piped streams d83dadd
Add stream.isReadonly property to detect read-only streams 030dfbb

Fixes

Fix HTTP/2 timings NaN issue 398c11a
Fix shortcut methods ignoring handler errors f004564
Fix body reassignment in beforeRetry hooks bf84d36
Fix beforeError hook not being called for ERR_UNSUPPORTED_PROTOCOL error fb86418
FIx preserving prefixUrl in hooks 9725fbd
Fix race condition causing retry after promise settles 1e49781
Fix stream validation errors causing unhandled rejections 2527bf6
Fix incorrect content-length when piping decompressed responses 30b3b79
Fix EPIPE errors bypassing retry logic in Promise API 6ae3e7f
Fix silent hang when returning cached response with FormData body from beforeRequest hook e09a9bd
Fix hook type definitions to reflect normalized runtime state 6a544a3
Fix afterResponse hook validation to allow null body values 60a4419
Fix DNS timing being non-zero when connecting to IP addresses 3d66aec
Fix timings.end being undefined when stream is destroyed before completion 4e75679
Fix properly treating different UNIX socket paths as different origins e5659d4

Breaking

Require Node.js 20 (#2313) a004263
- Why not target the oldest active Node.js LTS, which is Node.js 18? I usually strictly follow this convention in my packages. However, this package is the exception because the HTTP part of Node.js is consistently buggy, and I don't have time to work around issues in older Node.js releases. I you need to still support Node.js 18, I suggest staying on Got v13, which is quite stable. Node.js 18 will be out of active LTS in 5 months.

Improvements

Make followRedirect option accept a function (#2306) 7c3f147

https://github.com/sindresorhus/got/compare/v13.0.0...v14.0.0

Open source →

13.0.027 May 2023

As a reminder, Got continues to require ESM. For TypeScript users, this includes having `"module": "node16", "moduleResolution": "node16"` in your tsc

As a reminder, Got continues to require ESM. For TypeScript users, this includes having "module": "node16", "moduleResolution": "node16" in your tsconfig.

Breaking

Require Node.js 16 52a1063
Change the enableUnixSockets option to be false by default 852c312
- Most users don't need it.

Improvements

Allow specifying undefined for options (#2258) 1cefe8b

https://github.com/sindresorhus/got/compare/v12.6.1...v13.0.0

Open source →

12.6.127 May 2023

Fix get-stream import statement (#2266) 67d5039

Fix get-stream import statement (#2266) 67d5039

https://github.com/sindresorhus/got/compare/v12.6.0...v12.6.1

Open source →

12.6.03 Mar 2023

Update dependencies 88c88fb 979272e

Update dependencies 88c88fb 979272e
Loosen URL validation strictness (#2200) 0ca0b7f

https://github.com/sindresorhus/got/compare/v12.5.3...v12.6.0

Open source →

12.5.316 Nov 2022

Fix abort event listeners not always being cleaned up (#2162) 3cc40b5

Fix abort event listeners not always being cleaned up (#2162) 3cc40b5

https://github.com/sindresorhus/got/compare/v12.5.2...v12.5.3

Open source →

12.5.212 Oct 2022

Improve TypeScript 4.9 compatibility (#2163) 39f83b6

Improve TypeScript 4.9 compatibility (#2163) 39f83b6

https://github.com/sindresorhus/got/compare/v12.5.1...v12.5.2

Open source →

12.5.127 Sept 2022

Fix compatibility with TypeScript and ESM 3b3ea67

Fix compatibility with TypeScript and ESM 3b3ea67
Fix request body not being properly cached (#2150) 3e9d3af

https://github.com/sindresorhus/got/compare/v12.5.0...v12.5.1

Open source →

12.5.019 Sept 2022

Disable method rewriting on 307 and 308 status codes (#2145) e049e94

Disable method rewriting on 307 and 308 status codes (#2145) e049e94
Upgrade dependencies 8630815 f0ac0b3 4c3762a

https://github.com/sindresorhus/got/compare/v12.4.1...v12.5.0

Open source →

12.4.12 Sept 2022

Fix options.context being not extensible b671480715dbbff908e9a385f5e714570c663cd7

Fixes

Fix options.context being not extensible b671480715dbbff908e9a385f5e714570c663cd7
Don't emit uploadProgress after promise cancelation 693de217b030816f574d6e4cb505ee2e77b21c29

https://github.com/sindresorhus/got/compare/v12.4.0...v12.4.1

Open source →

12.4.02 Sept 2022

Support FormData without known length (#2120) 850773c

Improvements

Support FormData without known length (#2120) 850773c

Fixes

Don't call beforeError hooks with HTTPError if the throwHttpErrors option is false (#2104) 3927348

https://github.com/sindresorhus/got/compare/v12.3.1...v12.4.0

Open source →

12.3.16 Aug 2022

Don't freeze signal when freezing Options (#2100) 43b1467

Don't freeze signal when freezing Options (#2100) 43b1467

https://github.com/sindresorhus/got/compare/v12.3.0...v12.3.1

Open source →

12.3.028 Jul 2022

Add .off() method for events (#2092) 88056be

Add .off() method for events (#2092) 88056be

https://github.com/sindresorhus/got/compare/v12.2.0...v12.3.0

Open source →

12.2.024 Jul 2022

Support `AbortController` (#2020) 6a6d2a9

Support AbortController (#2020) 6a6d2a9
Add enableUnixSockets option (#2062) 461b3d4

https://github.com/sindresorhus/got/compare/v12.1.0...v12.2.0

Open source →

12.1.025 May 2022

Add response.ok (#2043) 22d58fb

Improvements

Add response.ok (#2043) 22d58fb
- This is only useful if you have {throwHttpErrors: false}

Fixes

Do not redirect to UNIX sockets (#2047) 861ccd9
- CVE-2022-33987
- Also back ported to v11

https://github.com/sindresorhus/got/compare/v12.0.4...v12.1.0

Open source →

12.0.424 Apr 2022

Remove stream lock - unreliable since Node 17.3.0 bb8eca924c338ca12d5b90d6a26aa28dbddb42ee

Remove stream lock - unreliable since Node 17.3.0 bb8eca924c338ca12d5b90d6a26aa28dbddb42ee

Open source →

12.0.326 Mar 2022

Allow more types in the json option (#2015) eb045bf

Allow more types in the json option (#2015) eb045bf

https://github.com/sindresorhus/got/compare/v12.0.2...v12.0.3

Open source →

12.0.216 Mar 2022

Fix encoding option with {responseType: 'json'} (#1996) 0703318

Fix encoding option with {responseType: 'json'} (#1996) 0703318

https://github.com/sindresorhus/got/compare/v12.0.1...v12.0.2

Open source →

12.0.19 Jan 2022

Fix nock compatibility (#1959) bf39d2c

Fix nock compatibility (#1959) bf39d2c
Fix missing export of Request TypeScript type (#1940) 0f9f2b8

https://github.com/sindresorhus/got/compare/v12.0.0...v12.0.1

Open source →

12.0.010 Dec 2021

Long time no see! The latest Got version (v11.8.2) was released just in February ❄️ We have been working hard on squashing bugs and improving overall

Introducing Got v12.0.0 :tada:

Long time no see! The latest Got version (v11.8.2) was released just in February ❄️ We have been working hard on squashing bugs and improving overall experience.

If you find Got useful, you might want to sponsor the Got maintainers.

This package is now pure ESM

Please read this. Also see https://github.com/sindresorhus/got/issues/1789.

Please don't open issues about [ERR_REQUIRE_ESM] and Must use import to load ES Module errors. This is a problem with your setup, not Got.
Please don't open issues about using Got with Jest. Jest does not fully support ESM.
Pretty much any problem with loading this package is a problem with your bundler, test framework, etc, not Got.
If you use TypeScript, you will want to stay on Got v11 until TypeScript 4.6 is out. Why.
If you use a bundler, make sure it supports ESM and that you have correctly configured it for ESM.
The Got issue tracker is not a support channel for your favorite build/bundler tool.

Required Node.js >=14

While working with streams, we encountered more Node.js bugs that needed workarounds. In order to keep our code clean, we had to drop Node.js v12 as the code would get more messy. We strongly recommend that you update Node.js to v14 LTS.

HTTP/2 support

Every Node.js release, the native http2 module gets more stable. Unfortunately there are still some issues on the Node.js side, so we decided to keep HTTP/2 disabled for now. We may enable it by default in Got v13. It is still possible to turn it on via the http2 option.

To run HTTP/2 requests, it is required to use Node.js v15.10 or above.

Bug fixes

Woah, we possibly couldn't make a release if we didn't fix some bugs!

Do not throw on custom stack traces (#1491) 49c16ee54fb19ea7aa77e24ac8c2b602f0aad265
Remove automatic content-length on ReadStream (#1510) 472b8ef9d9fc7713b740981a8b1103a7a9111b26
Fix promise shortcuts in case of error status code (#1543) ff918fb6dedb6d8b23421497ec890d43f45121b7 1107cc625e4cc469276483316c48896a21f6251a
Invert the methodRewriting option 51d88a0efed56760d116c5b911cea71e3265c787
Fix url not being reused on retry in rare case (#1487) 462bc630015064fa4ad4358cf28d24f95e1c958b
Fix hanging promise on HTTP/2 timeout (#1492) a59fac415ac013a48b1d514837628a5cf81d6878
Prevent uncaught ParseErrors on initial successful response (#1527) 77df9c33db5ba3126f54317171e1cfcfceefc3d5
Throw an error when retrying with consumed body (#1507) 62305d77d3428b5c714d21b4bbee68cc75b5f787
Fix a Node.js 16 bug that hangs Got streams 06a2d3d7d8d4fcc6898b6364d1a18ca1d407092b
Fix default pagination handling for empty Link header (#1768) 1e1e50647e93d038a4cc6a9bbbfbf61165d8fd39
Fix incorrect response.complete when using cache 9e15d887da3b065940bbc8ca38f9c748a0bbc75e
Fix Cannot call end error when request returns a Writable 226cc3995f6e16938163ebde24d8762e7dcd15e2
Fix Request options not being reused on retry 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Fix types being not compatible with CommonJS 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Fix got.paginate does not call init hooks (#1574) 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Generate a new object when passing options to the native https module (#1567) 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Remove stream reuse check (#1803) 9ecc5ee76f77aafd5100520d9d8789c491c8fb24
Fix merging searchParams (#1814) 1018c2029eea1f5b75b5120265996f1c0b3c12ae 732e9bd9406ba1c3dd64b445264e891f33fc0254
Fix unhandled exception when lookup returns invalid IP early (#1737) 2453e5e4213fe036a0108de3e4db414dcf2b4c30
Fix relative URLs when paginating 439fb82d2a07cece417a18c47e37cfdeaaf38db7
Require url to be an instance of URL when paginating (#1818) eda69ff924a621e499d31cbc590993a32ddb48d3
Fix username and password encoding in URL (#1169 #1317) d65d0caf627e8d1f5367db34d7d9b55d332c1efb
Clone raw options 1c4cefc9b49f891712c3758f853d8c6214a1c904
Fix invalid afterResponse return check cbc8902
Fix https.alpnProtocols not having an effect e1099fb

Improvements

Make the context option mergeable (#1459) 2b8ed1f5a185f30603d24e2ceb8181782de3bc5a
Add generic argument to AfterResponseHook TypeScript type (#1589) 6fc04a9b92f07b07b9fba010f2231a90082a039b
Add read timeout (#1518) e9436720fcb32b77d39d5477b420b18083e41c02 (blocked by https://github.com/nodejs/node/issues/35923)
Improve the pagination API (#1644) 2675046a83c7f03613f553a8da2912d491be900d
Change the stackAllItems option to be false by default (#1645) 1120370e05fd8d9e768677d8474d0c82cf91a6a6
Throw when afterResponse hook returns an invalid value 4f21eb3db705c90797ef8ee1503704f78fea3c1b
Add retry.backoffLimit option 41c4136632b9391adb3ac53332b312089bc4dc16
Add noise retry option e83007704670b5f567ca338c156441f6c569ecb5
Enable more HTTPS options 83575d590a119027d319bd9208681973087564a9 fe723a0477dc02785a0b477e3d5f85d0233e5b84 (thanks @Giotino)
Define error.code f27e8d331627074e76e4a9ec85a2c8d0a0625e5f
Set options.url even if some options are invalid 8d6a6807883323a83ea5f126ca56b55d9ce5f299
Improve memory usage when merging options 2db5ec5d366efbbf9e0838eabfa6be774a0518a0
Support async generators as body 854430f01350811fe8a0ccf20cd820aabfbd3926 3df52f38edbadb45158c37d499817bc5486989c6
Add missing once types for Stream API 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
New error type: RetryError which always triggers a new retry when thrown 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
error.options is now enumerable 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
defaults.handlers don't need a default handler now 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Add a parser for the Link header 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
General code improvements a5dd9aa37e7891b2620798560799c7f8bd380877

Breaking changes

Improved option normalization

Got exports an Option class that is specifically designed to parse and validate Got options. It is made of setters and getters that provide fast normalization and more consistent behavior.

When passing an option does not exist, Got will throw an error. In order to retrieve the options before the error, use error.options.

import got from 'got';

try {
    await got('https://httpbin.org/anything', {
        thisOptionDoesNotExist: true
    });
} catch (error) {
    console.error(error);
    console.error(error.options.url.href);
    // Unexpected option: thisOptionDoesNotExist
    // https://httpbin.org/anything
}

The init hook now accepts a second argument: self, which points to an Options instance.

In order to define your own options, you have to move them to options.context in an init hook or store them in options.context directly.

The init hooks are ran only when passing an options object explicitly.

- await got('https://example.com'); // this will *not* trigger the init hooks
+ await got('https://example.com', {}); // this *will** trigger init hooks

options.merge() replaced got.mergeOptions and Request.normalizeArguments

- got.defaults.options = got.mergeOptions(got.defaults.options, {…});
+ got.defaults.options.merge(…);

This fixes issues like #1450

Legacy Url instances are not supported anymore. You need to use WHATWG URL instead.

- await got(string, {port: 8443});
+ const url = new URL(string);
+ url.port = 8443;
+ await got(url);

No implicit timeout declaration.

- await got('https://example.com', {timeout: 5000})
+ await got('https://example.com', {timeout: {request: 5000})

No implicit retry declaration.

- await got('https://example.com', {retry: 5})
+ await got('https://example.com', {retry: {limit: 5})

dnsLookupIpVersion is now a number (4 or 6) or undefined

- await got('https://example.com', {dnsLookupIpVersion: 'ipv4'})
+ await got('https://example.com', {dnsLookupIpVersion: 4})

redirectUrls and requestUrl now give URL instances

- request.requestUrl
+ request.requestUrl.origin
+ request.requestUrl.href
+ request.requestUrl.toString()

- request.redirectUrls[0]
+ request.redirectUrls[0].origin
+ request.redirectUrls[0].href
+ request.redirectUrls[0].toString()

Renamed request.aborted to request.isAborted

- request.aborted
+ request.isAborted

Reason: consistency with options.isStream.

Renamed the lookup option to dnsLookup

- await got('https://example.com', {lookup: cacheable.lookup})
+ await got('https://example.com', {dnsLookup: cacheable.lookup})

The beforeRetry hook now accepts only two arguments: error and retryCount

await got('https://example.com', {
    hooks: {
        beforeRetry: [
-            (options, error, retryCount) => {
-                console.log(options, error, retryCount);
-            }
+            (error, retryCount) => {
+                console.log(error.options, error, retryCount);
+            }
        ]
    }
})

The options argument has been removed, however it's still accessible via error.options. All modifications on error.options will be reflected in the next requests (no behavior change, same as with Got 11).

The beforeRedirect hook's first argument (options) is now a cloned instance of the Request options.

This was done to make retrieving the original options possible: plainResponse.request.options.

await got('http://szmarczak.com', {
    hooks: {
        beforeRedirect: [
            (options, response) => {
-                console.log(options === response.request.options); //=> true [invalid! our original options were overriden]
+                console.log(options === response.request.options); //=> false [we can access the original options now]
            }
        ]
    }
})

The redirect event now takes two arguments in this order: updatedOptions and plainResponse.

- stream.on('redirect', (response, options) => …)
+ stream.on('redirect', (options, response) => …)

Reason: consistency with the beforeRedirect hook.

The socketPath option has been removed. Use the unix: protocol instead.

- got('/containers/json', {socketPath: '/var/run/docker.sock'})
+ got('unix:/var/run/docker.sock:/containers/json')
+ got('http://unix:/var/run/docker.sock:/containers/json')

The retryWithMergedOptions function in an afterResponse hook no longer returns a Promise.

It now throws RetryError, so this should this should be the last function being executed. This was done to allow beforeRetry hooks getting called.

You can no longer set options.agent to false. To do so, you need to define all the options.agent properties: http, https and http2.

await got('https://example.com', {
-    agent: false
+    agent: {
+        http: false,
+        https: false,
+        http2: false
+    }
})

When passing a url option when paginating, it now needs to be an absolute URL - the prefixUrl option is always reset from now on. The same when retrying in an afterResponse hook.

- return {url: '/location'};
+ return {url: new URL('/location', response.request.options.url)};

There was confusion around the prefixUrl option. It was counterintuitive if used with the Pagination API. For example, it worked fine if the server replied with a relative URL, but if it was an absolute URL then the prefixUrl would end up duplicated. In order to fix this, Got now requires an absolute URL - no prefixUrl will be applied.

got.extend(…) will throw when passing some options that don't accept undefined - undefined no longer retains the old value, as setting undefined explicitly may reset the option

Documentation

We have redesigned the documentation so it's easier to navigate and find exactly what you are looking for. We hope you like it :heart:

Open source →

12.0.0-beta.412 Aug 2021pre-release

Fix invalid afterResponse return check cbc8902

Fix invalid afterResponse return check cbc8902
Clarify retryWithMergedOptions valid hooks (#1832) 15c30ee
Add Apify to Showcase (#1828) 3386bf1
Add got-scraping to Got plugins in readme (#1823) 7805501
Fix https.alpnProtocols not having an effect e1099fb

Open source →

12.0.0-beta.36 Aug 2021pre-release

Clone raw options 1c4cefc9b49f891712c3758f853d8c6214a1c904

Bug fixes

Clone raw options 1c4cefc9b49f891712c3758f853d8c6214a1c904

Previously Got 12 was freezing the options instead of cloning, but it seems this is too breaking. Reverted option freezing so the behavior matches Got 11.

Open source →

12.0.0-beta.24 Aug 2021pre-release

v12.0.0-beta.2 introduces more stability fixes! Yay!

v12.0.0-beta.2 introduces more stability fixes! Yay!

Bug fixes

Remove stream reuse check (#1803) 9ecc5ee76f77aafd5100520d9d8789c491c8fb24
Fix merging searchParams (#1814) 1018c2029eea1f5b75b5120265996f1c0b3c12ae 732e9bd9406ba1c3dd64b445264e891f33fc0254
Fix unhandled exception when lookup returns invalid IP early (#1737) 2453e5e4213fe036a0108de3e4db414dcf2b4c30
Fix relative URLs when paginating 439fb82d2a07cece417a18c47e37cfdeaaf38db7
Require url to be an instance of URL when paginating (#1818) eda69ff924a621e499d31cbc590993a32ddb48d3
Fix username and password encoding in URL (#1169 #1317) d65d0caf627e8d1f5367db34d7d9b55d332c1efb

Improvements

General code improvements a5dd9aa37e7891b2620798560799c7f8bd380877

Documentation

Add an example of uppercase headers 3dc2ad9bf5d101b4b74c00e4ce9237c8218ce24d
Add docs for custom options (#1794) 6a44a8158a0f62ded055625f9aeec028abc880f3

Open source →

12.0.0-beta.122 Jul 2021pre-release

We are pleased to announce Got v12.0.0 beta 1! :tada: It's been a year and three months since Got 11 was released, and the latest Got version (v11.8.2

We are pleased to announce Got v12.0.0 beta 1! :tada: It's been a year and three months since Got 11 was released, and the latest Got version (v11.8.2) was released just in February ❄️ During that time, we have been working hard on squashing bugs and improving overall experience.

If you find Got useful, you might want to sponsor the Got maintainers.

This package is now pure ESM

Please read this. Also see https://github.com/sindresorhus/got/issues/1789.

Required Node.js >=14

HTTP/2 support

To run HTTP/2 requests, it is required to use Node.js v15.10 or above.

Bug fixes

Woah, we possibly couldn't make a release if we didn't fix some bugs!

Do not throw on custom stack traces (#1491) 49c16ee54fb19ea7aa77e24ac8c2b602f0aad265
Remove automatic content-length on ReadStream (#1510) 472b8ef9d9fc7713b740981a8b1103a7a9111b26
Fix promise shortcuts in case of error status code (#1543) ff918fb6dedb6d8b23421497ec890d43f45121b7 1107cc625e4cc469276483316c48896a21f6251a
Invert the methodRewriting option 51d88a0efed56760d116c5b911cea71e3265c787
Fix url not being reused on retry in rare case (#1487) 462bc630015064fa4ad4358cf28d24f95e1c958b
Fix hanging promise on HTTP/2 timeout (#1492) a59fac415ac013a48b1d514837628a5cf81d6878
Prevent uncaught ParseErrors on initial successful response (#1527) 77df9c33db5ba3126f54317171e1cfcfceefc3d5
Throw an error when retrying with consumed body (#1507) 62305d77d3428b5c714d21b4bbee68cc75b5f787
Fix a Node.js 16 bug that hangs Got streams 06a2d3d7d8d4fcc6898b6364d1a18ca1d407092b
Fix default pagination handling for empty Link header (#1768) 1e1e50647e93d038a4cc6a9bbbfbf61165d8fd39
Fix incorrect response.complete when using cache 9e15d887da3b065940bbc8ca38f9c748a0bbc75e
Fix Cannot call end error when request returns a Writable 226cc3995f6e16938163ebde24d8762e7dcd15e2
Fix Request options not being reused on retry 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Fix types being not compatible with CommonJS 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Fix got.paginate does not call init hooks (#1574) 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Generate a new object when passing options to the native https module (#1567) 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9

Improvements

Make the context option mergeable (#1459) 2b8ed1f5a185f30603d24e2ceb8181782de3bc5a
Add generic argument to AfterResponseHook TypeScript type (#1589) 6fc04a9b92f07b07b9fba010f2231a90082a039b
Add read timeout (#1518) e9436720fcb32b77d39d5477b420b18083e41c02 (blocked by https://github.com/nodejs/node/issues/35923)
Improve the pagination API (#1644) 2675046a83c7f03613f553a8da2912d491be900d
Change the stackAllItems option to be false by default (#1645) 1120370e05fd8d9e768677d8474d0c82cf91a6a6
Throw when afterResponse hook returns an invalid value 4f21eb3db705c90797ef8ee1503704f78fea3c1b
Add retry.backoffLimit option 41c4136632b9391adb3ac53332b312089bc4dc16
Add noise retry option e83007704670b5f567ca338c156441f6c569ecb5
Enable more HTTPS options 83575d590a119027d319bd9208681973087564a9 fe723a0477dc02785a0b477e3d5f85d0233e5b84 (thanks @Giotino)
Define error.code f27e8d331627074e76e4a9ec85a2c8d0a0625e5f
Set options.url even if some options are invalid 8d6a6807883323a83ea5f126ca56b55d9ce5f299
Improve memory usage when merging options 2db5ec5d366efbbf9e0838eabfa6be774a0518a0
Support async generators as body 854430f01350811fe8a0ccf20cd820aabfbd3926 3df52f38edbadb45158c37d499817bc5486989c6
Add missing once types for Stream API 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
New error type: RetryError which always triggers a new retry when thrown 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
error.options is now enumerable 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
defaults.handlers don't need a default handler now 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9
Add a parser for the Link header 3c23eea5a096f6f8ea0edf3e2a27e1caca88acf9

Breaking changes

Improved option normalization

Got exports an Option class that is specifically designed to parse and validate Got options. It is made of setters and getters that provide fast normalization and more consistent behavior.

When passing an option does not exist, Got will throw an error. In order to retrieve the options before the error, use error.options.

import got from 'got';

try {
    await got('https://httpbin.org/anything', {
        thisOptionDoesNotExist: true
    });
} catch (error) {
    console.error(error);
    console.error(error.options.url.href);
    // Unexpected option: thisOptionDoesNotExist
    // https://httpbin.org/anything
}

The init hook now accepts a second argument: self, which points to an Options instance.

In order to define your own options, you have to move them to options.context in an init hook or store them in options.context directly.

The init hooks are ran only when passing an options object explicitly.

- await got('https://example.com'); // this will *not* trigger the init hooks
+ await got('https://example.com', {}); // this *will** trigger init hooks

options.merge() replaced got.mergeOptions and Request.normalizeArguments

- got.defaults.options = got.mergeOptions(got.defaults.options, {…});
+ got.defaults.options.merge(…);

This fixes issues like #1450

Legacy Url instances are not supported anymore. You need to use WHATWG URL instead.

- await got(string, {port: 8443});
+ const url = new URL(string);
+ url.port = 8443;
+ await got(url);

No implicit timeout declaration.

- await got('https://example.com', {timeout: 5000})
+ await got('https://example.com', {timeout: {request: 5000})

No implicit retry declaration.

- await got('https://example.com', {retry: 5})
+ await got('https://example.com', {retry: {limit: 5})

dnsLookupIpVersion is now a number (4 or 6) or undefined

- await got('https://example.com', {dnsLookupIpVersion: 'ipv4'})
+ await got('https://example.com', {dnsLookupIpVersion: 4})

redirectUrls and requestUrl now give URL instances

- request.requestUrl
+ request.requestUrl.origin
+ request.requestUrl.href
+ request.requestUrl.toString()

- request.redirectUrls[0]
+ request.redirectUrls[0].origin
+ request.redirectUrls[0].href
+ request.redirectUrls[0].toString()

Renamed request.aborted to request.isAborted

- request.aborted
+ request.isAborted

Reason: consistency with options.isStream.

Renamed the lookup option to dnsLookup

- await got('https://example.com', {lookup: cacheable.lookup})
+ await got('https://example.com', {dnsLookup: cacheable.lookup})

The beforeRetry hook now accepts only two arguments: error and retryCount

await got('https://example.com', {
    hooks: {
        beforeRetry: [
-            (options, error, retryCount) => {
-                console.log(options, error, retryCount);
-            }
+            (error, retryCount) => {
+                console.log(error.options, error, retryCount);
+            }
        ]
    }
})

The beforeRedirect hook's first argument (options) is now a cloned instance of the Request options.

This was done to make retrieving the original options possible: plainResponse.request.options.

await got('http://szmarczak.com', {
    hooks: {
        beforeRedirect: [
            (options, response) => {
-                console.log(options === response.request.options); //=> true [invalid! our original options were overriden]
+                console.log(options === response.request.options); //=> false [we can access the original options now]
            }
        ]
    }
})

The redirect event now takes two arguments in this order: updatedOptions and plainResponse.

- stream.on('redirect', (response, options) => …)
+ stream.on('redirect', (options, response) => …)

Reason: consistency with the beforeRedirect hook.

The socketPath option has been removed. Use the unix: protocol instead.

- got('/containers/json', {socketPath: '/var/run/docker.sock'})
+ got('unix:/var/run/docker.sock:/containers/json')
+ got('http://unix:/var/run/docker.sock:/containers/json')

The retryWithMergedOptions function in an afterResponse hook no longer returns a Promise.

It now throws RetryError, so this should this should be the last function being executed. This was done to allow beforeRetry hooks getting called.

You can no longer set options.agent to false. To do so, you need to define all the options.agent properties: http, https and http2.

await got('https://example.com', {
-    agent: false
+    agent: {
+        http: false,
+        https: false,
+        http2: false
+    }
})

When passing a url option when paginating, it now needs to be an absolute URL - the prefixUrl option is always reset from now on. The same when retrying in an afterResponse hook.

- return {url: '/location'};
+ return {url: new URL('/location', response.request.options.url)};

got.extend(…) will throw when passing some options that don't accept undefined - undefined no longer retains the old value, as setting undefined explicitly may reset the option

Documentation

We have redesigned the documentation so it's easier to navigate and find exactly what you are looking for. We hope you like it :heart:

Note:

The TypeScript documentation hasn't been updated yet. It will be updated on a stable release.

Open source →

11.8.68 Dec 2022

Destroy request object after successful response

Destroy request object after successful response

https://github.com/sindresorhus/got/compare/v11.8.5...v11.8.6

Open source →

11.8.525 May 2022Security

Backport security fix https://github.com/sindresorhus/got/commit/861ccd9ac2237df762a9e2beed7edd88c60782dc

Backport security fix https://github.com/sindresorhus/got/commit/861ccd9ac2237df762a9e2beed7edd88c60782dc
- CVE-2022-33987

https://github.com/sindresorhus/got/compare/v11.8.4...v11.8.5

Open source →

11.8.318 Nov 2021

Bump cacheable-request dependency (#1921) 9463bb6

Bump cacheable-request dependency (#1921) 9463bb6
Fix HTTPError missing .code property (#1739) 0e167b8

https://github.com/sindresorhus/got/compare/v11.8.2...v11.8.3

Open source →

11.8.226 Feb 2021

Make the dnsCache option lazy (#1529) 3bd245f This slightly improves Got startup performance and fixes an issue with Jest.

Make the dnsCache option lazy (#1529) 3bd245f This slightly improves Got startup performance and fixes an issue with Jest.

https://github.com/sindresorhus/got/compare/v11.8.1...v11.8.2

Open source →

11.8.110 Dec 2020

Do not throw on custom stack traces (#1491) 4c815c3a609eb74d0eb139414d9996b4f65dc3c0

Do not throw on custom stack traces (#1491) 4c815c3a609eb74d0eb139414d9996b4f65dc3c0

Open source →

Your coding agent can read these notes before it upgrades. Set up the MCP server →

got

Release timeline

Releases

Breaking changes

Improvements

Fixes

Migration guide

HTTP/2

h2c

dnsCache

Cross-origin hooks

copyPipedHeaders

Breaking changes

Improvements

Migration guide

Replace promise.cancel() with AbortController

Replace isStream: true with got.stream()

Replace form-data / form-data-encoder with native FormData

Update Buffer usage to Uint8Array

strictContentLength is now on by default

retry.enforceRetryRules is now on by default

Piped header copying is now opt-in

300 and 304 responses are no longer followed

Improvements

Fixes

Meta

Breaking

Improvements

Breaking

Improvements

Fixes

Improvements

Fixes

Improvements

Fixes

Introducing Got v12.0.0 :tada:

This package is now pure ESM

Required Node.js >=14

HTTP/2 support

Bug fixes

Improvements

Breaking changes

Improved option normalization

Documentation

Bug fixes

Bug fixes

Improvements

Documentation

This package is now pure ESM

Required Node.js >=14

HTTP/2 support

Bug fixes

Improvements

Breaking changes

Improved option normalization

Documentation

`h2c`

`dnsCache`

`copyPipedHeaders`

Replace `promise.cancel()` with `AbortController`

Replace `isStream: true` with `got.stream()`

Replace `form-data` / `form-data-encoder` with native `FormData`

Update `Buffer` usage to `Uint8Array`

`strictContentLength` is now on by default

`retry.enforceRetryRules` is now on by default