urllib 3.14.1 → 3.16.0

package/README.md

@@ -75,6 +75,7 @@ console.log('status: %s, body size: %d, headers: %j', res.status, data.length, r
   - ***compressed*** Boolean - Accept `gzip, br` response content and auto decode it, default is `false`.
   - ***timing*** Boolean - Enable timing or not, default is `false`.
   - ***socketPath*** String | null - request a unix socket service, default is `null`.
+  - ***highWaterMark*** Number - default is `67108864`, 64 KiB.
 
 #### Options: `options.data`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "urllib",
-  "version": "3.14.1",
+  "version": "3.16.0",
   "publishConfig": {
     "tag": "latest"
   },
@@ -42,10 +42,12 @@
   },
   "scripts": {
     "lint": "eslint src test --ext .ts --cache",
-    "build": "npm run clean && npm run build:dist",
+    "prebuild": "npm run clean",
+    "build": "tsc --version && npm run build:cjs && npm run build:esm && npm run build:version",
+    "postbuild": "rm -rf src/*.tsbuildinfo",
     "build:cjs": "tsc -p ./tsconfig.build.cjs.json",
     "build:esm": "tsc -p ./tsconfig.build.esm.json && node ./scripts/esm_import_fix.js",
-    "build:dist": "tsc --version && npm run build:cjs && npm run build:esm",
+    "build:version": "node ./scripts/replace_urllib_version.js",
     "build:cjs:test": "cd test/cjs && rm -rf node_modules && npm link ../.. && node index.js",
     "build:esm:test": "cd test/esm && rm -rf node_modules && npm link ../.. && node index.js",
     "build:test": "npm run build && npm run build:cjs:test && npm run build:esm:test && npm run test-tsc",
@@ -55,7 +57,7 @@
     "ci": "npm run lint && npm run cov && npm run build:test",
     "contributor": "git-contributor",
     "clean": "rm -rf src/*.tsbuildinfo src/cjs/*.ts src/cjs/*.js src/esm/*.ts src/esm/*.js",
-    "prepack": "npm run build && rm -rf src/*.tsbuildinfo"
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
     "default-user-agent": "^1.0.0",
@@ -71,7 +73,7 @@
     "@types/busboy": "^1.5.0",
     "@types/default-user-agent": "^1.0.0",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^18.11.18",
+    "@types/node": "^20.2.1",
     "@types/pump": "^1.1.1",
     "@types/selfsigned": "^2.0.1",
     "@types/tar-stream": "^2.2.2",

package/src/HttpClient.ts

@@ -121,7 +121,7 @@ class HttpClientRequestTimeoutError extends Error {
   }
 }
 
-export const HEADER_USER_AGENT = createUserAgent('node-urllib', '3.0.0');
+export const HEADER_USER_AGENT = createUserAgent('node-urllib', 'VERSION');
 
 function getFileName(stream: Readable) {
   const filePath: string = (stream as any).path;
@@ -316,10 +316,12 @@ export class HttpClient extends EventEmitter {
         opaque: internalOpaque,
         dispatcher: args.dispatcher ?? this.#dispatcher,
       };
+      if (typeof args.highWaterMark === 'number') {
+        requestOptions.highWaterMark = args.highWaterMark;
+      }
       if (typeof args.reset === 'boolean') {
         requestOptions.reset = args.reset;
       }
-
       if (args.followRedirect === false) {
         requestOptions.maxRedirections = 0;
       }

package/src/Request.ts

@@ -125,11 +125,12 @@ export type RequestOptions = {
    * request dispatcher, default is getGlobalDispatcher()
    */
   dispatcher?: Dispatcher;
-
   /**
    * unix domain socket file path
    */
   socketPath?: string | null;
   /** Whether the request should stablish a keep-alive or not. Default `undefined` */
   reset?: boolean;
+  /** Default: `64 KiB` */
+  highWaterMark?: number;
 };

package/src/cjs/HttpClient.js

@@ -69,7 +69,7 @@ class HttpClientRequestTimeoutError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-exports.HEADER_USER_AGENT = (0, default_user_agent_1.default)('node-urllib', '3.0.0');
+exports.HEADER_USER_AGENT = (0, default_user_agent_1.default)('node-urllib', '3.16.0');
 function getFileName(stream) {
     const filePath = stream.path;
     if (filePath) {
@@ -253,6 +253,9 @@ class HttpClient extends node_events_1.EventEmitter {
                 opaque: internalOpaque,
                 dispatcher: args.dispatcher ?? this.#dispatcher,
             };
+            if (typeof args.highWaterMark === 'number') {
+                requestOptions.highWaterMark = args.highWaterMark;
+            }
             if (typeof args.reset === 'boolean') {
                 requestOptions.reset = args.reset;
             }

package/src/cjs/Request.d.ts

@@ -129,4 +129,6 @@ export type RequestOptions = {
     socketPath?: string | null;
     /** Whether the request should stablish a keep-alive or not. Default `undefined` */
     reset?: boolean;
+    /** Default: `64 KiB` */
+    highWaterMark?: number;
 };

package/src/esm/HttpClient.js

@@ -63,7 +63,7 @@ class HttpClientRequestTimeoutError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-export const HEADER_USER_AGENT = createUserAgent('node-urllib', '3.0.0');
+export const HEADER_USER_AGENT = createUserAgent('node-urllib', '3.16.0');
 function getFileName(stream) {
     const filePath = stream.path;
     if (filePath) {
@@ -247,6 +247,9 @@ export class HttpClient extends EventEmitter {
                 opaque: internalOpaque,
                 dispatcher: args.dispatcher ?? this.#dispatcher,
             };
+            if (typeof args.highWaterMark === 'number') {
+                requestOptions.highWaterMark = args.highWaterMark;
+            }
             if (typeof args.reset === 'boolean') {
                 requestOptions.reset = args.reset;
             }

package/src/esm/Request.d.ts

@@ -129,4 +129,6 @@ export type RequestOptions = {
     socketPath?: string | null;
     /** Whether the request should stablish a keep-alive or not. Default `undefined` */
     reset?: boolean;
+    /** Default: `64 KiB` */
+    highWaterMark?: number;
 };