v11.1.0

• Add pagination.stackAllItems option (#1214) c1208d1
• Allow response body to be typed for pagination API (#1212) c127f5b
• Fix some options not working with the pagination API 278c421

v11.0.3...v11.1.0

v11.0.3

Fixes

• Limit number of requests in pagination to prevent accidental overflows (#1181) 4344c3a
• Fix promise rejecting before retry b927e2d
• Fix options.searchParams duplicates 429db40
• Prevent calling .abort() on a destroyed request 63c1b72

Docs

• Fix incorrect usage in the readme examples (#1203) 16ff82f
• Note that cache and dnsCache can be false 7c5290d

v11.0.2...v11.0.3

v11.0.2

• Fix response.statusMessage being null 965bd03
• Update the http2-wrapper dependency to 1.0.0-beta.4.4 4e8de8e
• Use Merge as it's stricter than the intersection operator d3b972e
• Prevent silent rejections in rare cases 8501c69
• Do not alter options.body 835c70b

v11.0.1

Fixed two regressions:

• HTTPErrors have unspecified response body (#1162)
• Options are duplicated while merging (#1163)

Improved TypeScript types for errors inherited from RequestError

v11.0.0

Introducing Got 11! 🎉 The last major version was in December last year. ❄️ Since then, a huge amount of bugs has been fixed. There are also many new features, for example, HTTP2 support is finally live! 🌐

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

---

Breaking changes

Removed support for electron.net

Due to the inconsistencies between the Electron's net module and the Node.js http module, we have decided to officially drop support for it. Therefore, the useElectronNet option has been removed.

You'll still be able to use Got in the Electron main process and in the renderer process through the electron.remote module or if you use Node.js shims.

The Pagination API is now stable

We haven't seen any bugs yet, so please give it a try!
If you want to leave some feedback, you can do it here. Any suggestion is greatly appreciated!

 {
-    _pagination: {...}
+    pagination: {...}
 }

API

• The options.encoding behavior has been reverted back to the Got 9 behavior.
  In other words, the options is only meant for the Got promise API.
  To set the encoding for streams, simply call stream.setEncoding(encoding).

-got.stream('https://sindresorhus.com', {encoding: 'base64'});
+got.stream('https://sindresorhus.com').setEncoding('base64');

// Promises stay untouched
await got('https://sindresorhus.com', {encoding: 'base64'});

• The error name GotError has been renamed to RequestError for better readability and to comply with the documentation.

-const {GotError} = require('got');
+const {RequestError} = require('got');

• The agent option now accepts only an object with http, https and http2 properties.
  While the http and https properties accept native http(s).Agent instances, the http2 property must be an instance of http2wrapper.Agent or be undefined.

{
-    agent: new https.Agent({keepAlive: true})
}

{
+    agent: {
+        http: new http.Agent({keepAlive: true}),
+        https: new https.Agent({keepAlive: true}),
+        http2: new http2wrapper.Agent()
+    }
}

• The dnsCache option is now set to a default instance of CacheableLookup. It cannot be a Map-like instance anymore. The underlying cacheable-lookup package has received many improvements, for example, it has received hosts file support! Additionally, the cacheAdapter option has been renamed to cache. Note that it's no longer passed to Keyv, so you need to pass a Keyv instance it if you want to save the data for later.

{
-    dnsCache: new CacheableLookup({
-        cacheAdapter: new Map()
-    })
}

{
+    dnsCache: new CacheableLookup({
+        cache: new Keyv({
+            cacheAdapter: new Map()
+        })
+    })
}

// Default:

{
    dnsCache: new CacheableLookup()
}

• Errors thrown in init hooks will be converted to instances of RequestError. RequestErrors provide much more useful information, for example, you can access the Got options (through error.options), which is very useful when debugging.

const got = require('got');

(async () => {
    try {
        await got('https://sindresorhus.com', {
            hooks: {
                init: [
                    options => {
                        if (!options.context) {
                            throw new Error('You need to pass a `context` option');
                        }
                    }
                ]
            }
        });
    } catch (error) {
        console.log(`Request failed: ${error.message}`);
        console.log('Here are the options:', error.options);
    }
})();

• The options passed in an init hook may not have a url property. To modify the request URL you should use a beforeRequest hook instead.

{
    hooks: {
-        init: [
+        beforeRequest: [
            options => {
                options.url = 'https://sindresorhus.com';
            }
        ]
    }
}

Note that this example shows a simple use case. In more complicated algorithms, you need to split the init hook into another init hook and a beforeRequest hook.

• The error.request property is no longer a ClientRequest instance. Instead, it gives a Got stream, which provides a set of useful properties.

const got = require('got');

(async () => {
    try {
        await got('https://sindresorhus.com/notfound');
    } catch (error) {
        console.log(`Request failed: ${error.message}`);
        console.log('Download progress:', error.request.downloadProgress);
    }
})();

Renamed TypeScript types

Some of the TypeScript types have been renamed to improve the readability:

Old type	New type
ResponseObject	Response
Defaults	InstanceDefaults
DefaultOptions	Defaults
DefaultRetryOptions	RequiredRetryOptions
GotOptions	Options
GotRequestMethod	GotRequestFunction

Other

• Now requires Node.js 10.19 or later.

Enhancements

HTTP2 support is here! Excited? Yay! Unfortunately, it's off by default to make the migration smoother. Many Got users have set up their own Agents and we didn't want to break them. But fear no more, it will come enabled by default in Got 12.

const got = require('got');

(async () => {
    const response = await got('https://nghttp2.org/httpbin/anything', {http2: true});
    console.log(response.socket.alpnProtocol);
    //=> 'h2'
})();

1. The merge function is slow (#1016)
2. Use error.code instead of error.message to compare errors (#981)
3. Pass error thrown in the init hook to beforeError hook (#929)
4. Errors have undefined body when using streams (#1138)
5. Spaces should be normalized as + in query strings (#1113)
6. Modify response headers while using got.stream(...) (#1129)
7. Make error.request a Got stream (af0b147).

Known bugs

1. When some errors occur, the timings may indicate that the request was successful although it failed.
2. When some errors occur, the downloadProgress object may show incorrect data.

Bug fixes

1. Requests to UNIX sockets are missing query strings (#1036)
2. beforeRequest hooks aren't called on redirects (#994)
3. Errors are swallowed when using stream.pipeline(got.stream(...), ...) (#1026)
4. Cannot use the cache along with the body option (#1021)
5. Got doesn't throw on leading slashes (#1057)
6. Got throws when passing already frozen options (#1050)
7. Cannot type Got options properly due to missing types (#954)
8. got.mergeOptions(...) doesn't merge URLSearchParams instances (#1011)
9. The authorization header is leaking (#1090)
10. Pagination should ignore the resolveBodyOnly option (#1140)
11. Cannot reuse user-provided options (#1118)
12. Broken with Node.js ≥ 13.10.0 (#1107)
13. Cache is not decompressed (#1158)
14. beforeRetry hooks are missing options.context (#1141)
15. promise.json() doesn't throw ParseError (#1069)
16. Not compatible with tough-cookie@4.0.0 (#1131)
17. Shortcuts give body from the failed request on token renewal (#1120)
18. No effect when replacing the cache option in a Got instance (#1098)
19. Memory leak when using cache (#1128)
20. Got doesn't throw on aborted requests by the server (#1096)

All changes

v10.7.0...v11.0.0

v11.0.0-beta.1

$ npm install got@11.0.0-beta.1

The release notes will be improved in the final v11 release.

Changes in beta 1:

Breaking

API

• options.encoding will no longer affect streams (reverting back to the Got 9 behavior), use got.stream(…).setEncoding(encoding) instead (to prevent confusion).
• Renamed GotError to RequestError.
• options.agent can no longer be an instance of http.Agent. Instead you need to pass:

{
	http: new http.Agent(…),
	https: new https.Agent(…),
	http2: new http2wrapper.Agent(…)
}

• The deprecated useElectronNet option has been removed.
• dnsCache is now enabled by default.
• dnsCache no longer can be a Map or a Keyv instance, instead you need to pass a CacheableLookup instance.
• Errors thrown in init hooks will be converted to RequestErrors (why: RequestError provides much more useful information (e.g. Got options) than the usual TypeError etc.).
• options._pagination has been renamed to options.pagination.
• The options.url property will no longer be visible in init hooks (design limitation).
• The error.request property is no longer a ClientRequest instance. Instead, it gives a Got stream.

Types

• The ResponseObject type has been merged into the Response type.
• Renamed the Defaults type to InstanceDefaults.
• Renamed the DefaultOptions type to Defaults.
• Renamed the DefaultRetryOptions type to RequiredRetryOptions.
• Renamed the GotOptions type to Options.
• Renamed the GotRequestMethod type to GotRequestFunction.

Enhancements

1. Fixes #1016
2. Fixes #981
3. Fixes #932
4. Fixes #929
5. Fixes #1058
6. Fixes #167
7. Fixes #1138
8. Fixes #1113
9. Fixes #1129
10. Errors now have a request property (it's a Got stream).

Known bugs

1. The timings indicate that the request was successful (even though it errored).
2. The downloadProgress object may show incorrect data if the request has errored.

Bug fixes

1. Fixes #1036
2. Fixes #994
3. Fixes #1026
4. Fixes #1021
5. Fixes #1057
6. Fixes #1050
7. Fixes #954
8. Fixes #1011
9. Fixes #1090
10. Fixes #1140
11. Fixes #1118

v10.7.0...v11.0.0-beta.1

v10.7.0

• Fix got.paginate(…) TypeScript typings (#1099) 0b798ea
• Pass allItems and currentItems to _pagination.paginate() (#1100) 1cddd52
• Do not ignore decompress-response when bundling (#1105) 88f973f
• Avoid parsing JSON twice in _pagination.transform (#1102) cf4fdad

v10.6.0...v10.7.0

v10.6.0

• Add allowGetBody option to allow GET requests with payload (#1081) 526b4bb

v10.5.7...v10.6.0

v10.5.7

• Fix Init hooks not being called if extended acefaa4

v10.5.6

• Fix Init hook logic 64aeb40
• Update dependencies 32e609f