got 14.6.5 → 15.0.0

package/dist/source/types.d.ts

@@ -1,6 +1,5 @@
-import type { Buffer } from 'node:buffer';
 import type { Spread } from 'type-fest';
-import type { CancelableRequest } from './as-promise/types.js';
+import type { RequestPromise } from './as-promise/types.js';
 import type { Response } from './core/response.js';
 import type Options from './core/options.js';
 import { type PaginationOptions, type OptionsInit } from './core/options.js';
@@ -18,7 +17,7 @@ export type InstanceDefaults = {
     /**
     An array of functions. You execute them directly by calling `got()`.
     They are some sort of "global hooks" - these functions are called first.
-    The last handler (*it's hidden*) is either `asPromise` or `asStream`, depending on the `options.isStream` property.
+    The last handler (*it's hidden*) is either `asPromise` or `asStream`, depending on whether `got()` or `got.stream()` was called.
 
     @default []
     */
@@ -34,7 +33,7 @@ export type InstanceDefaults = {
 /**
 A Request object returned by calling Got, or any of the Got HTTP alias request functions.
 */
-export type GotReturn = Request | CancelableRequest;
+export type GotReturn = Request | RequestPromise;
 /**
 A function to handle options and returns a Request object.
 It acts sort of like a "global hook", and will be called before any actual request is made.
@@ -47,7 +46,7 @@ export type ExtendOptions = {
     /**
     An array of functions. You execute them directly by calling `got()`.
     They are some sort of "global hooks" - these functions are called first.
-    The last handler (*it's hidden*) is either `asPromise` or `asStream`, depending on the `options.isStream` property.
+    The last handler (*it's hidden*) is either `asPromise` or `asStream`, depending on whether `got()` or `got.stream()` was called.
 
     @default []
     */
@@ -59,12 +58,11 @@ export type ExtendOptions = {
     @default false
     */
     mutableDefaults?: boolean;
-} & OptionsInit;
-export type StrictOptions = Except<OptionsInit, 'isStream' | 'responseType' | 'resolveBodyOnly'>;
-export type StreamOptions = Merge<OptionsInit, {
-    isStream?: true;
-}>;
-export type OptionsWithPagination<T = unknown, R = unknown> = Merge<OptionsInit, {
+} & Except<OptionsInit, 'url'>;
+type OptionsInitWithoutUrl = Except<OptionsInit, 'url'>;
+export type StrictOptions = Except<OptionsInitWithoutUrl, 'responseType' | 'resolveBodyOnly'>;
+export type StreamOptions = OptionsInitWithoutUrl;
+export type OptionsWithPagination<T = unknown, R = unknown> = Merge<OptionsInitWithoutUrl, {
     pagination?: PaginationOptions<T, R>;
 }>;
 /**
@@ -124,107 +122,81 @@ export type GotPaginate = {
     all: (<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>) => Promise<T[]>) & (<T, R = unknown>(options?: OptionsWithPagination<T, R>) => Promise<T[]>);
 };
 export type OptionsOfTextResponseBody = Merge<StrictOptions, {
-    isStream?: false;
     responseType?: 'text';
 }>;
 export type OptionsOfTextResponseBodyOnly = Merge<StrictOptions, {
-    isStream?: false;
     resolveBodyOnly: true;
     responseType?: 'text';
 }>;
 export type OptionsOfTextResponseBodyWrapped = Merge<StrictOptions, {
-    isStream?: false;
     resolveBodyOnly: false;
     responseType?: 'text';
 }>;
 export type OptionsOfJSONResponseBody = Merge<StrictOptions, {
-    isStream?: false;
     responseType?: 'json';
 }>;
 export type OptionsOfJSONResponseBodyOnly = Merge<StrictOptions, {
-    isStream?: false;
     resolveBodyOnly: true;
     responseType?: 'json';
 }>;
 export type OptionsOfJSONResponseBodyWrapped = Merge<StrictOptions, {
-    isStream?: false;
     resolveBodyOnly: false;
     responseType?: 'json';
 }>;
 export type OptionsOfBufferResponseBody = Merge<StrictOptions, {
-    isStream?: false;
     responseType?: 'buffer';
 }>;
 export type OptionsOfBufferResponseBodyOnly = Merge<StrictOptions, {
-    isStream?: false;
     resolveBodyOnly: true;
     responseType?: 'buffer';
 }>;
 export type OptionsOfBufferResponseBodyWrapped = Merge<StrictOptions, {
-    isStream?: false;
     resolveBodyOnly: false;
     responseType?: 'buffer';
 }>;
-export type OptionsOfUnknownResponseBody = Merge<StrictOptions, {
-    isStream?: false;
-}>;
+export type OptionsOfUnknownResponseBody = StrictOptions;
 export type OptionsOfUnknownResponseBodyOnly = Merge<StrictOptions, {
-    isStream?: false;
     resolveBodyOnly: true;
 }>;
 export type OptionsOfUnknownResponseBodyWrapped = Merge<StrictOptions, {
-    isStream?: false;
     resolveBodyOnly: false;
 }>;
-type DefaultResponseBodyType<U extends ExtendOptions> = U['responseType'] extends 'json' ? unknown : U['responseType'] extends 'buffer' ? Buffer : string;
+type DefaultResponseBodyType<U extends ExtendOptions> = U['responseType'] extends 'json' ? unknown : U['responseType'] extends 'buffer' ? Uint8Array<ArrayBuffer> : string;
+type GotResponseResult<U extends ExtendOptions, BodyType> = U['resolveBodyOnly'] extends true ? RequestPromise<BodyType> : RequestPromise<Response<BodyType>>;
 export type GotRequestFunction<U extends ExtendOptions = Record<string, unknown>> = {
-    (url: string | URL): U['resolveBodyOnly'] extends true ? CancelableRequest<DefaultResponseBodyType<U>> : CancelableRequest<Response<DefaultResponseBodyType<U>>>;
-    (url: string | URL, options?: OptionsOfTextResponseBody): U['resolveBodyOnly'] extends true ? CancelableRequest<string> : CancelableRequest<Response<string>>;
-    <T>(url: string | URL, options?: OptionsOfJSONResponseBody): U['resolveBodyOnly'] extends true ? CancelableRequest<T> : CancelableRequest<Response<T>>;
-    (url: string | URL, options?: OptionsOfBufferResponseBody): U['resolveBodyOnly'] extends true ? CancelableRequest<Buffer> : CancelableRequest<Response<Buffer>>;
-    (url: string | URL, options?: OptionsOfUnknownResponseBody): U['resolveBodyOnly'] extends true ? CancelableRequest : CancelableRequest<Response>;
-    (url: string | URL, options?: OptionsOfTextResponseBodyWrapped): CancelableRequest<Response<string>>;
-    <T>(url: string | URL, options?: OptionsOfJSONResponseBodyWrapped): CancelableRequest<Response<T>>;
-    (url: string | URL, options?: OptionsOfBufferResponseBodyWrapped): CancelableRequest<Response<Buffer>>;
-    (url: string | URL, options?: OptionsOfUnknownResponseBodyWrapped): CancelableRequest<Response>;
-    (url: string | URL, options?: OptionsOfTextResponseBodyOnly): CancelableRequest<string>;
-    <T>(url: string | URL, options?: OptionsOfJSONResponseBodyOnly): CancelableRequest<T>;
-    (url: string | URL, options?: OptionsOfBufferResponseBodyOnly): CancelableRequest<Buffer>;
-    (url: string | URL, options?: OptionsOfUnknownResponseBodyOnly): CancelableRequest;
-    (options: {
-        url: string | URL;
-    }): U['resolveBodyOnly'] extends true ? CancelableRequest<DefaultResponseBodyType<U>> : CancelableRequest<Response<DefaultResponseBodyType<U>>>;
-    (options: OptionsOfTextResponseBody): U['resolveBodyOnly'] extends true ? CancelableRequest<string> : CancelableRequest<Response<string>>;
-    <T>(options: OptionsOfJSONResponseBody): U['resolveBodyOnly'] extends true ? CancelableRequest<T> : CancelableRequest<Response<T>>;
-    (options: OptionsOfBufferResponseBody): U['resolveBodyOnly'] extends true ? CancelableRequest<Buffer> : CancelableRequest<Response<Buffer>>;
-    (options: OptionsOfUnknownResponseBody): U['resolveBodyOnly'] extends true ? CancelableRequest : CancelableRequest<Response>;
-    (options: OptionsOfTextResponseBodyWrapped): CancelableRequest<Response<string>>;
-    <T>(options: OptionsOfJSONResponseBodyWrapped): CancelableRequest<Response<T>>;
-    (options: OptionsOfBufferResponseBodyWrapped): CancelableRequest<Response<Buffer>>;
-    (options: OptionsOfUnknownResponseBodyWrapped): CancelableRequest<Response>;
-    (options: OptionsOfTextResponseBodyOnly): CancelableRequest<string>;
-    <T>(options: OptionsOfJSONResponseBodyOnly): CancelableRequest<T>;
-    (options: OptionsOfBufferResponseBodyOnly): CancelableRequest<Buffer>;
-    (options: OptionsOfUnknownResponseBodyOnly): CancelableRequest;
-    (url: string | URL, options?: Merge<OptionsInit, {
-        isStream: true;
-    }>): Request;
-    (options: Merge<OptionsInit, {
-        isStream: true;
-    }>): Request;
-    (url: string | URL, options?: OptionsInit): CancelableRequest | Request;
-    (options: OptionsInit): CancelableRequest | Request;
-    (url: undefined, options: undefined, defaults: Options): CancelableRequest | Request;
+    (url: string | URL, options?: OptionsOfUnknownResponseBody): GotResponseResult<U, DefaultResponseBodyType<U>>;
+    (url: string | URL, options?: OptionsOfUnknownResponseBodyWrapped): RequestPromise<Response<DefaultResponseBodyType<U>>>;
+    (url: string | URL, options?: OptionsOfUnknownResponseBodyOnly): RequestPromise<DefaultResponseBodyType<U>>;
+    (url: string | URL, options?: OptionsOfTextResponseBody): GotResponseResult<U, string>;
+    <T>(url: string | URL, options?: OptionsOfJSONResponseBody): GotResponseResult<U, T>;
+    (url: string | URL, options?: OptionsOfBufferResponseBody): GotResponseResult<U, Uint8Array<ArrayBuffer>>;
+    (url: string | URL, options?: OptionsOfTextResponseBodyWrapped): RequestPromise<Response<string>>;
+    <T>(url: string | URL, options?: OptionsOfJSONResponseBodyWrapped): RequestPromise<Response<T>>;
+    (url: string | URL, options?: OptionsOfBufferResponseBodyWrapped): RequestPromise<Response<Uint8Array<ArrayBuffer>>>;
+    (url: string | URL, options?: OptionsOfTextResponseBodyOnly): RequestPromise<string>;
+    <T>(url: string | URL, options?: OptionsOfJSONResponseBodyOnly): RequestPromise<T>;
+    (url: string | URL, options?: OptionsOfBufferResponseBodyOnly): RequestPromise<Uint8Array<ArrayBuffer>>;
+    (options: OptionsOfUnknownResponseBody): GotResponseResult<U, DefaultResponseBodyType<U>>;
+    (options: OptionsOfUnknownResponseBodyWrapped): RequestPromise<Response<DefaultResponseBodyType<U>>>;
+    (options: OptionsOfUnknownResponseBodyOnly): RequestPromise<DefaultResponseBodyType<U>>;
+    (options: OptionsOfTextResponseBody): GotResponseResult<U, string>;
+    <T>(options: OptionsOfJSONResponseBody): GotResponseResult<U, T>;
+    (options: OptionsOfBufferResponseBody): GotResponseResult<U, Uint8Array<ArrayBuffer>>;
+    (options: OptionsOfTextResponseBodyWrapped): RequestPromise<Response<string>>;
+    <T>(options: OptionsOfJSONResponseBodyWrapped): RequestPromise<Response<T>>;
+    (options: OptionsOfBufferResponseBodyWrapped): RequestPromise<Response<Uint8Array<ArrayBuffer>>>;
+    (options: OptionsOfTextResponseBodyOnly): RequestPromise<string>;
+    <T>(options: OptionsOfJSONResponseBodyOnly): RequestPromise<T>;
+    (options: OptionsOfBufferResponseBodyOnly): RequestPromise<Uint8Array<ArrayBuffer>>;
+    (url: string | URL, options?: OptionsInitWithoutUrl): RequestPromise | Request;
+    (options: OptionsInitWithoutUrl): RequestPromise | Request;
+    (url: undefined, options: undefined, defaults: Options): RequestPromise | Request;
 };
 /**
 All available HTTP request methods provided by Got.
 */
 export type HTTPAlias = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete';
-type GotStreamFunction = ((url?: string | URL, options?: Merge<OptionsInit, {
-    isStream?: true;
-}>) => Request) & ((options?: Merge<OptionsInit, {
-    isStream?: true;
-}>) => Request);
+type GotStreamFunction = ((url?: string | URL, options?: StreamOptions) => Request) & ((options?: StreamOptions) => Request);
 /**
 An instance of `got.stream()`.
 */
@@ -234,8 +206,6 @@ An instance of `got`.
 */
 export type Got<GotOptions extends ExtendOptions = ExtendOptions> = {
     /**
-    Sets `options.isStream` to `true`.
-
     Returns a [duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex) with additional events:
     - request
     - response
@@ -243,6 +213,8 @@ export type Got<GotOptions extends ExtendOptions = ExtendOptions> = {
     - uploadProgress
     - downloadProgress
     - error
+
+    Note: For writable request streams, call `stream.end()` when you are not piping a body. `got.stream` does not auto-end for OPTIONS, DELETE, or PATCH so you can pipe or write a body without getting `write after end`.
     */
     stream: GotStream;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "got",
-	"version": "14.6.5",
+	"version": "15.0.0",
 	"description": "Human-friendly and powerful HTTP request library for Node.js",
 	"license": "MIT",
 	"repository": "sindresorhus/got",
@@ -12,7 +12,7 @@
 	},
 	"sideEffects": false,
 	"engines": {
-		"node": ">=20"
+		"node": ">=22"
 	},
 	"scripts": {
 		"test": "xo && tsc --noEmit && NODE_OPTIONS='--import=tsx/esm' ava",
@@ -51,64 +51,60 @@
 		"ky"
 	],
 	"dependencies": {
-		"@sindresorhus/is": "^7.0.1",
+		"@sindresorhus/is": "^7.2.0",
 		"byte-counter": "^0.1.0",
 		"cacheable-lookup": "^7.0.0",
-		"cacheable-request": "^13.0.12",
+		"cacheable-request": "^13.0.18",
+		"chunk-data": "^0.1.0",
 		"decompress-response": "^10.0.0",
-		"form-data-encoder": "^4.0.2",
 		"http2-wrapper": "^2.2.1",
-		"keyv": "^5.5.3",
-		"lowercase-keys": "^3.0.0",
-		"p-cancelable": "^4.0.1",
+		"keyv": "^5.6.0",
+		"lowercase-keys": "^4.0.1",
 		"responselike": "^4.0.2",
-		"type-fest": "^4.26.1"
+		"type-fest": "^5.4.4",
+		"uint8array-extras": "^1.5.0"
 	},
 	"devDependencies": {
 		"@hapi/bourne": "^3.0.0",
-		"@sindresorhus/tsconfig": "^6.0.0",
-		"@sinonjs/fake-timers": "^11.2.2",
+		"@sindresorhus/tsconfig": "^8.1.0",
+		"@sinonjs/fake-timers": "^15.1.0",
 		"@types/benchmark": "^2.1.5",
-		"@types/express": "^5.0.0",
-		"@types/node": "^22.7.5",
+		"@types/express": "^5.0.6",
+		"@types/node": "^25.3.0",
 		"@types/pem": "^1.14.4",
-		"@types/readable-stream": "^4.0.14",
-		"@types/request": "^2.48.12",
-		"@types/sinon": "^17.0.2",
-		"@types/sinonjs__fake-timers": "^8.1.5",
-		"ava": "^5.3.1",
-		"axios": "^1.7.7",
+		"@types/readable-stream": "^4.0.23",
+		"@types/request": "^2.48.13",
+		"@types/sinon": "^21.0.0",
+		"@types/sinonjs__fake-timers": "^15.0.1",
+		"ava": "^6.4.1",
+		"axios": "^1.13.5",
 		"benchmark": "^2.1.4",
 		"bluebird": "^3.7.2",
-		"body-parser": "^1.20.3",
+		"body-parser": "^2.2.2",
 		"c8": "^10.1.3",
-		"chunk-data": "^0.1.0",
 		"create-cert": "^1.0.6",
 		"create-test-server": "^3.0.1",
-		"del-cli": "^6.0.0",
-		"delay": "^6.0.0",
-		"expect-type": "^1.0.0",
-		"express": "^4.21.1",
-		"form-data": "^4.0.0",
-		"formdata-node": "^6.0.3",
+		"del-cli": "^7.0.0",
+		"delay": "^7.0.0",
+		"expect-type": "^1.3.0",
+		"express": "^5.2.1",
 		"get-stream": "^9.0.1",
-		"nock": "^13.5.5",
 		"node-fetch": "^3.3.2",
-		"np": "^10.0.5",
-		"p-event": "^6.0.1",
+		"np": "^11.0.2",
+		"p-event": "^7.1.0",
 		"pem": "^1.14.8",
 		"pify": "^6.1.0",
-		"quick-lru": "^7.2.0",
-		"readable-stream": "^4.4.2",
+		"quick-lru": "^7.3.0",
+		"readable-stream": "^4.7.0",
 		"request": "^2.88.2",
-		"sinon": "^19.0.2",
+		"sinon": "^21.0.1",
 		"slow-stream": "0.0.4",
-		"tempy": "^3.1.0",
+		"tempy": "^3.2.0",
 		"then-busboy": "^5.2.1",
-		"tough-cookie": "^4.1.4",
-		"tsx": "^4.19.1",
-		"typescript": "^5.6.3",
-		"xo": "^0.56.0"
+		"tough-cookie": "^6.0.0",
+		"tsx": "^4.21.0",
+		"typescript": "^5.9.3",
+		"xo": "^1.2.3"
 	},
 	"ava": {
 		"files": [

package/readme.md

@@ -176,7 +176,7 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 | Promise API           | :heavy_check_mark:  | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark: | :heavy_check_mark:     |
 | Stream API            | :heavy_check_mark:  | Node.js only         | :x:                      | :x:                | :heavy_check_mark:     |
 | Pagination API        | :heavy_check_mark:  | :x:                  | :x:                      | :x:                | :x:                    |
-| Request cancelation   | :heavy_check_mark:  | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark: | :heavy_check_mark:     |
+| Request aborting       | :heavy_check_mark:  | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark: | :heavy_check_mark:     |
 | RFC compliant caching | :heavy_check_mark:  | :x:                  | :x:                      | :x:                | :x:                    |
 | Cookies (out-of-the-box) | :heavy_check_mark: | :x:                | :x:                      | :x:                | :x:                    |
 | Follows redirects     | :heavy_check_mark:  | :heavy_check_mark:   | :heavy_check_mark:       | :heavy_check_mark: | :heavy_check_mark:     |
@@ -359,7 +359,7 @@ By default, Got will retry on failure. To disable this option, set [`options.ret
 
 [Click here][InstallSizeOfTheDependencies] to see the install size of the Got dependencies.
 
-[InstallSizeOfTheDependencies]: https://packagephobia.com/result?p=@sindresorhus/is@7.0.0,@szmarczak/http-timer@5.0.1,cacheable-lookup@7.0.0,cacheable-request@12.0.1,decompress-response@6.0.0,form-data-encoder@4.0.2,http2-wrapper@2.2.1,lowercase-keys@3.0.0,p-cancelable@4.0.1,responselike@3.0.0,type-fest@4.19.0
+[InstallSizeOfTheDependencies]: https://packagephobia.com/result?p=@sindresorhus/is@7.2.0,byte-counter@0.1.0,cacheable-lookup@7.0.0,cacheable-request@13.0.18,chunk-data@0.1.0,decompress-response@10.0.0,http2-wrapper@2.2.1,keyv@5.6.0,lowercase-keys@4.0.1,responselike@4.0.2,type-fest@5.4.4
 
 ## Maintainers
 

package/dist/source/core/utils/is-form-data.d.ts

@@ -1,7 +0,0 @@
-import type { Readable } from 'node:stream';
-type FormData = {
-    getBoundary: () => string;
-    getLength: (callback: (error: Error | null, length: number) => void) => void;
-} & Readable;
-export default function isFormData(body: unknown): body is FormData;
-export {};

package/dist/source/core/utils/is-form-data.js

@@ -1,4 +0,0 @@
-import is from '@sindresorhus/is';
-export default function isFormData(body) {
-    return is.nodeStream(body) && is.function(body.getBoundary);
-}

package/dist/source/core/utils/url-to-options.d.ts

@@ -1,14 +0,0 @@
-import type { UrlWithStringQuery } from 'node:url';
-export type LegacyUrlOptions = {
-    protocol: string;
-    hostname: string;
-    host: string;
-    hash: string | null;
-    search: string | null;
-    pathname: string;
-    href: string;
-    path: string;
-    port?: number;
-    auth?: string;
-};
-export default function urlToOptions(url: URL | UrlWithStringQuery): LegacyUrlOptions;

package/dist/source/core/utils/url-to-options.js

@@ -1,22 +0,0 @@
-import is from '@sindresorhus/is';
-export default function urlToOptions(url) {
-    // Cast to URL
-    url = url;
-    const options = {
-        protocol: url.protocol,
-        hostname: is.string(url.hostname) && url.hostname.startsWith('[') ? url.hostname.slice(1, -1) : url.hostname,
-        host: url.host,
-        hash: url.hash,
-        search: url.search,
-        pathname: url.pathname,
-        href: url.href,
-        path: `${url.pathname || ''}${url.search || ''}`,
-    };
-    if (is.string(url.port) && url.port.length > 0) {
-        options.port = Number(url.port);
-    }
-    if (url.username || url.password) {
-        options.auth = `${url.username || ''}:${url.password || ''}`;
-    }
-    return options;
-}