Skip to content

Commit 52a1063

Browse files
sindresorhussindresorhus
committed
Require Node.js 16
Fixes #989 Fixes #1581
1 parent 1cefe8b commit 52a1063

28 files changed

+338
-350
lines changed

‎benchmark/index.ts

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import {URL} from 'node:url';
21
import https from 'node:https';
32
/// import axios from 'axios';
43
import Benchmark from 'benchmark';

‎documentation/3-streams.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -27,29 +27,27 @@ This constructor takes the same arguments as the Got promise.
2727
> - If there's no body on purpose, remember to `stream.end()` or set the body option to an empty string.
2828
2929
```js
30-
import {promisify} from 'node:util';
3130
import stream from 'node:stream';
31+
import {pipeline as streamPipeline} from 'node:stream/promises';
3232
import fs from 'node:fs';
3333
import got from 'got';
3434

35-
const pipeline = promisify(stream.pipeline);
36-
3735
// This example streams the GET response of a URL to a file.
38-
await pipeline(
36+
await streamPipeline(
3937
got.stream('https://sindresorhus.com'),
4038
fs.createWriteStream('index.html')
4139
);
4240

4341
// For POST, PUT, PATCH, and DELETE methods, `got.stream` returns a `stream.Writable`.
4442
// This example POSTs the contents of a file to a URL.
45-
await pipeline(
43+
await streamPipeline(
4644
fs.createReadStream('index.html'),
4745
got.stream.post('https://sindresorhus.com'),
4846
new stream.PassThrough()
4947
);
5048

5149
// In order to POST, PUT, PATCH, or DELETE without a request body, explicitly specify an empty body:
52-
await pipeline(
50+
await streamPipeline(
5351
got.stream.post('https://sindresorhus.com', { body: '' }),
5452
new stream.PassThrough()
5553
)
@@ -181,7 +179,7 @@ Whether the socket was used for other previous requests.
181179
This is emitted when a HTTP response is received.
182180

183181
```js
184-
import {pipeline} from 'node:stream/promises';
182+
import {pipeline as streamPipeline} from 'node:stream/promises';
185183
import {createWriteStream} from 'node:fs';
186184
import got from 'got';
187185

