soon-fetch 2.1.0 → 2.1.1

package/README.md

@@ -121,6 +121,29 @@ soon.get(url, { timeout: 1000 * 20 });
 
 ### API
 
+#### SoonOptions
+
+```ts
+// function fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>
+// RequestInit  is fetch's init options
+type SoonOptions = Omit<RequestInit, "body"> & {
+  query?:
+    | Record<
+        string,
+        | string
+        | number
+        | boolean
+        | null
+        | undefined
+        | (string | number | boolean | null | undefined)[]
+      >
+    | URLSearchParams;
+  params?: Record<string, string | number>;
+  timeout?: number;
+  body?: RequestInit["body"] | object;
+};
+```
+
 #### parseUrlOptions
 
 `parseUrlOptions` source code:
@@ -295,6 +318,28 @@ soon.get(url, { timeout: 1000 * 20 });
 
 ### API
 
+#### SoonOptions
+
+```ts
+// function fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>
+// RequestInit  为原生 fetch 的 init 选项
+type SoonOptions = Omit<RequestInit, "body"> & {
+  query?:
+    | Record<
+        string,
+        | string
+        | number
+        | boolean
+        | null
+        | undefined
+        | (string | number | boolean | null | undefined)[]
+      >
+    | URLSearchParams;
+  params?: Record<string, string | number>;
+  timeout?: number;
+  body?: RequestInit["body"] | object;
+};
+```
 #### parseUrlOptions
 
 `parseUrlOptions` 源码如下:
