@wiajs/request 3.0.31 → 3.0.33

package/dist/request.cjs

@@ -1,5 +1,5 @@
 /*!
-  * wia request v3.0.31
+  * wia request v3.0.33
   * (c) 2022-2024 Sibyl Yu and contributors
   * Released under the MIT License.
   */
@@ -636,7 +636,7 @@ class Request extends stream.Duplex {
     super();
     const m = this;
 
-    // log({opts}, 'constructor');
+    // log({opts}, 'new Request')
 
     // Initialize the request
     m.sanitizeOptions(opts);
@@ -1451,8 +1451,8 @@ class Request extends stream.Duplex {
    * @override -  重写父类方法
    * @template T - 需要模板
    * @param {T & stream.Writable} dest - The writable stream to which data is written.
-   * @param {Object} [opts] - Optional configuration object.
-   * @param {boolean} [opts.end=true] - Whether to end the writable stream when the readable stream ends.
+   * @param {Object} [opt] - Optional configuration object.
+   * @param {boolean} [opt.end=true] - Whether to end the writable stream when the readable stream ends.
    * @returns {T} The destination stream.
    */
   pipe(dest, opts = {}) {
@@ -1645,6 +1645,7 @@ const log = log$2.log({env: `wia:req:${log$2.name((typeof document === 'undefine
  * @prop {string} [url]
  * @prop {'http:' | 'https:'} [protocol]
  * @prop {string} [host]
+ * @prop {string} [hostname]
  * @prop {string} [family]
  * @prop {string} [path]
  * @prop {string} [method]
@@ -1691,7 +1692,7 @@ utils.createErrorType(
  * @param {string | Opts} uri/opts
  * @param {Opts | Cb} [opts] /cb
  * @param {Cb} [cb]
- * @returns {{opts: Opts, cb: Cb}}
+ * @returns {{opt: Opts, cb: Cb}}
  */
 function init(uri, opts, cb) {
   let R;
@@ -1727,26 +1728,28 @@ function init(uri, opts, cb) {
     }
 
     // copy options
-    opts = {
+    /** @type {Opts} */
+    const opt = {
       // @ts-ignore
       ...uri,
       ...opts,
     };
 
-    // @ts-ignore
-    if (!utils.isString(opts.host) && !utils.isString(opts.hostname)) opts.hostname = '::1';
-    // @ts-ignore
-    if (opts.method) opts.method = opts.method.toUpperCase();
+    if (!utils.isString(opt.host) && !utils.isString(opt.hostname)) opt.hostname = '::1';
+    opt.method = (opt.method ?? 'get').toUpperCase();
 
-    // @ts-ignore
     // follow-redirects does not skip comparison, so it should always succeed for axios -1 unlimited
-    opts.maxBodyLength = opts.maxBodyLength ?? Number.POSITIVE_INFINITY;
-    // @ts-ignore
-    opts.maxRedirects = opts.maxRedirects ?? 21;
-    // @ts-ignore
-    if (opts.maxRedirects === 0) opts.followRedirects = false;
+    opt.maxBodyLength = opt.maxBodyLength ?? Number.POSITIVE_INFINITY;
+    opt.maxRedirects = opt.maxRedirects ?? 21;
+    if (opt.maxRedirects === 0) opt.followRedirects = false;
+    opt.headers = opt.headers ?? {
+      Accept: 'application/json, text/plain, */*',
+      'User-Agent':
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36 Edg/107.0.1418.35',
+      'Accept-Encoding': 'gzip, compress, deflate, br',
+    };
 
-    R = {opts, cb};
+    R = {opt, cb};
     // log({R}, 'init')
   } catch (e) {
     log.err(e, 'init');
@@ -1764,24 +1767,24 @@ function init(uri, opts, cb) {
     maxRedirects: _.maxRedirects,
     maxBodyLength: _.maxBodyLength,
  * @param {string | Opts} uri /options
- * @param {Opts | Cb} [options] /callback
+ * @param {Opts | Cb} [opts] /callback
  * @param {Cb} [callback] /null
  * @returns {Request}
  */
-function request(uri, options, callback) {
+function request(uri, opts, callback) {
   let R = null;
 
   try {
     // @ts-ignore
-    const {opts, cb} = init(uri, options, callback);
+    const {opt, cb} = init(uri, opts, callback);
     // log.error({uri, options, opts}, 'request')
 
-    const {data, stream} = opts;
+    const {data, stream} = opt;
     // data 在本函数完成处理，不传递到 request
-    opts.data = undefined;
+    opt.data = undefined;
 
     // @ts-ignore
-    const req = new Request(opts, cb);
+    const req = new Request(opt, cb);
 
     // 非流模式，自动发送请求，流模式通过流写入发送
     if (!stream) {
@@ -1826,7 +1829,7 @@ function request(uri, options, callback) {
 }
 
 /**
- * 执行简单的数据（支持strean）请求
+ * 执行简单的数据（支持stream）请求
  * 非流模式，直接写入数据流，流模式，由管道触发，或手动调用 end() data.pipe 写入数据
  * 复杂数据，请使用 @wiajs/req库（fork from axios），该库封装了当前库，提供了更多功能
  * organize params for patch, post, put, head, del

package/dist/request.mjs

@@ -1,5 +1,5 @@
 /*!
-  * wia request v3.0.31
+  * wia request v3.0.33
   * (c) 2022-2024 Sibyl Yu and contributors
   * Released under the MIT License.
   */
@@ -633,7 +633,7 @@ class Request extends Duplex {
     super();
     const m = this;
 
-    // log({opts}, 'constructor');
+    // log({opts}, 'new Request')
 
     // Initialize the request
     m.sanitizeOptions(opts);
@@ -1448,8 +1448,8 @@ class Request extends Duplex {
    * @override -  重写父类方法
    * @template T - 需要模板
    * @param {T & stream.Writable} dest - The writable stream to which data is written.
-   * @param {Object} [opts] - Optional configuration object.
-   * @param {boolean} [opts.end=true] - Whether to end the writable stream when the readable stream ends.
+   * @param {Object} [opt] - Optional configuration object.
+   * @param {boolean} [opt.end=true] - Whether to end the writable stream when the readable stream ends.
    * @returns {T} The destination stream.
    */
   pipe(dest, opts = {}) {
@@ -1642,6 +1642,7 @@ const log = log$2({env: `wia:req:${name(import.meta.url)}`}); // __filename
  * @prop {string} [url]
  * @prop {'http:' | 'https:'} [protocol]
  * @prop {string} [host]
+ * @prop {string} [hostname]
  * @prop {string} [family]
  * @prop {string} [path]
  * @prop {string} [method]
@@ -1688,7 +1689,7 @@ utils.createErrorType(
  * @param {string | Opts} uri/opts
  * @param {Opts | Cb} [opts] /cb
  * @param {Cb} [cb]
- * @returns {{opts: Opts, cb: Cb}}
+ * @returns {{opt: Opts, cb: Cb}}
  */
 function init(uri, opts, cb) {
   let R;
@@ -1724,26 +1725,28 @@ function init(uri, opts, cb) {
     }
 
     // copy options
-    opts = {
+    /** @type {Opts} */
+    const opt = {
       // @ts-ignore
       ...uri,
       ...opts,
     };
 
-    // @ts-ignore
-    if (!utils.isString(opts.host) && !utils.isString(opts.hostname)) opts.hostname = '::1';
-    // @ts-ignore
-    if (opts.method) opts.method = opts.method.toUpperCase();
+    if (!utils.isString(opt.host) && !utils.isString(opt.hostname)) opt.hostname = '::1';
+    opt.method = (opt.method ?? 'get').toUpperCase();
 
-    // @ts-ignore
     // follow-redirects does not skip comparison, so it should always succeed for axios -1 unlimited
-    opts.maxBodyLength = opts.maxBodyLength ?? Number.POSITIVE_INFINITY;
-    // @ts-ignore
-    opts.maxRedirects = opts.maxRedirects ?? 21;
-    // @ts-ignore
-    if (opts.maxRedirects === 0) opts.followRedirects = false;
+    opt.maxBodyLength = opt.maxBodyLength ?? Number.POSITIVE_INFINITY;
+    opt.maxRedirects = opt.maxRedirects ?? 21;
+    if (opt.maxRedirects === 0) opt.followRedirects = false;
+    opt.headers = opt.headers ?? {
+      Accept: 'application/json, text/plain, */*',
+      'User-Agent':
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36 Edg/107.0.1418.35',
+      'Accept-Encoding': 'gzip, compress, deflate, br',
+    };
 
-    R = {opts, cb};
+    R = {opt, cb};
     // log({R}, 'init')
   } catch (e) {
     log.err(e, 'init');
@@ -1761,24 +1764,24 @@ function init(uri, opts, cb) {
     maxRedirects: _.maxRedirects,
     maxBodyLength: _.maxBodyLength,
  * @param {string | Opts} uri /options
- * @param {Opts | Cb} [options] /callback
+ * @param {Opts | Cb} [opts] /callback
  * @param {Cb} [callback] /null
  * @returns {Request}
  */
-function request(uri, options, callback) {
+function request(uri, opts, callback) {
   let R = null;
 
   try {
     // @ts-ignore
-    const {opts, cb} = init(uri, options, callback);
+    const {opt, cb} = init(uri, opts, callback);
     // log.error({uri, options, opts}, 'request')
 
-    const {data, stream} = opts;
+    const {data, stream} = opt;
     // data 在本函数完成处理，不传递到 request
-    opts.data = undefined;
+    opt.data = undefined;
 
     // @ts-ignore
-    const req = new Request(opts, cb);
+    const req = new Request(opt, cb);
 
     // 非流模式，自动发送请求，流模式通过流写入发送
     if (!stream) {
@@ -1823,7 +1826,7 @@ function request(uri, options, callback) {
 }
 
 /**
- * 执行简单的数据（支持strean）请求
+ * 执行简单的数据（支持stream）请求
  * 非流模式，直接写入数据流，流模式，由管道触发，或手动调用 end() data.pipe 写入数据
  * 复杂数据，请使用 @wiajs/req库（fork from axios），该库封装了当前库，提供了更多功能
  * organize params for patch, post, put, head, del

package/lib/index.js

@@ -17,6 +17,7 @@ const log = Log({
  * @prop {string} [url]
  * @prop {'http:' | 'https:'} [protocol]
  * @prop {string} [host]
+ * @prop {string} [hostname]
  * @prop {string} [family]
  * @prop {string} [path]
  * @prop {string} [method]
@@ -50,7 +51,7 @@ const log = Log({
  * @param {string | Opts} uri/opts
  * @param {Opts | Cb} [opts] /cb
  * @param {Cb} [cb]
- * @returns {{opts: Opts, cb: Cb}}
+ * @returns {{opt: Opts, cb: Cb}}
  */ function init(uri, opts, cb) {
     let R;
     try {
@@ -84,24 +85,24 @@ const log = Log({
             opts = {};
         }
         // copy options
-        opts = {
+        /** @type {Opts} */ const opt = {
             // @ts-ignore
             ...uri,
             ...opts
         };
-        // @ts-ignore
-        if (!utils.isString(opts.host) && !utils.isString(opts.hostname)) opts.hostname = '::1';
-        // @ts-ignore
-        if (opts.method) opts.method = opts.method.toUpperCase();
-        // @ts-ignore
+        if (!utils.isString(opt.host) && !utils.isString(opt.hostname)) opt.hostname = '::1';
+        opt.method = (opt.method ?? 'get').toUpperCase();
         // follow-redirects does not skip comparison, so it should always succeed for axios -1 unlimited
-        opts.maxBodyLength = opts.maxBodyLength ?? Number.POSITIVE_INFINITY;
-        // @ts-ignore
-        opts.maxRedirects = opts.maxRedirects ?? 21;
-        // @ts-ignore
-        if (opts.maxRedirects === 0) opts.followRedirects = false;
+        opt.maxBodyLength = opt.maxBodyLength ?? Number.POSITIVE_INFINITY;
+        opt.maxRedirects = opt.maxRedirects ?? 21;
+        if (opt.maxRedirects === 0) opt.followRedirects = false;
+        opt.headers = opt.headers ?? {
+            Accept: 'application/json, text/plain, */*',
+            'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36 Edg/107.0.1418.35',
+            'Accept-Encoding': 'gzip, compress, deflate, br'
+        };
         R = {
-            opts,
+            opt,
             cb
         };
     // log({R}, 'init')
@@ -119,20 +120,20 @@ const log = Log({
     maxRedirects: _.maxRedirects,
     maxBodyLength: _.maxBodyLength,
  * @param {string | Opts} uri /options
- * @param {Opts | Cb} [options] /callback
+ * @param {Opts | Cb} [opts] /callback
  * @param {Cb} [callback] /null
  * @returns {Request}
- */ function request(uri, options, callback) {
+ */ function request(uri, opts, callback) {
     let R = null;
     try {
         // @ts-ignore
-        const { opts, cb } = init(uri, options, callback);
+        const { opt, cb } = init(uri, opts, callback);
         // log.error({uri, options, opts}, 'request')
-        const { data, stream } = opts;
+        const { data, stream } = opt;
         // data 在本函数完成处理，不传递到 request
-        opts.data = undefined;
+        opt.data = undefined;
         // @ts-ignore
-        const req = new Request(opts, cb);
+        const req = new Request(opt, cb);
         // 非流模式，自动发送请求，流模式通过流写入发送
         if (!stream) {
             // 发送数据
@@ -168,7 +169,7 @@ const log = Log({
     return R;
 }
 /**
- * 执行简单的数据（支持strean）请求
+ * 执行简单的数据（支持stream）请求
  * 非流模式，直接写入数据流，流模式，由管道触发，或手动调用 end() data.pipe 写入数据
  * 复杂数据，请使用 @wiajs/req库（fork from axios），该库封装了当前库，提供了更多功能
  * organize params for patch, post, put, head, del

package/lib/request.js

@@ -149,7 +149,7 @@ const ConnResetError = utils.createErrorType('ERR_CONNRESET', '连接被重置
         , /** @type {stream.Writable[]} */ this.pipedests = [] // pipe dest
         , /** @type {*} */ this.startTimer = null;
         const m = this;
-        // log({opts}, 'constructor');
+        // log({opts}, 'new Request')
         // Initialize the request
         m.sanitizeOptions(opts);
         m.opt = opts;
@@ -818,8 +818,8 @@ const ConnResetError = utils.createErrorType('ERR_CONNRESET', '连接被重置
    * @override -  重写父类方法
    * @template T - 需要模板
    * @param {T & stream.Writable} dest - The writable stream to which data is written.
-   * @param {Object} [opts] - Optional configuration object.
-   * @param {boolean} [opts.end=true] - Whether to end the writable stream when the readable stream ends.
+   * @param {Object} [opt] - Optional configuration object.
+   * @param {boolean} [opt.end=true] - Whether to end the writable stream when the readable stream ends.
    * @returns {T} The destination stream.
    */ pipe(dest, opts = {}) {
         const m = this;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wiajs/request",
   "description": "Stream HTTP request client.",
   "keywords": ["http", "simple", "util", "utility"],
-  "version": "3.0.31",
+  "version": "3.0.33",
   "type": "module",
   "main": "index.js",
   "types": "types/index.d.ts",

package/types/index.d.ts

@@ -7,6 +7,7 @@ export type Opts = {
     url?: string;
     protocol?: "http:" | "https:";
     host?: string;
+    hostname?: string;
     family?: string;
     path?: string;
     method?: string;
@@ -24,7 +25,7 @@ export type Opts = {
     trackRedirects?: any;
 };
 export type Cb = (res: Response, stream?: stream.Readable) => void;
-declare function request(uri: string | Opts, options?: Opts | Cb, callback?: Cb): Request;
+declare function request(uri: string | Opts, opts?: Opts | Cb, callback?: Cb): Request;
 declare namespace request {
     export let get: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;
     export let head: (url: string | Opts, opts?: Opts | Cb, cb?: Cb) => void;

package/types/request.d.ts

@@ -44,9 +44,7 @@ export default class Request extends stream.Duplex {
     processResponse(response: Response): void;
     _isRedirect: boolean;
     processStream(res: Response): Response | stream.Readable;
-    override pipe<T>(dest: T & stream.Writable, opts?: {
-        end?: boolean;
-    }): T;
+    override pipe<T>(dest: T & stream.Writable, opts?: {}): T;
     unpipe(dest: stream.Writable): this;
     pipeDest(dest: any): void;
     pause(): this;