@ahoo-wang/fetcher 0.8.6 → 0.8.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,14 +1,23 @@
1
1
  import { TimeoutCapable } from './timeout';
2
2
  import { UrlParams } from './urlBuilder';
3
+ /**
4
+ * Interface for objects that can have a base URL
5
+ *
6
+ * This interface defines a baseURL property that can be used to set a base URL
7
+ * for HTTP requests. When the baseURL is empty, it means no base URL is set.
8
+ */
3
9
  export interface BaseURLCapable {
4
10
  /**
5
- * 请求的 baseURL
6
- * 当值为空时,表示不设置 baseURL,默认值为 undefined
11
+ * The base URL for requests
12
+ * When empty, indicates no base URL is set. Default is undefined.
7
13
  */
8
14
  baseURL: string;
9
15
  }
10
16
  /**
11
- * HTTP方法枚举常量
17
+ * HTTP method enumeration constants
18
+ *
19
+ * Defines the standard HTTP methods that can be used for requests.
20
+ * Each method is represented as a string literal type.
12
21
  */
13
22
  export declare enum HttpMethod {
14
23
  GET = "GET",
@@ -24,12 +33,23 @@ export declare enum ContentTypeValues {
24
33
  APPLICATION_JSON = "application/json",
25
34
  TEXT_EVENT_STREAM = "text/event-stream"
26
35
  }
36
+ /**
37
+ * Request headers interface
38
+ *
39
+ * Defines common HTTP headers that can be sent with requests.
40
+ * Allows for additional custom headers through index signature.
41
+ */
27
42
  export interface RequestHeaders {
28
43
  'Content-Type'?: string;
29
- 'Accept'?: string;
30
- 'Authorization'?: string;
44
+ Accept?: string;
45
+ Authorization?: string;
31
46
  [key: string]: string | undefined;
32
47
  }
48
+ /**
49
+ * Interface for objects that can have request headers
50
+ *
51
+ * This interface defines an optional headers property for HTTP requests.
52
+ */
33
53
  export interface RequestHeadersCapable {
34
54
  /**
35
55
  * Request headers
@@ -86,6 +106,12 @@ export interface FetchRequestInit extends TimeoutCapable, RequestHeadersCapable,
86
106
  */
87
107
  body?: BodyInit | Record<string, any> | string | null;
88
108
  }
109
+ /**
110
+ * Fetcher request interface
111
+ *
112
+ * Extends FetchRequestInit with a required URL property.
113
+ * Represents a complete request configuration ready to be executed.
114
+ */
89
115
  export interface FetchRequest extends FetchRequestInit {
90
116
  /**
91
117
  * The URL for this request
@@ -1 +1 @@
1
- {"version":3,"file":"fetchRequest.d.ts","sourceRoot":"","sources":["../src/fetchRequest.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD,oBAAY,iBAAiB;IAC3B,gBAAgB,qBAAqB;IACrC,iBAAiB,sBAAsB;CACxC;AAED,MAAM,WAAW,cAAc;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,gBACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;CACvD;AAED,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb"}
1
+ {"version":3,"file":"fetchRequest.d.ts","sourceRoot":"","sources":["../src/fetchRequest.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD,oBAAY,iBAAiB;IAC3B,gBAAgB,qBAAqB;IACrC,iBAAiB,sBAAsB;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,gBACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ahoo-wang/fetcher",
3
- "version": "0.8.6",
3
+ "version": "0.8.9",
4
4
  "description": "Ultra-lightweight (1.9kB) HTTP client with built-in path parameters and Axios-like API",
5
5
  "keywords": [
6
6
  "fetch",