@@ -307,25 +352,26 @@ function parseUrlOptions<Options extends SoonOptions>(urlOptions: {
   baseOptions?: Options;
 }) {
   const { url, options, baseURL, baseOptions } = urlOptions;
-  //override baseOptions
+  // 覆盖 baseOptions
   const _options = { ...baseOptions, ...options };
 
-  //signal  merge signals by AbortSignal.any
+  // 以 AbortSignal.any 的方式合并 baseOptions.signal 、 options.signal 、
+  // 以及 AbortSignal.timeout( _options.timeout)
   _options.signal = mergeSignals(
     [baseOptions?.signal, options?.signal],
     _options.timeout
   );
 
-  //url  handled with baseURL , options.query , options.params
+  //根据 baseURL , options.query , options.params 解析出完整的url
   const _url = mergeUrl(url, { ..._options, baseURL });
 
-  //body  auto stringify json body
+  // 自动stringify json-object类的body
   let _body = options?.body;
   let is_body_json = isBodyJson(_body);
   _options.body = is_body_json ? JSON.stringify(_body) : _body;
 
-  //headers  merge headers , the same-key header would be override by options.headers
-  //if body is json ,then add header "Content-Type": "application/json" }
+  //合并headers, 相同key值的header会被options.headers覆盖
+  //当body 为 json ,自动添加 header "Content-Type": "application/json" }
   const headers = mergeHeaders(
     baseOptions?.headers,
     options?.headers,

package/dist/index.cjs.js

@@ -1 +1 @@
-"use strict";const t=t=>{const e=[],r=t.match(/:([^:/\d]+)\/?/g);return r&&r.forEach((t=>{e.push(t.replace(/\//g,"").replace(/:/g,""))})),e},e=(t="")=>t.startsWith("http"),r=(t="")=>e(t)?t:((t="")=>{let e=t;return t&&(e=((t="")=>t.endsWith("/")?t.slice(0,-1):t)(e),t.startsWith("/")||(e="/"+e)),e})(t),n=t=>{if(!t)return[];if(t instanceof URLSearchParams||"string"==typeof t||Array.isArray(t))return Array.from(new URLSearchParams(t).entries());const e=[];return Object.keys(t).forEach((r=>{const n=t[r];(Array.isArray(n)?n:[n]).forEach((t=>{e.push([r,t??""])}))})),e},a=(a,o)=>{const{query:s,params:i,baseURL:c}=o;let f=a.trim();t(a).forEach((t=>{i&&(f=f.replace(":"+t,""+i[t]))}));const[p,u]=f.split("?"),h=new URLSearchParams([...n(u),...n(s)]);let l=((t,n)=>{let a=r(t);return e(a)||(a=r(n)+a),a})(p,c);return h.size&&(l=l+"?"+h),l},o=(...t)=>{const e=new Headers;return t.forEach((t=>{t&&new Headers(t).forEach(((t,r)=>{e.set(r,t)}))})),e};function s(t,e){const r=(t??[]).filter((t=>!!t));return e&&r.push(AbortSignal.timeout(e)),r.length?AbortSignal.any(r):void 0}function i(t){return!(!t||"object"!=typeof t||(t instanceof Blob||t instanceof ArrayBuffer||t instanceof FormData||t instanceof File||t instanceof DataView||t instanceof URLSearchParams||t instanceof ReadableStream||(e=t,e instanceof Int8Array||e instanceof Uint8Array||e instanceof Uint8ClampedArray||e instanceof Int16Array||e instanceof Uint16Array||e instanceof Int32Array||e instanceof Uint32Array||e instanceof Float32Array||e instanceof Float64Array||e instanceof BigInt64Array||e instanceof BigUint64Array)));var e}const c=["get","post","put","delete","patch"];function f(t,e){const r={};return t.forEach((t=>{r[t]=(r,n)=>e(r,{...n,method:t})})),r}function p(e){return(r,n)=>{const a={},o=!!t(r).length;return c.forEach((t=>{const s=t.toUpperCase();a[s]=()=>(...a)=>{const[s,i]=a,c="get"===t?"query":"body";return e(r,{...n,method:t,params:o?s:void 0,[c]:o?i:s})}})),a}}exports.createShortAPI=p,exports.createShortMethods=f,exports.createSoon=function(t){const e=t;return{request:e,API:p(e),...f([...c,"head","options"],e)}},exports.isBodyJson=i,exports.mergeHeaders=o,exports.mergeSignals=s,exports.mergeUrl=a,exports.parseUrlOptions=function(t){const{url:e,options:r,baseURL:n,baseOptions:c}=t,f={...c,...r};f.signal=s([c?.signal,r?.signal],f.timeout);const p=a(e,{...f,baseURL:n});let u=r?.body,h=i(u);f.body=h?JSON.stringify(u):u;const l=o(c?.headers,r?.headers,h?{"Content-Type":"application/json"}:void 0);return f.headers=l,[p,f]};
+"use strict";const t=t=>{const r=[],e=t.match(/:([^:/\d]+)\/?/g);return e&&e.forEach((t=>{r.push(t.replace(/\//g,"").replace(/:/g,""))})),r},r=(t="")=>t.endsWith("/")?t.slice(0,-1):t,e=(t="")=>t.startsWith("/")?t:"/"+t,n=(t="")=>t.startsWith("http"),a=t=>{if(!t)return[];if(t instanceof URLSearchParams||"string"==typeof t||Array.isArray(t))return Array.from(new URLSearchParams(t).entries());const r=[];return Object.keys(t).forEach((e=>{const n=t[e];(Array.isArray(n)?n:[n]).forEach((t=>{r.push([e,t??""])}))})),r},o=(o,s)=>{const{query:i,params:c,baseURL:f}=s;let p=o.trim();t(o).forEach((t=>{c&&(p=p.replace(":"+t,""+c[t]))}));const[u,h]=p.split("?"),y=new URLSearchParams([...a(h),...a(i)]);let l=((t,a)=>{if(n(t))return t;const o=n(a)?a:e(a);return r(o)+r(e(t))})(u,f);return y.size&&(l=l+"?"+y),l},s=(...t)=>{const r=new Headers;return t.forEach((t=>{t&&new Headers(t).forEach(((t,e)=>{r.set(e,t)}))})),r};function i(t,r){const e=(t??[]).filter((t=>!!t));return r&&e.push(AbortSignal.timeout(r)),e.length?AbortSignal.any(e):void 0}function c(t){return!(!t||"object"!=typeof t||(t instanceof Blob||t instanceof ArrayBuffer||t instanceof FormData||t instanceof File||t instanceof DataView||t instanceof URLSearchParams||t instanceof ReadableStream||(r=t,r instanceof Int8Array||r instanceof Uint8Array||r instanceof Uint8ClampedArray||r instanceof Int16Array||r instanceof Uint16Array||r instanceof Int32Array||r instanceof Uint32Array||r instanceof Float32Array||r instanceof Float64Array||r instanceof BigInt64Array||r instanceof BigUint64Array)));var r}const f=["get","post","put","delete","patch"];function p(t,r){const e={};return t.forEach((t=>{e[t]=(e,n)=>r(e,{...n,method:t})})),e}function u(r){return(e,n)=>{const a={},o=!!t(e).length;return f.forEach((t=>{const s=t.toUpperCase();a[s]=()=>(...a)=>{const[s,i]=a,c="get"===t?"query":"body";return r(e,{...n,method:t,params:o?s:void 0,[c]:o?i:s})}})),a}}exports.createShortAPI=u,exports.createShortMethods=p,exports.createSoon=function(t){const r=t;return{request:r,API:u(r),...p([...f,"head","options"],r)}},exports.isBodyJson=c,exports.mergeHeaders=s,exports.mergeSignals=i,exports.mergeUrl=o,exports.parseUrlOptions=function(t){const{url:r,options:e,baseURL:n,baseOptions:a}=t,f={...a,...e};f.signal=i([a?.signal,e?.signal],f.timeout);const p=o(r,{...f,baseURL:n});let u=e?.body,h=c(u);f.body=h?JSON.stringify(u):u;const y=s(a?.headers,e?.headers,h?{"Content-Type":"application/json"}:void 0);return f.headers=y,[p,f]};

package/dist/index.d.ts

@@ -1,7 +1,8 @@
-type SoonOptions = RequestInit & {
+type SoonOptions = Omit<RequestInit, "body"> & {
     query?: Record<string, string | number | boolean | null | undefined | (string | number | boolean | null | undefined)[]> | URLSearchParams;
     params?: Record<string, string | number>;
     timeout?: number;
+    body?: RequestInit["body"] | object;
 };
 type GetUrlKey<Url> = Url extends `${string}/:${infer Key}/${infer Right}` ? `${Key}` | GetUrlKey<`/${Right}`> : Url extends `${string}/:${infer Key}` ? `${Key}` : never;
 type OptionParams<Args> = NonNullable<Args> extends never ? [] : keyof NonNullable<Args> extends never ? [] : Exclude<Args, NonNullable<Args>> extends never ? [params: Args] : [params?: Args];
@@ -24,6 +25,7 @@ declare function parseUrlOptions<Options extends SoonOptions>(urlOptions: {
     baseOptions?: Options;
 }): readonly [string, Options & {
     headers: Headers;
+    body?: BodyInit | null;
 }];
 declare function createSoon<T extends (url: string, options?: SoonOptions) => Promise<any>>(requestFun: T): {
     options: T;

package/dist/index.js

@@ -1 +1 @@
-const t=t=>{const n=[],r=t.match(/:([^:/\d]+)\/?/g);return r&&r.forEach((t=>{n.push(t.replace(/\//g,"").replace(/:/g,""))})),n},n=(t="")=>t.startsWith("http"),r=(t="")=>n(t)?t:((t="")=>{let n=t;return t&&(n=((t="")=>t.endsWith("/")?t.slice(0,-1):t)(n),t.startsWith("/")||(n="/"+n)),n})(t),e=t=>{if(!t)return[];if(t instanceof URLSearchParams||"string"==typeof t||Array.isArray(t))return Array.from(new URLSearchParams(t).entries());const n=[];return Object.keys(t).forEach((r=>{const e=t[r];(Array.isArray(e)?e:[e]).forEach((t=>{n.push([r,t??""])}))})),n},a=(a,o)=>{const{query:s,params:i,baseURL:c}=o;let f=a.trim();t(a).forEach((t=>{i&&(f=f.replace(":"+t,""+i[t]))}));const[u,h]=f.split("?"),y=new URLSearchParams([...e(h),...e(s)]);let l=((t,e)=>{let a=r(t);return n(a)||(a=r(e)+a),a})(u,c);return y.size&&(l=l+"?"+y),l},o=(...t)=>{const n=new Headers;return t.forEach((t=>{t&&new Headers(t).forEach(((t,r)=>{n.set(r,t)}))})),n};function s(t,n){const r=(t??[]).filter((t=>!!t));return n&&r.push(AbortSignal.timeout(n)),r.length?AbortSignal.any(r):void 0}function i(t){return!(!t||"object"!=typeof t||(t instanceof Blob||t instanceof ArrayBuffer||t instanceof FormData||t instanceof File||t instanceof DataView||t instanceof URLSearchParams||t instanceof ReadableStream||(n=t,n instanceof Int8Array||n instanceof Uint8Array||n instanceof Uint8ClampedArray||n instanceof Int16Array||n instanceof Uint16Array||n instanceof Int32Array||n instanceof Uint32Array||n instanceof Float32Array||n instanceof Float64Array||n instanceof BigInt64Array||n instanceof BigUint64Array)));var n}function c(t){const{url:n,options:r,baseURL:e,baseOptions:c}=t,f={...c,...r};f.signal=s([c?.signal,r?.signal],f.timeout);const u=a(n,{...f,baseURL:e});let h=r?.body,y=i(h);f.body=y?JSON.stringify(h):h;const l=o(c?.headers,r?.headers,y?{"Content-Type":"application/json"}:void 0);return f.headers=l,[u,f]}const f=["get","post","put","delete","patch"];function u(t){const n=t;return{request:n,API:y(n),...h([...f,"head","options"],n)}}function h(t,n){const r={};return t.forEach((t=>{r[t]=(r,e)=>n(r,{...e,method:t})})),r}function y(n){return(r,e)=>{const a={},o=!!t(r).length;return f.forEach((t=>{const s=t.toUpperCase();a[s]=()=>(...a)=>{const[s,i]=a,c="get"===t?"query":"body";return n(r,{...e,method:t,params:o?s:void 0,[c]:o?i:s})}})),a}}export{y as createShortAPI,h as createShortMethods,u as createSoon,i as isBodyJson,o as mergeHeaders,s as mergeSignals,a as mergeUrl,c as parseUrlOptions};
+const t=t=>{const n=[],r=t.match(/:([^:/\d]+)\/?/g);return r&&r.forEach((t=>{n.push(t.replace(/\//g,"").replace(/:/g,""))})),n},n=(t="")=>t.endsWith("/")?t.slice(0,-1):t,r=(t="")=>t.startsWith("/")?t:"/"+t,e=(t="")=>t.startsWith("http"),a=t=>{if(!t)return[];if(t instanceof URLSearchParams||"string"==typeof t||Array.isArray(t))return Array.from(new URLSearchParams(t).entries());const n=[];return Object.keys(t).forEach((r=>{const e=t[r];(Array.isArray(e)?e:[e]).forEach((t=>{n.push([r,t??""])}))})),n},o=(o,s)=>{const{query:i,params:c,baseURL:f}=s;let u=o.trim();t(o).forEach((t=>{c&&(u=u.replace(":"+t,""+c[t]))}));const[h,y]=u.split("?"),l=new URLSearchParams([...a(y),...a(i)]);let p=((t,a)=>{if(e(t))return t;const o=e(a)?a:r(a);return n(o)+n(r(t))})(h,f);return l.size&&(p=p+"?"+l),p},s=(...t)=>{const n=new Headers;return t.forEach((t=>{t&&new Headers(t).forEach(((t,r)=>{n.set(r,t)}))})),n};function i(t,n){const r=(t??[]).filter((t=>!!t));return n&&r.push(AbortSignal.timeout(n)),r.length?AbortSignal.any(r):void 0}function c(t){return!(!t||"object"!=typeof t||(t instanceof Blob||t instanceof ArrayBuffer||t instanceof FormData||t instanceof File||t instanceof DataView||t instanceof URLSearchParams||t instanceof ReadableStream||(n=t,n instanceof Int8Array||n instanceof Uint8Array||n instanceof Uint8ClampedArray||n instanceof Int16Array||n instanceof Uint16Array||n instanceof Int32Array||n instanceof Uint32Array||n instanceof Float32Array||n instanceof Float64Array||n instanceof BigInt64Array||n instanceof BigUint64Array)));var n}function f(t){const{url:n,options:r,baseURL:e,baseOptions:a}=t,f={...a,...r};f.signal=i([a?.signal,r?.signal],f.timeout);const u=o(n,{...f,baseURL:e});let h=r?.body,y=c(h);f.body=y?JSON.stringify(h):h;const l=s(a?.headers,r?.headers,y?{"Content-Type":"application/json"}:void 0);return f.headers=l,[u,f]}const u=["get","post","put","delete","patch"];function h(t){const n=t;return{request:n,API:l(n),...y([...u,"head","options"],n)}}function y(t,n){const r={};return t.forEach((t=>{r[t]=(r,e)=>n(r,{...e,method:t})})),r}function l(n){return(r,e)=>{const a={},o=!!t(r).length;return u.forEach((t=>{const s=t.toUpperCase();a[s]=()=>(...a)=>{const[s,i]=a,c="get"===t?"query":"body";return n(r,{...e,method:t,params:o?s:void 0,[c]:o?i:s})}})),a}}export{l as createShortAPI,y as createShortMethods,h as createSoon,c as isBodyJson,s as mergeHeaders,i as mergeSignals,o as mergeUrl,f as parseUrlOptions};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "soon-fetch",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "a 3Kb request lib alternative to axios",
   "homepage": "https://github.com/leafio/soon-fetch",
   "main": "./dist/index.cjs.js",