got

Bug fixes

• Inherit the prefixUrl option from parent if it's undefined (#1448) a3da70a78aeb7f44dd3e0d0fa47cebe9541eb91e
• Prepare a fix for hanging promise on Node.js 14.10.x 29d4e325b110ccf7571d4265d40760be4175f7ff
• Prepare for Node.js 15.0.0 c126ff19c4e893975cbf6c2c8bebce6ed7631276

Docs

• Point travis-ci.org badge to travis-ci.com (#1442) 2b352d3f9e216e116efc0249a3a78b8d4492f97c
• Clarify the retry mechanism f2486180207dba30624901761a457694096441c1
• Fix RequestError links 3ed4af605ca6493c080cc8003a55c3b37988efee

Tests

• Downgrade Travis CI Node.js version to 14.9.0 (#1454) 27470b53e1bcd6f435fc77006c9e3e864961dbec

Fixes

• Fix options.port on redirect (#1439) 408e22a

Meta

• Welcome @Giotino as a maintainer 🎉 5031843
• Showcase companies using Got (#1432) d12d6af

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

Improvements

• Add retry stream event (#1384) 707219825b2f8ff3df597230a53244636df21642
• Add types for http-cache-semantics options 2e2295fba63c260d347fef2081cdbcae45fa6116
• Make CancelError inherit RequestError 1f132e88b4e9b295631637757d64307032a4e56e
• Add retryAfter to RetryObject 643a305b4d710042d2a958a21e7637183713505c
• Add documentation comments to exported TypeScript types (#1278) eaf1e02b21e4b8c08197c6400844d4098828ecf4
• Move cache options into a cacheOptions property 9c16d9083019fcb28f566659106036faa4839447

Bug fixes

• Got promise shouldn't retry when the body is a stream 6e1aeaedb5dfe4f4b15eecf72a80303c30df22af

Docs

• Add an example of nock integration with retrying f7bbc3753779e14b22d7aa337764c7048aebb915
• Fix CancelError docs 28c400f4df5f45990f80641a794a2d09439bef93
• Fix retry delay function in the README (#1425) 38bbb04ea24f01eed6f01e394bc3e9405df8cfc5

Docs

• Add hpagent to proxy section (#1363) a3e171c4d43c8bbb236ef3a04feb25ba6fdf6c49
• Mention header lowercasing inrequest migration guide (#1387) a748343363ecb0347897264fb49df4a8f4793997
• Fixed deprecationWarning on https options (#1391) 9a309bdbe7e2552c5bffbea253d58c39d6e6c3e3

Bug fixes

• Fix duplicated hooks when paginating e02845f1aa737d55dce23381d0f4f2a61b1eb5e1
• Fix dnsCache: true having no effect 043c9501b85172e09819d44ac8eb49c574b27bda

Enhancements

• Upgrade http2-wrapper to 1.0.0-beta.5.0 16e7f031bb371571e1948091b88385be3485d83f
• Compatibility fix to ignore incorrect Node.js 12 typings f7a1379e417641613bf1b654e37f37a7e6447e0c 61d6f610ffa6b760d466ff910a8e959778ee36e0

Bug fixes

• Prevent uncaught errors on HTTP errors 2d96679c0a007be657835e83c6afb20b4510e9c5 1ef053d2af7f9b050ce0a3d1884f45b285f2e775

Docs

• Mention HTTP/2 proxying in readme.md 4ebd26a4b8eef704fe216d333e2614b39dedf695
• Update the comparison table bd2d53269882e48af88ff736a2e82aecd9e1fbee c83393933c2b308a312ed4dc85d852c79445e400
• Document the hierarchy of error classes (#1359) 559526ee273fb60d152759d288bc76971abb99e2
• Fix example code for HTTPS proxy (#1360) 408334756ace0570ca4a0aded5a8aeac437eac33

Improvements

• Add backoff option to pagination (#1182) 4be7446
• Upgrade dependencies (#1345) b9a855d 476c026 8d697bc
• Upgrade to TypeScript 3.9 (#1267) b51d836

Fixes

• Fix TypeScript types for Promise API (#1344) 676be6d
• Fix cache not working with HTTP2 ac5f67d
• Fix response event not being emitted on cache verify request (#1305) da4769e
• Work around a bug in Node.js <=12.18.2 f33e8bc
• Remove request error handler after response is downloaded e1afe82
• Revert "Remove request error handler after response is downloaded" aeb2e07

Docs

• Mention advanced usage of a beforeRequest hook 779062a
• Mention to end the stream if there's no body 044767e

https://github.com/sindresorhus/got/compare/v11.4.0...v11.5.0

• Fix hanging promise on timeout on HTTP error 934211f951bfd56751e90ec4eabe6379d8541a05
• Use async iterators to get response body (#1256) 7dcd1456a68a2603d30cbb1a4e453c4560bd51b2
• Fix promise not returning Buffer on compressed response 5028c11abd21c9d13bb3b12abb02961ec0465a8a
• Clarify options.encoding docs 04f3ea4b7995e1609555dd13f00641b8f470de4c
• Fix unhandled The server aborted pending request rejection 728aef989c1a6650d2b42a7f69b603075b5d35bf
• Add missing ECONNRESET code to an abort error d325d353a28e6038140aa5b18f2b6f9f796f10b6
• Fix prefixUrl not working when the url argument is empty 8d3412abb8aae3cefc75dd6f9e698988ed463dd6
• Improve the searchParams option 4dbada94e261ad890d2478c313ec3d74761b659e
• Fix non-enumerable options [such as body] not being used 8f775c71c41a377186c6b38c6789542bfd523039

• Deep merge https options (#1304) c98f0d7
• Add options to customize parsing/stringifying JSON (#1298) cb4da8d
• Add dnsLookupIpVersion option (#1264) 7f643bb

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

• Provide an overload for unknown responseType (#1276) b9ba18a
• Fix overriding some options in a beforeRequest hook (#1293) d8c00cf
• Fix hanging promise on aborted requests on Node v14.3.0 (#1296) 2ccc4c2
• Do not wait for ready event if the file descriptor is already opened (#1289) 2c8fe19
• General improvements to HTTPS API (#1255) 697de37

https://github.com/sindresorhus/got/compare/v11.1.4...v11.2.0

• Clarify docs for got.HTTPError (#1244) 3f125f105e3b328942c04ef73579b1573fc39b5a
• Upgrade cacheable-lookup to 5.0.3 9770e540d088c35ec0b467fa3d2fafb60ed6797d
• Add a Runkit example (#1253) 48bbb369d715b8ec3c36e0af1ec88f47e2299172
• Mention options.rejectUnauthorized in the documentation 9b049635570ebbdd9d534ad1860f01d34771a5ee
• Test responseType set to undefined 0e8582f24e6903d9079a7d92e9b4d831cb5b5f17
• Slightly improve RunKit example 6f8405102517a1e61393ee7bdb5a4fcff08e64c5
• Make got.paginate() an alias for got.paginate.each() 5480b3134cfd35497f618f08f574927c2bd7624b
• Don't force query string normalization (#1246) 761b8e01f7d194dd3b9aa6578c26966ebae6172c
• Upgrade decompress-response to 6.0.0 c2bc014abc8818ad93dd69a0e8cc9d36d0dccb9c
• Migrate from lolex to @sinonjs/fake-timers (#1270) df333ddbc163e35537a9f49818e722c7aa6803c0
• Make calculateDelay promisable (#1266) 3745efc9d9d03c78c898f357a34524524cce514d

• Do not use deprecated request.abort() (#1242) ab338a70dd9547a6c48af18ab5e2306639e5cbad
• Remove the host header on redirect (#1241) 8ff71d972ae55700887b45d50a265e3659ac8cce
• Prevent URL pollution (#1243) 7dbb9ee2bd58e8ee67ebfe734e0c62e765759593
• Fix duplicated searchParams for pagination API (#1229) 91aa0ac9e676130cd4cfc1183d16208c6167b31d
• Add a test for stringified searchParams in merge (#1208) 7d7361cc3845421f24288fc39464a8b38bd75d56
• Fix reusing options when paginating 88622701c70434ddc1040c46ad16de0c0acd9143
• Fix an invalid pagination test 47c1afedc77b27a2eb3edd85064d8532da835045 5131dc2778a9b584acda062635a9458d5b22df0c

Bug fixes

• Disable options.dnsCache by default 79507c2cdec137e65d715f36d13a5a0e577ddc01

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.

Enhancements

• Add test cases for issues #1221 and #1223 (#1231) 822bfa770306737a3ad06196101975b669b5d738
• Update dependencies 05ff8780768d48fb58c782ba0b9c141af44a7c15

• Improve Node.js 14 compatibility 50ef99a
• Fix got.mergeOptions() regression 157e02b
• Fix hanging promise when using cache 7b19e8f
• Make options.responseType optional when using a template 9ed0a39

https://github.com/sindresorhus/got/compare/v11.1.0...v11.1.1

• 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

https://github.com/sindresorhus/got/compare/v11.0.3...v11.1.0

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

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

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

Fixed two regressions:

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

Improved TypeScript types for errors inherited from RequestError

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

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:

<table> <tr> <td>Old type</td> <td>New type</td> </tr> <tr> <td><code>ResponseObject</code></td> <td><code>Response</code></td> </tr> <tr> <td><code>Defaults</code></td> <td><code>InstanceDefaults</code></td> </tr> <tr> <td><code>DefaultOptions</code></td> <td><code>Defaults</code></td> </tr> <tr> <td><code>DefaultRetryOptions</code></td> <td><code>RequiredRetryOptions</code></td> </tr> <tr> <td><code>GotOptions</code></td> <td><code>Options</code></td> </tr> <tr> <td><code>GotRequestMethod</code></td> <td><code>GotRequestFunction</code></td> </tr> </table>

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 (af0b1472abf48a6c5491dcb36a1d8863c5227fb3).

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

https://github.com/sindresorhus/got/compare/v10.7.0...v11.0.0

$ 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

https://github.com/sindresorhus/got/compare/v10.7.0...v11.0.0-beta.1

• 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

https://github.com/sindresorhus/got/compare/v10.6.0...v10.7.0

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

https://github.com/sindresorhus/got/compare/v10.5.7...v10.6.0

• Fix Init hooks not being called if extended acefaa4c2a0cb3c33b3f952be29ac0a9cb316e87

• Fix Init hook logic 64aeb40d824008db48c956a3e03807383be62090
• Update dependencies 32e609f3bb4c4021cf8b98886efa9bc23e99cc9d

• Fix merging pagination options 1f363b976cd23626462314c7cd5670cddd951c73

• Fix _pagination not falling back to defaults ff1dba1e0c6f190da55d2799ebaa7a167f49ae9a

• Fix unhandled errors if throwing in an async handler 518d95aba5fde83d6708ee1289561fa445870436

• Forgot to include required p-event dependency 8373112

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

• Wait until body file descriptor is open (#1054) 453a3a3

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

• Add experimental pagination feature (#833) 761c7c6 We're looking for feedback on how it works.

https://github.com/sindresorhus/got/compare/v10.4.0...v10.5.0

• Update @szmarczak/cacheable-lookup dependency d527dae
• Include invalid JSON body in ParseErrors (#1044) 2813b73
• Fix got.stream(...) not throwing ReadErrors 1f6ca6b

https://github.com/sindresorhus/got/compare/v10.3.0...v10.4.0

• Allow request body to be sent with a DELETE request (#1037) 17d629a
• Reject normalization errors with CancelableRequest (#1035) fddecab
• Export GotRequestMethod TypeScript type (#1017) f02694e
• Export ReadError TypeScript type (#1027) d222164

https://github.com/sindresorhus/got/compare/v10.2.2...v10.3.0

• Do not include a request option in normalized http options 61009b3

• Ensure got.mergeOptions(...) can be assigned to defaults (#1008) 1360a1b
• The url option is mutually exclusive with the url input argument e0f8aab
• Update RetryObject['error'] TypeScript types 5008bf7
• Upgrade @szmarczak/http-timer dependency a1b8ffc

https://github.com/sindresorhus/got/compare/v10.2.0...v10.2.1

• Soft-deprecate electron.net support (#995) b2f8ace
  • See https://github.com/sindresorhus/got/issues/899#issuecomment-565728281. When the support is 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.
• Do not throw if hostname is not present dc53747
• Fix unhandled Premature close errors fa60b5f

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

Enhancements

• Retry after certain Cloudflare errors (#991) 0569d45

Fixes

• Fix content-length header not being set when using custom content-type 3149340
• Emit timeout errors as soon as possible 912c2e5 7bf92f4

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

• Fix type conflicts for URL and URLSearchParams types (#983) cd4226d Just working around yet another TypeScript bug: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/34960

https://github.com/sindresorhus/got/compare/v10.0.3...v10.0.4

• Fix the responseType option (071bf5ed39a1262b1bf806067752395421090a23)
• Fix unhandled Premature close and Request timed out errors (7b2ccb0d69fca9aba27373ab344f97d389d692f2)
• Make options.path backwards-compatible (b3f1ac9c9725459f4ffab9baa20b9459d3495fba)

• Fix TypeScript type problem with URL and URLSearchParams globals (#969) 2d5e28d
• Fix got.mergeOptions(...) TypeScript type (#953) b962d08
• Fix unhandled timeout errors when connection drops 5a8f461

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

• Fix using the json option with got.stream.post 2ec5c4d

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

We're excited to announce Got 10! 🎉 This release has been in the works for almost a year and has been a major undertaking. Got was fully rewritten in TypeScript, which helped us catch many bugs and will give us more confidence in the codebase going forward. Got is now faster and much more stable. We also fixed a huge amount of bugs. Big thanks to everyone that helped make this release possible. 🙌

---

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

Note: Some HTTP agents like https-proxy-agent and agentkeepalive are not compatible with Node.js 10 and hence not compatible with Got as Got takes advantage of some Node.js 10-only APIs.

Breaking

• Require Node.js 10 633651f
  • Why: This is so that we can use stream.pipeline for more reliable stream handling. Node.js 8 will be out of LTS at the end of this month anyway.
• Remove support for protocol-less URLs in the url argument 92bc808
  • Why: To reduce ambiguity. It was not clear from just reading the code what it would default to.
  • Migrate:

- got('sindresorhus.com');
+ got('https://sindresorhus.com');

• Rename the query option to searchParams and make it stricter b223663 5376216 518f0f5906e1fcd38691555b17fb91db643f3d47
  • Why: To get closer to the window.fetch naming in the browser.
  • Migrate:

- got(…, {query: …});
+ got(…, {searchParams: …});

• Replace the baseUrl option with prefixUrl (#829) 0d534ed
  • Note: We also made it stricter to reduce ambiguity. The Got url argument now cannot be prefixed with a slash when this option is used.
  • Why: We renamed it to make it clear that it doesn't do any URL resolution.
  • Migrate:

- got('/foo', {baseUrl: 'https://x.com'});
+ got('foo', {prefixUrl: 'https://x.com'});

• Change the json option to accept an object instead of a boolean and to only be responsible for the request, not the response (#704) a6a7d5a
  • Note: You now set the request body in this option instead of the body option when you want to send JSON. This option also no longer sets the response type to JSON. You either call the .json() method or specify the responseType option for that.
  • Why: Many people were confused how {json: true} worked and they also complained that they could not set the request/response type individually.
  • Migrate:

- got(url, {body: {x: true}, json: true});
+ got.post(url, {json: {x: true}}).json();

• Use the responseType option instead of encoding to get a Buffer (#940) 6cc3d9f
  • Why: Previously, you would pass {encoding: null} to get a Buffer, but this was confusing. You now use {responseType: 'buffer'} instead.
  • Tip: You can also use got(…).buffer();.
  • Migrate:

- got(…, {encoding: null});
+ got(…, {responseType: 'buffer'});

• Don't infer POST automatically when specifying body (#756) e367bdb
  • Why: We're trying to reduce the amount of magic behavior.
  • Migrate:

- got(…, {body: 'foo'});
+ got.post(…, {body: 'foo'});

• The retries.retry option was split into retries.limit and retries.calculateDelay b15ce1d
  • Migrate:

 got(…, {
 	retry: {
-		retries: 2
+		limit: 2
 	}
 });

 got(…, {
 	retry: {
-		retries: iteration => iteration < 2
+		calculateDelay: ({attemptCount}) => attemptCount < 2
 	}
 });

• Use undefined instead of null to omit a header (https://github.com/sindresorhus/got#headers) 518f0f5906e1fcd38691555b17fb91db643f3d47
  • Why: We're trying to reduce the use of null.
  • Migrate:

 got(…, {
 	headers: {
-		'user-agent': null
+		'user-agent': undefined
 	}
 });

• Rename the Promise API property .fromCache to .isFromCache (#768) b5e443b
• Rename the stream option to isStream 518f0f5906e1fcd38691555b17fb91db643f3d47
  • Why: To make it clearer that it's a boolean and that it doesn't expect a stream to be passed in.
  • Migrate:

- got(…, {stream: true});
+ got(…, {isStream: true});

• Don't include the Got version in the default user-agent header (#911) 95bed1e
  • got/9.6.0 (https://github.com/sindresorhus/got) → got (https://github.com/sindresorhus/got)
  • Why: Importing package.json to get the version caused a lot of problems. And you should ideally set your own user-agent header anyway.
• Remove got.create() 518f0f5906e1fcd38691555b17fb91db643f3d47
  • You can achieve the same thing with got.extend() now.
• Remove got.mergeInstances() 518f0f5906e1fcd38691555b17fb91db643f3d47
  • Use gotInstance.extend(...gotInstances) instead.
• Move top-level error properties into an .options and .response property (#773) 6eaa81b
  • Migrate:

- error.gotOptions
+ error.options

- error.headers
+ error.response.headers

- error.statusCode
+ error.response.statusCode

- error.statusMessage
+ error.response.statusMessage

- error.body
+ error.response.body

- error.redirectUrls
+ error.response.redirectUrls

- error.host
+ error.options.host

- error.hostname
+ error.options.hostname

- error.method
+ error.options.method

- error.protocol
+ error.options.protocol

- error.url
+ error.options.url

- error.path
+ error.options.path

• Custom instance creation was simplified (#707) 8eaef94
  • Note: got.mergeInstances(...instances) is deprecated. Use instanceA.extend(instanceB) instead.
  • Migrate:

# Merging instances
- got.mergeInstances(instanceA, instanceB, instanceC, …);
+ instanceA.extend(instanceB, instanceC, …);

# Merging options
- instanceA.extend(optionsB).extend(optionsC).extend(…);
+ instanceA.extend(optionsB, optionsC, …);

# Merging instances and options
- got.mergeInstances(instanceA.extend(optionsB), instanceC);
+ instanceA.extend(optionsB, instanceC, …);

# Extending handlers
- got.mergeInstances(instanceA, got.create({handler: handlerB}));
+ instanceA.extend({handlers: [handlerB]});

Enhancements

• Got has been rewritten in TypeScript.
  • Why: This means we can provide our own type definitions and we can be more confident when working on the Got codebase and produce less bugs. Huge thanks to @pmmmwh, @LinusU, @vladfrangu, @mastermatt, and everyone else that helped us with this rewrite. 🙌
• Add support for Brotli (Node.js 12 and later) (#706) d5d2e6f
• Add opt-in DNS cache (#731) cd12351
• Add context option for storing custom metadata across request and hooks (#777) 3bb5aa7
• Add option to ignore invalid cookies (#826) e9c01e0
• Add maxRedirects option (#914) 0c505b0
• Allow method rewriting on redirects (#913) b7ead5f
• Add methodRewriting option (#942) b82358f
• Add ability to use something other than tough-cookie for handling cookies (#882) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Preserve stack trace when wrapping errors (#935) 8874a45
• Proxy headers from server request to Got (#772) 00e5fd5
• Pass the response as the second argument to the beforeRedirect hook (#812) 3557896
• Throw on canceled request with incomplete response (#767) 92b1005
• Add .isFromCache property to the stream API (#768) b5e443b
• The timeout option can now be modified in hooks d520a3a
• The prefixUrl option can now be modified in hooks (https://github.com/sindresorhus/got/issues/867) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Make URLSearchParams instances mergeable (#734) 95c7c2c

Fixes

• Fix parsing response when using afterResponse hook (#775) e2054cd
• Fix port not being reset on redirect (#729) ada5861
• Fix the retry functionality (#787) 0501e00
• Fix default retry option value when specifying a number (#809) 9c04a7c
• Correctly handle promise- and stream-specific errors in the beforeError hook 134c9b7
• Don't throw on early lookups 4faf5c7
• Fix Node.js 13 compatibility (#915) b0dfc95
• Fix memory leak when using cache feature (#792) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Don't throw on 204 No Content when parsing response (#925) 518f0f5906e1fcd38691555b17fb91db643f3d47
• When redirect fails, don't retry from scratch (#930) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Retrying inside afterResponse hook should trigger beforeRetry hook (#918) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Fix a bug that sometimes caused the Node.js process to hang 518f0f5906e1fcd38691555b17fb91db643f3d47
• Fix a bug where cookies weren't reset on redirect between two different sites 518f0f5906e1fcd38691555b17fb91db643f3d47
• Make the progress events not be based on internal Node.js properties cd11a50

Docs

• Clarify retry behavior 5e6782a
• Clarify prefixUrl behavior (#943) f008bc9
• Document that retry option doesn't work with streams 9088866
• Encourage using Stream.pipeline() when using the stream API 06afb27
• Add instructions for global-agent (#822) ca8c560
• Mention the TimeoutError.timings property 8fa18f4
• Mention how to abort the request using hooks 96ea75f

All commits

https://github.com/sindresorhus/got/compare/v9.6.0...v10.0.0

While this is an beta release, the code is well-tested and fairly stable. We encourage you to test it out and report any issues.

$ npm install got@10.0.0-beta.2

Make sure you also read the alpha.1, alpha.2, alpha.3, and beta.1 release notes.

Changes in beta 2:

Breaking

• Use the responseType option instead of encoding to get a Buffer (#940) 6cc3d9f Previously, you would pass {encoding: null} to get a Buffer, but this was confusing. You now use {responseType: 'buffer'} instead.

Enhancements

• Preserve stack trace when wrapping errors (#935) 8874a45
• Make TypeScript types conforms to strict mode (#928) c537dee

Fixes

• Make the progress events not be based on internal Node.js properties cd11a50

https://github.com/sindresorhus/got/compare/v10.0.0-beta.1...v10.0.0-beta.2

While this is an beta release, the code is well-tested and fairly stable. We encourage you to test it out and report any issues.

$ npm install got@10.0.0-beta.1

Make sure you also read the alpha.1, alpha.2, and alpha.3 release notes.

Changes in beta 1:

Breaking

• Remove the query option in favor of the searchParams option (It was previously deprecated) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Rename the stream option to isStream 518f0f5906e1fcd38691555b17fb91db643f3d47
• Don't include the Got version in the default user-agent header (#911) 95bed1e
  • got/9.6.0 (https://github.com/sindresorhus/got) → got (https://github.com/sindresorhus/got)
  • Why: Importing package.json to get the version caused a lot of problems.
• Remove got.create() 518f0f5906e1fcd38691555b17fb91db643f3d47
  • You can achieve the same thing with got.extend() now.
• Remove got.mergeInstances() 518f0f5906e1fcd38691555b17fb91db643f3d47
  • Use gotInstance.extend(...gotInstances) instead.
• Use undefined instead of null to omit a header (https://github.com/sindresorhus/got#headers) 518f0f5906e1fcd38691555b17fb91db643f3d47

Enhancements

• Add maxRedirects option (#914) 0c505b0
• Add ability to use something other than tough-cookie for handling cookies (#882) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Allow method rewriting on redirects (#913) b7ead5f
• options.timeout can now be modified in hooks d520a3a
• options.prefixUrl can now be modified in hooks (https://github.com/sindresorhus/got/issues/867) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Only allow supported event names when using TypeScript (#877) 518f0f5906e1fcd38691555b17fb91db643f3d47

Fixes

• Fix Node.js 13 compatibility (#915) b0dfc95
• Fix memory leak when using cache feature (#792) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Don't throw on 204 No Content when parsing response (#925) 518f0f5906e1fcd38691555b17fb91db643f3d47
• When redirect fails, don't retry from scratch (#930) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Retrying inside afterResponse hook should trigger beforeRetry hook (#918) 518f0f5906e1fcd38691555b17fb91db643f3d47
• Fix a bug that sometimes caused the Node process to hang 518f0f5906e1fcd38691555b17fb91db643f3d47
• Fix a bug where cookies weren't reset on redirect between two different sites 518f0f5906e1fcd38691555b17fb91db643f3d47

Docs

• Clarify retry behavior 5e6782a
• Mention how to abort the request using hooks 96ea75f

https://github.com/sindresorhus/got/compare/v10.0.0-alpha.3...v10.0.0-beta.1

While this is an alpha release, the code is well-tested and fairly stable. We encourage you to test it out and report any issues. However, we don't recommend TypeScript users to use this yet as the types are incomplete.

$ npm install got@10.0.0-alpha.2.2

Make sure you also read the alpha.1 release notes.

Changes in alpha.2:

• Export useful TypeScript types for end-users (#889) afe3081
• Fix types: Allow custom retry options (#884) ce8e15b
• Fix types: Allow promises in afterResponse hook (#883) d0c2f05

https://github.com/sindresorhus/got/compare/v10.0.0-alpha.1...v10.0.0-alpha.2

• Add init hook (#683) 677d0a4
• Add beforeError hook (#696) 29ffb44

https://github.com/sindresorhus/got/compare/v9.5.1...v9.6.0

• Fix memory leak when using socket timeout and keepalive agent (#694) 203dadc
• Fix strange timing data for HTTP requests d136e61
• Correctly preserve original status code when returning cached responses d136e61

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

• Remove error thrown for URLs with auth component (#676) 5d20a43
• Upgrade dependencies a1eadfe

https://github.com/sindresorhus/got/compare/v9.4.0...v9.5.0

• Add ability to specify which network error codes to retry on. 9f3a099
• Add Got options onto responses and errors. 33b838f
• Correctly clear socket timeout on error. c8e358f

https://github.com/sindresorhus/got/compare/v9.3.2...v9.4.0

• No new timeouts after an error. https://github.com/sindresorhus/got/commit/d8dd881382dab612ad5b9204de93a02527dc81a9
• Fix the retry math. https://github.com/sindresorhus/got/commit/07b3ce5070515c1a4d1462d2c046ef13b805e812

https://github.com/sindresorhus/got/compare/v9.3.1...v9.3.2

• Don't override headers defined in the url argument when it's an object. 191e00a
• Don't set content-length header when upload body size is null. 311b184

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

• Add option to allow defaults to be mutable. b392f60
• Add beforeRedirect, beforeRetry, and afterResponse hooks. 325409c
• Retry on a few more errors. fbaaa2a
• Include body property in HTTPError. fdc0fa6
• Transform user set headers to lowercase. a07b2be
• Support Electron renderer timings. 25f18be

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

• Gracefully handle invalid Location redirect URLs. (#605) 7ae6939
• Don't override hooks when merging arguments. 3ad3950
• Merge hooks on got.extend(). (#608) 292f78a

https://github.com/sindresorhus/got/compare/v9.2.1...v9.2.2

• Don't cache response when HTTP error was received. #597 b8480f3
• Fix merging default & custom handlers. 5f191b9

https://github.com/sindresorhus/got/compare/v9.2.0...v9.2.1