@ahoo-wang/fetcher 1.5.9 → 1.6.0

package/dist/fetcher.d.ts

@@ -60,21 +60,6 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      * @param options - Configuration options for the Fetcher instance
      */
     constructor(options?: FetcherOptions);
-    /**
-     * Executes an HTTP request with the specified URL and options.
-     *
-     * This is the primary method for making HTTP requests. It processes the request
-     * through the interceptor chain and returns the resulting Response.
-     *
-     * @param url - The URL path for the request (relative to baseURL if set)
-     * @param request - Request configuration including headers, body, parameters, etc.
-     * @param attributes - Optional shared attributes that can be accessed by interceptors
-     *                     throughout the request lifecycle. These attributes allow passing
-     *                     custom data between different interceptors.
-     * @returns Promise that resolves to the HTTP response
-     * @throws FetchError if the request fails and no response is generated
-     */
-    fetch(url: string, request?: FetchRequestInit, attributes?: Record<string, any>): Promise<Response>;
     /**
      * Processes an HTTP request through the Fetcher's internal workflow.
      *
@@ -91,7 +76,25 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      * @returns Promise that resolves to the extracted result based on resultExtractor
      * @throws Error if an unhandled error occurs during request processing
      */
-    request<R = FetchExchange>(request: FetchRequest, resultExtractor?: ResultExtractor<R>, attributes?: Record<string, any>): Promise<R>;
+    request<R = FetchExchange>(request: FetchRequest, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
+    /**
+     * Executes an HTTP request with the specified URL and options.
+     *
+     * This is the primary method for making HTTP requests. It processes the request
+     * through the interceptor chain and returns the resulting Response.
+     *
+     * @param url - The URL path for the request (relative to baseURL if set)
+     * @param request - Request configuration including headers, body, parameters, etc.
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
+     * @param attributes - Optional shared attributes that can be accessed by interceptors
+     *                     throughout the request lifecycle. These attributes allow passing
+     *                     custom data between different interceptors.
+  
+     * @returns Promise that resolves to the HTTP response
+     * @throws FetchError if the request fails and no response is generated
+     */
+    fetch<R = Response>(url: string, request?: FetchRequestInit, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
     /**
      * Internal helper method for making HTTP requests with a specific method.
      *
@@ -101,6 +104,8 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      * @param method - The HTTP method to use for the request
      * @param url - The URL path for the request
      * @param request - Additional request options
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
      * @param attributes - Optional shared attributes that can be accessed by interceptors
      *                     throughout the request lifecycle. These attributes allow passing
      *                     custom data between different interceptors.
@@ -115,12 +120,14 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      *
      * @param url - The URL path for the request
      * @param request - Request options excluding method and body
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
      * @param attributes - Optional shared attributes that can be accessed by interceptors
      *                     throughout the request lifecycle. These attributes allow passing
      *                     custom data between different interceptors.
      * @returns Promise that resolves to the HTTP response
      */
-    get(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>, attributes?: Record<string, any>): Promise<Response>;
+    get<R = Response>(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
     /**
      * Makes a POST HTTP request.
      *
@@ -128,12 +135,14 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      *
      * @param url - The URL path for the request
      * @param request - Request options including body and other parameters
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
      * @param attributes - Optional shared attributes that can be accessed by interceptors
      *                     throughout the request lifecycle. These attributes allow passing
      *                     custom data between different interceptors.
      * @returns Promise that resolves to the HTTP response
      */
-    post(url: string, request?: Omit<FetchRequestInit, 'method'>, attributes?: Record<string, any>): Promise<Response>;
+    post<R = Response>(url: string, request?: Omit<FetchRequestInit, 'method'>, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
     /**
      * Makes a PUT HTTP request.
      *
@@ -141,12 +150,14 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      *
      * @param url - The URL path for the request
      * @param request - Request options including body and other parameters
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
      * @param attributes - Optional shared attributes that can be accessed by interceptors
      *                     throughout the request lifecycle. These attributes allow passing
      *                     custom data between different interceptors.
      * @returns Promise that resolves to the HTTP response
      */
-    put(url: string, request?: Omit<FetchRequestInit, 'method'>, attributes?: Record<string, any>): Promise<Response>;
+    put<R = Response>(url: string, request?: Omit<FetchRequestInit, 'method'>, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
     /**
      * Makes a DELETE HTTP request.
      *
@@ -154,12 +165,14 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      *
      * @param url - The URL path for the request
      * @param request - Request options excluding method and body
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
      * @param attributes - Optional shared attributes that can be accessed by interceptors
      *                     throughout the request lifecycle. These attributes allow passing
      *                     custom data between different interceptors.
      * @returns Promise that resolves to the HTTP response
      */
-    delete(url: string, request?: Omit<FetchRequestInit, 'method'>, attributes?: Record<string, any>): Promise<Response>;
+    delete<R = Response>(url: string, request?: Omit<FetchRequestInit, 'method'>, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
     /**
      * Makes a PATCH HTTP request.
      *
@@ -167,12 +180,14 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      *
      * @param url - The URL path for the request
      * @param request - Request options including body and other parameters
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
      * @param attributes - Optional shared attributes that can be accessed by interceptors
      *                     throughout the request lifecycle. These attributes allow passing
      *                     custom data between different interceptors.
      * @returns Promise that resolves to the HTTP response
      */
-    patch(url: string, request?: Omit<FetchRequestInit, 'method'>, attributes?: Record<string, any>): Promise<Response>;
+    patch<R = Response>(url: string, request?: Omit<FetchRequestInit, 'method'>, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
     /**
      * Makes a HEAD HTTP request.
      *
@@ -181,12 +196,14 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      *
      * @param url - The URL path for the request
      * @param request - Request options excluding method and body
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
      * @param attributes - Optional shared attributes that can be accessed by interceptors
      *                     throughout the request lifecycle. These attributes allow passing
      *                     custom data between different interceptors.
      * @returns Promise that resolves to the HTTP response
      */
-    head(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>, attributes?: Record<string, any>): Promise<Response>;
+    head<R = Response>(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
     /**
      * Makes an OPTIONS HTTP request.
      *
@@ -195,11 +212,13 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
      *
      * @param url - The URL path for the request
      * @param request - Request options excluding method and body
+     * @param resultExtractor - Function to extract the desired result from the exchange.
+     *                          Defaults to ExchangeResultExtractor which returns the entire exchange object.
      * @param attributes - Optional shared attributes that can be accessed by interceptors
      *                     throughout the request lifecycle. These attributes allow passing
      *                     custom data between different interceptors.
      * @returns Promise that resolves to the HTTP response
      */
-    options(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>, attributes?: Record<string, any>): Promise<Response>;
+    options<R = Response>(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>, resultExtractor?: ResultExtractor<any>, attributes?: Record<string, any>): Promise<R>;
 }
 //# sourceMappingURL=fetcher.d.ts.map

package/dist/fetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetcher.d.ts","sourceRoot":"","sources":["../src/fetcher.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACtB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAoB,MAAM,mBAAmB,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,cACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,cAAc;IAChB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC;AAMD,eAAO,MAAM,eAAe,EAAE,cAG7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OACX,YAAW,iBAAiB,EAAE,qBAAqB,EAAE,cAAc;IACnE,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAmB;IACpD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAE1C;;;;;;;OAOG;gBACS,OAAO,GAAE,cAAgC;IAOrD;;;;;;;;;;;;;OAaG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,gBAAqB,EAC9B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC;IAMpB;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CAAC,CAAC,GAAG,aAAa,EAC7B,OAAO,EAAE,YAAY,EAErB,eAAe,GAAE,eAAe,CAAC,CAAC,CAA6B,EAC/D,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAsBb;;;;;;;;;;;;;OAaG;YACW,WAAW;IAgBzB;;;;;;;;;;;;OAYG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,EACvD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;;;OAWG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,EAC9C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;;;OAWG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,EAC9C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;;;OAWG;IACG,MAAM,CACV,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,EAC9C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;;;OAWG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,EAC9C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,EACvD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;;;;OAYG;IACG,OAAO,CACX,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,EACvD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,QAAQ,CAAC;CAGrB"}
+{"version":3,"file":"fetcher.d.ts","sourceRoot":"","sources":["../src/fetcher.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAClE,OAAO,EAAkB,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACtB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAoB,MAAM,mBAAmB,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,cACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,cAAc;IAChB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC;AAMD,eAAO,MAAM,eAAe,EAAE,cAG7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OACX,YAAW,iBAAiB,EAAE,qBAAqB,EAAE,cAAc;IACnE,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAmB;IACpD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAE1C;;;;;;;OAOG;gBACS,OAAO,GAAE,cAAgC;IAOrD;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CAAC,CAAC,GAAG,aAAa,EAC7B,OAAO,EAAE,YAAY,EACrB,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAsBb;;;;;;;;;;;;;;;;OAgBG;IACG,KAAK,CAAC,CAAC,GAAG,QAAQ,EACtB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,gBAAqB,EAC9B,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAOb;;;;;;;;;;;;;;;OAeG;YACW,WAAW;IAkBzB;;;;;;;;;;;;;;OAcG;IACG,GAAG,CAAC,CAAC,GAAG,QAAQ,EACpB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,EACvD,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAIb;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,CAAC,GAAG,QAAQ,EACrB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,EAC9C,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAIb;;;;;;;;;;;;;OAaG;IACG,GAAG,CAAC,CAAC,GAAG,QAAQ,EACpB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,EAC9C,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAIb;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,CAAC,GAAG,QAAQ,EACvB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,EAC9C,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAIb;;;;;;;;;;;;;OAaG;IACG,KAAK,CAAC,CAAC,GAAG,QAAQ,EACtB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,EAC9C,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAIb;;;;;;;;;;;;;;OAcG;IACG,IAAI,CAAC,CAAC,GAAG,QAAQ,EACrB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,EACvD,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;IAIb;;;;;;;;;;;;;;OAcG;IACG,OAAO,CAAC,CAAC,GAAG,QAAQ,EACxB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,EACvD,eAAe,GAAE,eAAe,CAAC,GAAG,CAA6B,EACjE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,CAAC,CAAC;CAGd"}