@@ -202,7 +200,7 @@ readStream.on('response', async response => {
202200
readStream.off('error', onError);
203201

204202
try {
205-
await pipeline(
203+
await streamPipeline(
206204
readStream,
207205
createWriteStream('image.png')
208206
);

‎documentation/migration-guides/nodejs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ Well, it's easy as that:
7878

7979
```js
8080
import got from 'got';
81-
import stream from 'node:stream';
81+
import {pipeline as streamPipeline} from 'node:stream/promises';
8282
import fs from 'node:fs';
8383

84-
await stream.promises.pipeline(
84+
await streamPipeline(
8585
fs.createReadStream('article.txt'),
8686
got.stream.post('https://httpbin.org/anything'),
8787
fs.createWriteStream('httpbin.txt')

‎documentation/migration-guides/request.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -113,15 +113,12 @@ http.createServer((serverRequest, serverResponse) => {
113113
The cool feature here is that Request can proxy headers with the stream, but Got can do that too!
114114

115115
```js
116-
import {promisify} from 'node:util';
117-
import stream from 'node:stream';
116+
import {pipeline as streamPipeline} from 'node:stream/promises';
118117
import got from 'got';
119118

120-
const pipeline = promisify(stream.pipeline);
121-
122119
const server = http.createServer(async (serverRequest, serverResponse) => {
123120
if (serverRequest.url === '/doodle.png') {
124-
await pipeline(
121+
await streamPipeline(
125122
got.stream('https://example.com/doodle.png'),
126123
serverResponse
127124
);

‎documentation/quick-start.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The [Stream API](3-streams.md) allows to leverage [Node.js Streams](https://node
6565

6666
```js
6767
import fs from 'node:fs';
68-
import {pipeline} from 'node:stream/promises';
68+
import {pipeline as streamPipeline} from 'node:stream/promises';
6969
import got from 'got';
7070

7171
const url = 'https://httpbin.org/anything';
@@ -81,7 +81,7 @@ const gotStream = got.stream.post(url, options);
8181
const outStream = fs.createWriteStream('anything.json');
8282

8383
try {
84-
await pipeline(gotStream, outStream);
84+
await streamPipeline(gotStream, outStream);
8585
} catch (error) {
8686
console.error(error);
8787
}

‎package.json

+9-7
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@
66
"repository": "sindresorhus/got",
77
"funding": "https://github.com/sindresorhus/got?sponsor=1",
88
"type": "module",
9-
"exports": "./dist/source/index.js",
10-
"types": "./dist/source/index.d.ts",
9+
"exports": {
10+
"types": "./dist/source/index.d.ts",
11+
"default": "./dist/source/index.js"
12+
},
1113
"engines": {
12-
"node": ">=14.16"
14+
"node": ">=16"
1315
},
1416
"scripts": {
1517
"test": "xo && tsc --noEmit && ava",
@@ -99,8 +101,8 @@
99101
"tough-cookie": "4.1.2",
100102
"ts-node": "^10.8.2",
101103
"type-fest": "^3.6.1",
102-
"typescript": "~4.9.5",
103-
"xo": "^0.53.1"
104+
"typescript": "^5.0.4",
105+
"xo": "^0.54.2"
104106
},
105107
"sideEffects": false,
106108
"ava": {
@@ -135,8 +137,6 @@
135137
"rules": {
136138
"@typescript-eslint/no-empty-function": "off",
137139
"n/no-deprecated-api": "off",
138-
"n/prefer-global/url": "off",
139-
"n/prefer-global/url-search-params": "off",
140140
"@typescript-eslint/no-implicit-any-catch": "off",
141141
"unicorn/prefer-node-protocol": "off",
142142
"ava/assertion-arguments": "off",
@@ -146,6 +146,8 @@
146146
"@typescript-eslint/no-unsafe-call": "off",
147147
"@typescript-eslint/await-thenable": "off",
148148
"@typescript-eslint/no-redundant-type-constituents": "off",
149+
"@typescript-eslint/no-unsafe-argument": "off",
150+
"@typescript-eslint/promise-function-async": "off",
149151
"no-lone-blocks": "off",
150152
"unicorn/no-await-expression-member": "off"
151153
}

‎source/core/index.ts

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import process from 'node:process';
22
import {Buffer} from 'node:buffer';
33
import {Duplex, type Readable} from 'node:stream';
4-
import {URL, URLSearchParams} from 'node:url';
54
import http, {ServerResponse} from 'node:http';
65
import type {ClientRequest, RequestOptions} from 'node:http';
76
import type {Socket} from 'node:net';
@@ -46,6 +45,8 @@ import {
4645
AbortError,
4746
} from './errors.js';
4847

48+
const {buffer: getStreamAsBuffer} = getStream;
49+
4950
type Error = NodeJS.ErrnoException;
5051

5152
export type Progress = {
@@ -54,8 +55,6 @@ export type Progress = {
5455
total?: number;
5556
};
5657

57-
const {buffer: getBuffer} = getStream;
58-
5958
const supportsBrotli = is.string(process.versions.brotli);
6059

6160
const methodsWithoutBody: ReadonlySet<string> = new Set(['GET', 'HEAD']);
@@ -176,7 +175,7 @@ export default class Request extends Duplex implements RequestEvents<Request> {
176175
private _isFromCache?: boolean;
177176
private _cannotHaveBody: boolean;
178177
private _triggerRead: boolean;
179-
declare private _jobs: Array<() => void>;
178+
declare private readonly _jobs: Array<() => void>;
180179
private _cancelTimeouts: () => void;
181180
private readonly _removeListeners: () => void;
182181
private _nativeResponse?: IncomingMessageWithTimings;
@@ -877,7 +876,11 @@ export default class Request extends Duplex implements RequestEvents<Request> {
877876

878877
try {
879878
// Errors are emitted via the `error` event
880-
const rawBody = await getBuffer(from);
879+
const rawBody = await getStreamAsBuffer(from);
880+
881+
// TODO: Switch to this:
882+
// let rawBody = await from.toArray();
883+
// rawBody = Buffer.concat(rawBody);
881884

882885
// On retry Request is destroyed with no error, therefore the above will successfully resolve.
883886
// So in order to check if this was really successfull, we need to check if it has been properly ended.
@@ -992,7 +995,6 @@ export default class Request extends Duplex implements RequestEvents<Request> {
992995
// We only need to implement the error handler in order to support HTTP2 caching.
993996
// The result will be a promise anyway.
994997
// @ts-expect-error ignore
995-
// eslint-disable-next-line @typescript-eslint/promise-function-async
996998
result.once = (event: string, handler: (reason: unknown) => void) => {
997999
if (event === 'error') {
9981000
(async () => {

‎source/core/options.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import process from 'node:process';
22
import type {Buffer} from 'node:buffer';
33
import {promisify, inspect} from 'node:util';
4-
import {URL, URLSearchParams} from 'node:url';
54
import {checkServerIdentity} from 'node:tls';
65
// DO NOT use destructuring for `https.request` and `http.request` as it's not compatible with `nock`.
76
import http from 'node:http';
@@ -976,7 +975,7 @@ const init = (options: OptionsInit, withOptions: OptionsInit, self: Options): vo
976975

977976
export default class Options {
978977
private _unixOptions?: NativeRequestOptions;
979-
private _internals: InternalsType;
978+
private readonly _internals: InternalsType;
980979
private _merging: boolean;
981980
private readonly _init: OptionsInit[];
982981

‎source/core/response.ts

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import type {Buffer} from 'node:buffer';
2-
import type {URL} from 'node:url';
32
import type {IncomingMessageWithTimings, Timings} from '@szmarczak/http-timer';
43
import {RequestError} from './errors.js';
54
import type {ParseJsonFunction, ResponseType} from './options.js';

‎source/core/timed-out.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,15 @@ export default function timedOut(request: ClientRequest, delays: Delays, options
9090
}
9191
});
9292

93-
if (typeof delays.request !== 'undefined') {
93+
if (delays.request !== undefined) {
9494
const cancelTimeout = addTimeout(delays.request, timeoutHandler, 'request');
9595

9696
once(request, 'response', (response: IncomingMessage): void => {
9797
once(response, 'end', cancelTimeout);
9898
});
9999
}
100100

101-
if (typeof delays.socket !== 'undefined') {
101+
if (delays.socket !== undefined) {
102102
const {socket} = delays;
103103

104104
const socketTimeoutHandler = (): void => {
@@ -115,10 +115,10 @@ export default function timedOut(request: ClientRequest, delays: Delays, options
115115
});
116116
}
117117

118-
const hasLookup = typeof delays.lookup !== 'undefined';
119-
const hasConnect = typeof delays.connect !== 'undefined';
120-
const hasSecureConnect = typeof delays.secureConnect !== 'undefined';
121-
const hasSend = typeof delays.send !== 'undefined';
118+
const hasLookup = delays.lookup !== undefined;
119+
const hasConnect = delays.connect !== undefined;
120+
const hasSecureConnect = delays.secureConnect !== undefined;
121+
const hasSend = delays.send !== undefined;
122122
if (hasLookup || hasConnect || hasSecureConnect || hasSend) {
123123
once(request, 'socket', (socket: net.Socket): void => {
124124
const {socketPath} = request as ClientRequest & {socketPath?: string};
@@ -127,7 +127,7 @@ export default function timedOut(request: ClientRequest, delays: Delays, options
127127
if (socket.connecting) {
128128
const hasPath = Boolean(socketPath ?? net.isIP(hostname ?? host ?? '') !== 0);
129129

130-
if (hasLookup && !hasPath && typeof (socket.address() as net.AddressInfo).address === 'undefined') {
130+
if (hasLookup && !hasPath && (socket.address() as net.AddressInfo).address === undefined) {
131131
const cancelTimeout = addTimeout(delays.lookup!, timeoutHandler, 'lookup');
132132
once(socket, 'lookup', cancelTimeout);
133133
}
@@ -168,14 +168,14 @@ export default function timedOut(request: ClientRequest, delays: Delays, options
168168
});
169169
}
170170

171-
if (typeof delays.response !== 'undefined') {
171+
if (delays.response !== undefined) {
172172
once(request, 'upload-complete', (): void => {
173173
const cancelTimeout = addTimeout(delays.response!, timeoutHandler, 'response');
174174
once(request, 'response', cancelTimeout);
175175
});
176176
}
177177

178-
if (typeof delays.read !== 'undefined') {
178+
if (delays.read !== undefined) {
179179
once(request, 'response', (response: IncomingMessage): void => {
180180
const cancelTimeout = addTimeout(delays.read!, timeoutHandler, 'read');
181181
once(response, 'end', cancelTimeout);

‎source/core/utils/is-unix-socket-url.ts

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
import type {URL} from 'url';
2-
31
// eslint-disable-next-line @typescript-eslint/naming-convention
42
export default function isUnixSocketURL(url: URL) {
53
return url.protocol === 'unix:' || url.hostname === 'unix';

‎source/core/utils/options-to-url.ts

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
/* istanbul ignore file: deprecated */
2-
import {URL} from 'node:url';
3-
41
// eslint-disable-next-line @typescript-eslint/naming-convention
52
export type URLOptions = {
63
href?: string;

‎source/core/utils/url-to-options.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type {URL, UrlWithStringQuery} from 'node:url';
1+
import type {UrlWithStringQuery} from 'node:url';
22
import is from '@sindresorhus/is';
33

44
// TODO: Deprecate legacy URL at some point

‎source/create.ts

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import type {URL} from 'node:url';
21
import is, {assert} from '@sindresorhus/is';
32
import asPromise from './as-promise/index.js';
43
import type {

‎source/types.ts

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import type {Buffer} from 'node:buffer';
2-
import type {URL} from 'node:url';
32
import type {CancelableRequest} from './as-promise/types.js';
43
import type {Response} from './core/response.js';
54
import type Options from './core/options.js';

0 commit comments

Comments
 (0)