Releases · sindresorhus/got

We are pleased to announce Got v12.0.0 beta 1! 🎉
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 #1789.

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) 49c16ee
Remove automatic content-length on ReadStream (#1510) 472b8ef
Fix promise shortcuts in case of error status code (#1543) ff918fb 1107cc6
Invert the methodRewriting option 51d88a0
Fix url not being reused on retry in rare case (#1487) 462bc63
Fix hanging promise on HTTP/2 timeout (#1492) a59fac4
Prevent uncaught ParseErrors on initial successful response (#1527) 77df9c3
Throw an error when retrying with consumed body (#1507) 62305d7
Fix a Node.js 16 bug that hangs Got streams 06a2d3d
Fix default pagination handling for empty Link header (#1768) 1e1e506
Fix incorrect response.complete when using cache 9e15d88
Fix Cannot call end error when request returns a Writable 226cc39
Fix Request options not being reused on retry 3c23eea
Fix types being not compatible with CommonJS 3c23eea
Fix got.paginate does not call init hooks (#1574) 3c23eea
Generate a new object when passing options to the native https module (#1567) 3c23eea

Improvements

Make the context option mergeable (#1459) 2b8ed1f
Add generic argument to AfterResponseHook TypeScript type (#1589) 6fc04a9
Add read timeout (#1518) e943672 (blocked by nodejs/node#35923)
Improve the pagination API (#1644) 2675046
Change the stackAllItems option to be false by default (#1645) 1120370
Throw when afterResponse hook returns an invalid value 4f21eb3
Add retry.backoffLimit option 41c4136
Add noise retry option e830077
Enable more HTTPS options 83575d5 fe723a0 (thanks @Giotino)
Define error.code f27e8d3
Set options.url even if some options are invalid 8d6a680
Improve memory usage when merging options 2db5ec5
Support async generators as body 854430f 3df52f3
Add missing once types for Stream API 3c23eea
New error type: RetryError which always triggers a new retry when thrown 3c23eea
error.options is now enumerable 3c23eea
defaults.handlers don't need a default handler now 3c23eea
Add a parser for the Link header 3c23eea

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: fals...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

Contributors

Improvements

Fixes

Bug fixes

Docs

Tests

Releases: sindresorhus/got

v11.8.3

v12.0.0-beta.4

v12.0.0-beta.3

Bug fixes

v12.0.0-beta.2

Bug fixes

Improvements

Documentation

v12.0.0-beta.1

This package is now pure ESM

Required Node.js >=14

HTTP/2 support

Bug fixes

Improvements

Breaking changes

Improved option normalization

Contributors

v11.8.2

v11.8.1

v11.8.0

v11.7.0

Improvements

Fixes

v11.6.2

Bug fixes

Docs

Tests