@ahoo-wang/fetcher 0.9.0 → 0.9.1

package/dist/fetchExchange.d.ts

@@ -1,7 +1,7 @@
 import { Fetcher } from './fetcher';
 import { FetchRequest } from './fetchRequest';
 /**
- * FetchExchange
+ * Container for HTTP request/response data that flows through the interceptor chain.
  *
  * Represents the complete exchange object that flows through the interceptor chain.
  * This object contains all the information about a request, response, and any errors
@@ -43,7 +43,7 @@ import { FetchRequest } from './fetchRequest';
  */
 export declare class FetchExchange {
     /**
-     * The Fetcher instance that initiated this exchange
+     * The Fetcher instance that initiated this exchange.
      */
     fetcher: Fetcher;
     /**
@@ -51,15 +51,15 @@ export declare class FetchExchange {
      */
     request: FetchRequest;
     /**
-     * The response object, undefined until the request completes successfully
+     * The response object, undefined until the request completes successfully.
      */
     response: Response | undefined;
     /**
-     * Any error that occurred during the request processing, undefined if no error occurred
+     * Any error that occurred during the request processing, undefined if no error occurred.
      */
     error: Error | any | undefined;
     /**
-     * Shared attributes for passing data between interceptors
+     * Shared attributes for passing data between interceptors.
      *
      * This property allows interceptors to share arbitrary data with each other.
      * Interceptors can read from and write to this object to pass information
@@ -75,13 +75,13 @@ export declare class FetchExchange {
     attributes: Record<string, any>;
     constructor(fetcher: Fetcher, request: FetchRequest, response?: Response, error?: Error | any);
     /**
-     * Checks if the exchange has an error
+     * Checks if the exchange has an error.
      *
      * @returns true if an error is present, false otherwise
      */
     hasError(): boolean;
     /**
-     * Checks if the exchange has a response
+     * Checks if the exchange has a response.
      *
      * @returns true if a response is present, false otherwise
      */

package/dist/fetchInterceptor.d.ts

@@ -1,7 +1,7 @@
 import { Interceptor } from './interceptor';
 import { FetchExchange } from './fetchExchange';
 /**
- * FetchInterceptor Class
+ * Interceptor implementation responsible for executing actual HTTP requests.
  *
  * This is an interceptor implementation responsible for executing actual HTTP requests
  * and handling timeout control. It is the last interceptor in the Fetcher request
@@ -15,17 +15,15 @@ import { FetchExchange } from './fetchExchange';
  */
 export declare class FetchInterceptor implements Interceptor {
     /**
-     * Interceptor name, used to identify and manage interceptor instances
+     * Interceptor name, used to identify and manage interceptor instances.
      *
-     * @remarks
      * Each interceptor must have a unique name for identification and manipulation
-     * within the interceptor manager
+     * within the interceptor manager.
      */
     name: string;
     /**
-     * Interceptor execution order, set to near maximum safe integer to ensure last execution
+     * Interceptor execution order, set to near maximum safe integer to ensure last execution.
      *
-     * @remarks
      * Since this is the interceptor that actually executes HTTP requests, it should
      * execute after all other request interceptors, so its order is set to
      * Number.MAX_SAFE_INTEGER - 100. This ensures that all request preprocessing is
@@ -34,7 +32,7 @@ export declare class FetchInterceptor implements Interceptor {
      */
     order: number;
     /**
-     * Intercept and process HTTP requests
+     * Intercept and process HTTP requests.
      *
      * Executes the actual HTTP request and applies timeout control. This is the final
      * step in the request processing chain, responsible for calling the timeoutFetch
@@ -46,15 +44,17 @@ export declare class FetchInterceptor implements Interceptor {
      *
      * @example
      * // Usually called internally by Fetcher
-     * const exchange = {
-     *   url: 'https://api.example.com/users',
-     *   request: {
+     * const fetcher = new Fetcher();
+     * const exchange = new FetchExchange(
+     *   fetcher,
+     *   {
+     *     url: 'https://api.example.com/users',
      *     method: 'GET',
      *     timeout: 5000
      *   }
-     * };
-     * const result = await fetchInterceptor.intercept(exchange);
-     * console.log(result.response); // HTTP response object
+     * );
+     * await fetchInterceptor.intercept(exchange);
+     * console.log(exchange.response); // HTTP response object
      */
     intercept(exchange: FetchExchange): Promise<void>;
 }

package/dist/fetchInterceptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchInterceptor.d.ts","sourceRoot":"","sources":["../src/fetchInterceptor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;GAYG;AACH,qBAAa,gBAAiB,YAAW,WAAW;IAClD;;;;;;OAMG;IACH,IAAI,SAAsB;IAE1B;;;;;;;;;OASG;IACH,KAAK,SAAiC;IAEtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,SAAS,CAAC,QAAQ,EAAE,aAAa;CAGxC"}
+{"version":3,"file":"fetchInterceptor.d.ts","sourceRoot":"","sources":["../src/fetchInterceptor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;GAYG;AACH,qBAAa,gBAAiB,YAAW,WAAW;IAClD;;;;;OAKG;IACH,IAAI,SAAsB;IAE1B;;;;;;;;OAQG;IACH,KAAK,SAAiC;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,SAAS,CAAC,QAAQ,EAAE,aAAa;CAGxC"}

package/dist/fetcher.d.ts

@@ -4,7 +4,10 @@ import { FetcherInterceptors } from './interceptor';
 import { FetchExchange } from './fetchExchange';
 import { BaseURLCapable, FetchRequest, FetchRequestInit, RequestHeaders, RequestHeadersCapable } from './fetchRequest';
 /**
- * Fetcher configuration options interface
+ * Configuration options for the Fetcher client.
+ *
+ * Defines the customizable aspects of a Fetcher instance including base URL,
+ * default headers, timeout settings, and interceptors.
  *
  * @example
  * ```typescript
@@ -21,7 +24,11 @@ export interface FetcherOptions extends BaseURLCapable, RequestHeadersCapable, T
 }
 export declare const DEFAULT_OPTIONS: FetcherOptions;
 /**
- * HTTP client class that supports URL building, timeout control, and more
+ * HTTP client with support for interceptors, URL building, and timeout control.
+ *
+ * The Fetcher class provides a flexible and extensible HTTP client implementation
+ * that follows the interceptor pattern. It supports URL parameter interpolation,
+ * request/response transformation, and timeout handling.
  *
  * @example
  * ```typescript
@@ -41,108 +48,138 @@ export declare class Fetcher implements UrlBuilderCapable, RequestHeadersCapable
     timeout?: number;
     interceptors: FetcherInterceptors;
     /**
-     * Create a Fetcher instance
+     * Initializes a new Fetcher instance with optional configuration.
+     *
+     * Creates a Fetcher with default settings that can be overridden through the options parameter.
+     * If no interceptors are provided, a default set of interceptors will be used.
      *
-     * @param options - Fetcher configuration options
+     * @param options - Configuration options for the Fetcher instance
      */
     constructor(options?: FetcherOptions);
     /**
-     * Make an HTTP request
+     * Executes an HTTP request with the specified URL and options.
      *
-     * @param url - Request URL path
-     * @param request - Request options, including path parameters, query parameters, etc.
-     * @returns Promise<Response> HTTP response
+     * 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.
+     * @returns Promise that resolves to the HTTP response
+     * @throws Error if the request fails and no response is generated
      */
     fetch(url: string, request?: FetchRequestInit): Promise<Response>;
     /**
-     * Send an HTTP request
+     * Processes an HTTP request through the Fetcher's internal workflow.
      *
-     * @param request - Request configuration object, including url, method, headers, body, etc.
-     * @returns Promise that resolves to a FetchExchange object containing request and response information
+     * This method prepares the request by merging headers and timeout settings,
+     * creates a FetchExchange object, and passes it through the exchange method
+     * for interceptor processing.
      *
-     * @throws Throws an exception when an error occurs during the request and is not handled by error interceptors
+     * @param request - Complete request configuration object
+     * @returns Promise that resolves to a FetchExchange containing request/response data
+     * @throws Error if an unhandled error occurs during request processing
      */
     request(request: FetchRequest): Promise<FetchExchange>;
     /**
-     * Process a fetch exchange through the interceptor chain
+     * Processes a FetchExchange through the interceptor chain.
      *
-     * This method orchestrates the complete request lifecycle by applying interceptors
-     * in the following order:
-     * 1. Request interceptors - to modify the outgoing request
-     * 2. Response interceptors - to process the incoming response
+     * Orchestrates the complete request lifecycle by applying interceptors in sequence:
+     * 1. Request interceptors - Modify the outgoing request
+     * 2. Response interceptors - Process the incoming response
      *
-     * If any error occurs during the process, error interceptors are applied to handle it.
-     * If an error interceptor produces a response, that response is returned. Otherwise,
-     * the original error is re-thrown.
+     * Error handling follows this flow:
+     * - If an error occurs, error interceptors are invoked
+     * - If an error interceptor produces a response, it's returned
+     * - Otherwise, the original error is re-thrown
      *
-     * @param fetchExchange - The exchange object containing request, response, and metadata
-     * @returns Promise<FetchExchange> The processed exchange with final response or error
-     * @throws Error if an error occurs and is not handled by error interceptors
+     * @param fetchExchange - The exchange object containing request and response data
+     * @returns Promise resolving to the processed exchange
+     * @throws Error if an unhandled error occurs during processing
      */
     exchange(fetchExchange: FetchExchange): Promise<FetchExchange>;
     /**
-     * Make an HTTP request with the specified method
+     * Internal helper method for making HTTP requests with a specific method.
+     *
+     * This private method is used by the public HTTP method methods (get, post, etc.)
+     * to execute requests with the appropriate HTTP verb.
      *
-     * @param method - HTTP method to use
-     * @param url - Request URL path
-     * @param request - Request options
-     * @returns Promise<Response> HTTP response
+     * @param method - The HTTP method to use for the request
+     * @param url - The URL path for the request
+     * @param request - Additional request options
+     * @returns Promise that resolves to the HTTP response
      */
     private methodFetch;
     /**
-     * Make a GET request
+     * Makes a GET HTTP request.
+     *
+     * Convenience method for making GET requests. The request body is omitted
+     * as GET requests should not contain a body according to HTTP specification.
      *
-     * @param url - Request URL path
-     * @param request - Request options, including path parameters, query parameters, etc.
-     * @returns Promise<Response> HTTP response
+     * @param url - The URL path for the request
+     * @param request - Request options excluding method and body
+     * @returns Promise that resolves to the HTTP response
      */
     get(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>): Promise<Response>;
     /**
-     * Make a POST request
+     * Makes a POST HTTP request.
      *
-     * @param url - Request URL path
-     * @param request - Request options, including path parameters, query parameters, request body, etc.
-     * @returns Promise<Response> HTTP response
+     * Convenience method for making POST requests, commonly used for creating resources.
+     *
+     * @param url - The URL path for the request
+     * @param request - Request options including body and other parameters
+     * @returns Promise that resolves to the HTTP response
      */
     post(url: string, request?: Omit<FetchRequestInit, 'method'>): Promise<Response>;
     /**
-     * Make a PUT request
+     * Makes a PUT HTTP request.
+     *
+     * Convenience method for making PUT requests, commonly used for updating resources.
      *
-     * @param url - Request URL path
-     * @param request - Request options, including path parameters, query parameters, request body, etc.
-     * @returns Promise<Response> HTTP response
+     * @param url - The URL path for the request
+     * @param request - Request options including body and other parameters
+     * @returns Promise that resolves to the HTTP response
      */
     put(url: string, request?: Omit<FetchRequestInit, 'method'>): Promise<Response>;
     /**
-     * Make a DELETE request
+     * Makes a DELETE HTTP request.
+     *
+     * Convenience method for making DELETE requests, commonly used for deleting resources.
      *
-     * @param url - Request URL path
-     * @param request - Request options, including path parameters, query parameters, etc.
-     * @returns Promise<Response> HTTP response
+     * @param url - The URL path for the request
+     * @param request - Request options excluding method and body
+     * @returns Promise that resolves to the HTTP response
      */
     delete(url: string, request?: Omit<FetchRequestInit, 'method'>): Promise<Response>;
     /**
-     * Make a PATCH request
+     * Makes a PATCH HTTP request.
      *
-     * @param url - Request URL path
-     * @param request - Request options, including path parameters, query parameters, request body, etc.
-     * @returns Promise<Response> HTTP response
+     * Convenience method for making PATCH requests, commonly used for partial updates.
+     *
+     * @param url - The URL path for the request
+     * @param request - Request options including body and other parameters
+     * @returns Promise that resolves to the HTTP response
      */
     patch(url: string, request?: Omit<FetchRequestInit, 'method'>): Promise<Response>;
     /**
-     * Make a HEAD request
+     * Makes a HEAD HTTP request.
+     *
+     * Convenience method for making HEAD requests, which retrieve headers only.
+     * The request body is omitted as HEAD requests should not contain a body.
      *
-     * @param url - Request URL path
-     * @param request - Request options, including path parameters, query parameters, etc.
-     * @returns Promise<Response> HTTP response
+     * @param url - The URL path for the request
+     * @param request - Request options excluding method and body
+     * @returns Promise that resolves to the HTTP response
      */
     head(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>): Promise<Response>;
     /**
-     * Make an OPTIONS request
+     * Makes an OPTIONS HTTP request.
+     *
+     * Convenience method for making OPTIONS requests, commonly used for CORS preflight.
+     * The request body is omitted as OPTIONS requests typically don't contain a body.
      *
-     * @param url - Request URL path
-     * @param request - Request options, including path parameters, query parameters, etc.
-     * @returns Promise<Response> HTTP response
+     * @param url - The URL path for the request
+     * @param request - Request options excluding method and body
+     * @returns Promise that resolves to the HTTP response
      */
     options(url: string, request?: Omit<FetchRequestInit, 'method' | 'body'>): Promise<Response>;
 }

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,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAkB,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACL,cAAc,EAEd,YAAY,EACZ,gBAAgB,EAEhB,cAAc,EACd,qBAAqB,EACtB,MAAM,gBAAgB,CAAC;AAGxB;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,cACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,cAAc;IAChB,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC;AAMD,eAAO,MAAM,eAAe,EAAE,cAG7B,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,OACX,YAAW,iBAAiB,EAAE,qBAAqB,EAAE,cAAc;IACnE,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,cAAc,CAAmB;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,mBAAmB,CAAC;IAElC;;;;OAIG;gBACS,OAAO,GAAE,cAAgC;IAOrD;;;;;;OAMG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAU3E;;;;;;;OAOG;IACG,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAa5D;;;;;;;;;;;;;;;OAeG;IACG,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAkBpE;;;;;;;OAOG;YACW,WAAW;IAWzB;;;;;;OAMG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,MAAM,CACV,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,OAAO,CACX,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;CAGrB"}
+{"version":3,"file":"fetcher.d.ts","sourceRoot":"","sources":["../src/fetcher.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAkB,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EACL,cAAc,EAEd,YAAY,EACZ,gBAAgB,EAEhB,cAAc,EACd,qBAAqB,EACtB,MAAM,gBAAgB,CAAC;AAGxB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,cACf,SAAQ,cAAc,EACpB,qBAAqB,EACrB,cAAc;IAChB,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACpC;AAMD,eAAO,MAAM,eAAe,EAAE,cAG7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OACX,YAAW,iBAAiB,EAAE,qBAAqB,EAAE,cAAc;IAEnE,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,CAAC,EAAE,cAAc,CAAmB;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,mBAAmB,CAAC;IAElC;;;;;;;OAOG;gBACS,OAAO,GAAE,cAAgC;IAOrD;;;;;;;;;;OAUG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAU3E;;;;;;;;;;OAUG;IACG,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAa5D;;;;;;;;;;;;;;;OAeG;IACG,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAkBpE;;;;;;;;;;OAUG;YACW,WAAW;IAWzB;;;;;;;;;OASG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,GAAG,CACP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,MAAM,CACV,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;OAQG;IACG,KAAK,CACT,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,GAC7C,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;OASG;IACG,IAAI,CACR,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;;;;OASG;IACG,OAAO,CACX,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,MAAM,CAAM,GACtD,OAAO,CAAC,QAAQ,CAAC;CAGrB"}