@d1g1tal/transportr 2.2.0 → 3.0.0

package/dist/transportr.d.ts

@@ -43,10 +43,143 @@ declare class ResponseStatus {
     toString(): string;
 }
 
+type Function<P = any, R = unknown> = (...args: P[]) => R;
+type JsonPrimitive = string | number | boolean | null;
+type JsonArray<T = any> = T extends any ? Array<JsonValue<T>> : never;
+type JsonObject<T = any> = T extends any ? {
+    [K in keyof T as JsonValue<T[K]> extends never ? never : K]: JsonValue<T[K]>;
+} : Record<string, any>;
+type JsonValue<T = any> = T extends JsonPrimitive ? T : T extends {
+    toJSON: () => infer R;
+} ? R : T extends Function | undefined ? never : T extends Array<infer U> ? JsonArray<U> : T extends Record<string, any> ? JsonObject<T> : Json;
+type Json = JsonPrimitive | JsonObject | JsonArray;
+type JsonString<T = unknown> = string & {
+    source: T;
+};
+/** The expected response body types returned from a fetch handler. */
+type ResponseBody = Json | Document | DocumentFragment | HTMLImageElement | Blob | ArrayBuffer | FormData | string | ReadableStream<Uint8Array> | void | null;
+/** A parsed Server-Sent Event per the EventStream specification. */
+type ServerSentEvent = {
+    /** The event type (defaults to 'message'). */
+    event: string;
+    /** The event data payload. */
+    data: string;
+    /** The last event ID string, if provided by the server. */
+    id: string;
+    /** Reconnection time in milliseconds, if provided by the server. */
+    retry: number | undefined;
+};
+/** Progress information for download/upload tracking. */
+type DownloadProgress = {
+    /** Number of bytes transferred so far. */
+    loaded: number;
+    /** Total number of bytes, or null if unknown (no Content-Length). */
+    total: number | null;
+    /** Percentage complete (0–100), or null if total is unknown. */
+    percentage: number | null;
+};
+/** Result tuple for error-as-value handling. Success: [true, data]. Error: [false, E]. */
+type Result<T, E = Error> = [true, T] | [false, E];
+/** Retry event information emitted during retry attempts. */
+type RetryInfo = {
+    /** Current retry attempt number (1-based). */
+    attempt: number;
+    /** HTTP status code that triggered the retry, if available. */
+    status?: number;
+    /** Error message that triggered the retry, if available. */
+    error?: string;
+    /** The HTTP method of the request. */
+    method: string;
+    /** The request path. */
+    path: string | undefined;
+    /** Timing information at the point of retry. */
+    timing: RequestTiming;
+};
+/** Timing information for a request lifecycle. */
+type RequestTiming = {
+    /** Timestamp when the request started (ms since epoch). */
+    start: number;
+    /** Timestamp when the response was received (ms since epoch). */
+    end: number;
+    /** Total duration in milliseconds. */
+    duration: number;
+};
+/** Options for constructing an {@link HttpError}. */
+type HttpErrorOptions = {
+    message?: string;
+    cause?: Error;
+    entity?: ResponseBody;
+    /** The request URL. */
+    url?: URL;
+    /** The HTTP method used. */
+    method?: string;
+    /** Request timing information. */
+    timing?: RequestTiming;
+};
+
+/**
+ * An error that represents an HTTP error response.
+ * @author D1g1talEntr0py <jason.dimeo@gmail.com>
+ */
+declare class HttpError extends Error {
+    private readonly _entity;
+    private readonly responseStatus;
+    private readonly _url;
+    private readonly _method;
+    private readonly _timing;
+    /**
+     * Creates an instance of HttpError.
+     * @param status The status code and status text of the {@link Response}.
+     * @param httpErrorOptions The http error options.
+     */
+    constructor(status: ResponseStatus, { message, cause, entity, url, method, timing }?: HttpErrorOptions);
+    /**
+     * It returns the value of the private variable #entity.
+     * @returns The entity property of the class.
+     */
+    get entity(): ResponseBody;
+    /**
+     * It returns the status code of the {@link Response}.
+     * @returns The status code of the {@link Response}.
+     */
+    get statusCode(): number;
+    /**
+     * It returns the status text of the {@link Response}.
+     * @returns The status code and status text of the {@link Response}.
+     */
+    get statusText(): string;
+    /**
+     * The request URL that caused the error.
+     * @returns The URL or undefined.
+     */
+    get url(): URL | undefined;
+    /**
+     * The HTTP method that was used for the failed request.
+     * @returns The method string or undefined.
+     */
+    get method(): string | undefined;
+    /**
+     * Timing information for the failed request.
+     * @returns The timing object or undefined.
+     */
+    get timing(): RequestTiming | undefined;
+    /**
+     * A String value representing the name of the error.
+     * @returns The name of the error.
+     */
+    get name(): string;
+    /**
+     * A String value that is used in the creation of the default string
+     * description of an object. Called by the built-in method {@link Object.prototype.toString}.
+     * @returns The default string description of this object.
+     */
+    get [Symbol.toStringTag](): string;
+}
+
 /**
  * Defining a constant object with all the HTTP request headers.
  */
-declare const HttpRequestHeader: {
+declare const RequestHeader: {
     /**
      * Content-Types that are acceptable for the response. See Content negotiation. Permanent.
      *
@@ -295,7 +428,7 @@ declare const HttpRequestHeader: {
  * A collection of some of the available HTTP media types.
  * @see {@link https://www.iana.org/assignments/media-types/media-types.xhtml | IANA Media Types}
  */
-declare const HttpMediaType: {
+declare const ContentType: {
     /** Advanced Audio Coding (AAC) */
     readonly AAC: "audio/aac";
     /** AbiWord */
@@ -450,102 +583,6 @@ declare const HttpMediaType: {
     readonly '7Z': "application/x-7z-compressed";
 };
 
-type Function<P = any, R = unknown> = (...args: P[]) => R;
-type JsonPrimitive = string | number | boolean | null;
-type JsonArray<T = any> = T extends any ? Array<JsonValue<T>> : never;
-type JsonObject<T = any> = T extends any ? {
-    [K in keyof T as JsonValue<T[K]> extends never ? never : K]: JsonValue<T[K]>;
-} : Record<string, any>;
-type JsonValue<T = any> = T extends JsonPrimitive ? T : T extends {
-    toJSON: () => infer R;
-} ? R : T extends Function | undefined ? never : T extends Array<infer U> ? JsonArray<U> : T extends Record<string, any> ? JsonObject<T> : Json;
-type Json = JsonPrimitive | JsonObject | JsonArray;
-type JsonString<T = unknown> = string & {
-    source: T;
-};
-/** The expected response body types returned from a fetch handler. */
-type ResponseBody = Json | Document | DocumentFragment | HTMLImageElement | Blob | ArrayBuffer | FormData | string | ReadableStream<Uint8Array> | void | null;
-/** Timing information for a request lifecycle. */
-type RequestTiming = {
-    /** Timestamp when the request started (ms since epoch). */
-    start: number;
-    /** Timestamp when the response was received (ms since epoch). */
-    end: number;
-    /** Total duration in milliseconds. */
-    duration: number;
-};
-/** Options for constructing an {@link HttpError}. */
-type HttpErrorOptions = {
-    message?: string;
-    cause?: Error;
-    entity?: ResponseBody;
-    /** The request URL. */
-    url?: URL;
-    /** The HTTP method used. */
-    method?: string;
-    /** Request timing information. */
-    timing?: RequestTiming;
-};
-
-/**
- * An error that represents an HTTP error response.
- * @author D1g1talEntr0py <jason.dimeo@gmail.com>
- */
-declare class HttpError extends Error {
-    private readonly _entity;
-    private readonly responseStatus;
-    private readonly _url;
-    private readonly _method;
-    private readonly _timing;
-    /**
-     * Creates an instance of HttpError.
-     * @param status The status code and status text of the {@link Response}.
-     * @param httpErrorOptions The http error options.
-     */
-    constructor(status: ResponseStatus, { message, cause, entity, url, method, timing }?: HttpErrorOptions);
-    /**
-     * It returns the value of the private variable #entity.
-     * @returns The entity property of the class.
-     */
-    get entity(): ResponseBody;
-    /**
-     * It returns the status code of the {@link Response}.
-     * @returns The status code of the {@link Response}.
-     */
-    get statusCode(): number;
-    /**
-     * It returns the status text of the {@link Response}.
-     * @returns The status code and status text of the {@link Response}.
-     */
-    get statusText(): string;
-    /**
-     * The request URL that caused the error.
-     * @returns The URL or undefined.
-     */
-    get url(): URL | undefined;
-    /**
-     * The HTTP method that was used for the failed request.
-     * @returns The method string or undefined.
-     */
-    get method(): string | undefined;
-    /**
-     * Timing information for the failed request.
-     * @returns The timing object or undefined.
-     */
-    get timing(): RequestTiming | undefined;
-    /**
-     * A String value representing the name of the error.
-     * @returns The name of the error.
-     */
-    get name(): string;
-    /**
-     * A String value that is used in the creation of the default string
-     * description of an object. Called by the built-in method {@link Object.prototype.toString}.
-     * @returns The default string description of this object.
-     */
-    get [Symbol.toStringTag](): string;
-}
-
 type Prettify<T> = T extends infer U ? {
     [K in keyof U]: U[K];
 } : never;
@@ -559,7 +596,7 @@ type RequestMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPT
 type RequestBodyMethod = Extract<RequestMethod, 'POST' | 'PUT' | 'PATCH' | 'DELETE'>;
 type RequestNoBodyMethod = Exclude<RequestMethod, RequestBodyMethod>;
 type RequestHeaders = Prettify<TypedHeaders & {
-    [K in Exclude<typeof HttpRequestHeader[keyof typeof HttpRequestHeader], keyof TypedHeaders>]?: string;
+    [K in Exclude<typeof RequestHeader[keyof typeof RequestHeader], keyof TypedHeaders>]?: string;
 } & HeadersInit>;
 type SearchParameters = URLSearchParams | string | string[][] | Record<string, string | number | boolean>;
 type AuthorizationScheme = 'Basic' | 'Bearer' | 'Digest' | 'HOBA' | 'Mutual' | 'Negotiate' | 'OAuth' | 'SCRAM-SHA-1' | 'SCRAM-SHA-256' | 'vapid';
@@ -582,11 +619,11 @@ type AbortConfiguration = {
     signal?: AbortSignal | null;
     timeout?: number;
 };
-type MediaTypeValues = LiteralUnion<typeof HttpMediaType[keyof typeof HttpMediaType]>;
+type MediaTypeValues = LiteralUnion<typeof ContentType[keyof typeof ContentType]>;
 type TypedHeaders = {
-    [HttpRequestHeader.AUTHORIZATION]?: `${AuthorizationScheme} ${string}` | AuthorizationScheme;
-    [HttpRequestHeader.ACCEPT]?: MediaTypeValues;
-    [HttpRequestHeader.CONTENT_TYPE]?: MediaTypeValues;
+    [RequestHeader.AUTHORIZATION]?: `${AuthorizationScheme} ${string}` | AuthorizationScheme;
+    [RequestHeader.ACCEPT]?: MediaTypeValues;
+    [RequestHeader.CONTENT_TYPE]?: MediaTypeValues;
 };
 type EventRegistration = Subscription;
 type MethodBody = {
@@ -610,6 +647,12 @@ type RequestOptions = Prettify<{
     dedupe?: boolean;
     /** XSRF/CSRF protection. When set (or true), reads a cookie and sets a request header. */
     xsrf?: boolean | XsrfOptions;
+    /** Callback invoked with download progress information. Only works when the response has a body stream. */
+    onDownloadProgress?: (progress: DownloadProgress) => void;
+    /** Callback invoked with upload progress as the request body is sent. Requires ReadableStream request body support. */
+    onUploadProgress?: (progress: DownloadProgress) => void;
+    /** When false, methods return Result tuples instead of throwing. Defaults to true (throw on error). */
+    unwrap?: boolean;
 } & Omit<RequestInit, 'headers'> & MethodBody>;
 /** Configuration for retry behavior on failed requests. */
 type RetryOptions = {
@@ -645,6 +688,21 @@ type HookOptions = {
 };
 /** Fully resolved retry configuration with all defaults applied. */
 type NormalizedRetryOptions = Required<RetryOptions>;
+/** Maps request event names to their typed data payloads. */
+type RequestEventDataMap = {
+    configured: RequestOptions;
+    success: ResponseBody;
+    error: HttpError;
+    aborted: undefined;
+    timeout: undefined;
+    retry: RetryInfo;
+    complete: {
+        timing: RequestTiming;
+    };
+    'all-complete': undefined;
+};
+/** A typed event handler where the data parameter matches the event name. */
+type TypedRequestEventHandler<E extends keyof RequestEventDataMap> = (event: Event, data: RequestEventDataMap[E]) => void;
 /** Options for the internal publish helper. */
 type PublishOptions = {
     name: string;
@@ -658,11 +716,12 @@ declare const endsWithSlashRegEx: RegExp;
 declare const XSRF_COOKIE_NAME = "XSRF-TOKEN";
 /** Default XSRF header name */
 declare const XSRF_HEADER_NAME = "X-XSRF-TOKEN";
-type MediaTypeKey = 'PNG' | 'TEXT' | 'JSON' | 'HTML' | 'JAVA_SCRIPT' | 'CSS' | 'XML' | 'BIN';
+type MediaTypeKey = 'PNG' | 'TEXT' | 'JSON' | 'HTML' | 'JAVA_SCRIPT' | 'CSS' | 'XML' | 'BIN' | 'EVENT_STREAM' | 'NDJSON';
 declare const mediaTypes: {
     [key in MediaTypeKey]: MediaType;
 };
 declare const defaultMediaType: string;
+declare const defaultOrigin: string;
 /** Constant object for caching policies */
 declare const RequestCachingPolicy: {
     readonly DEFAULT: "default";
@@ -753,26 +812,26 @@ declare class Transportr {
         readonly OMIT: "omit";
         readonly SAME_ORIGIN: "same-origin";
     };
-    /** Request Modes */
-    static readonly RequestModes: {
+    /** Request Mode */
+    static readonly RequestMode: {
         readonly CORS: "cors";
         readonly NAVIGATE: "navigate";
         readonly NO_CORS: "no-cors";
         readonly SAME_ORIGIN: "same-origin";
     };
-    /** Request Priorities */
-    static readonly RequestPriorities: {
+    /** Request Priority */
+    static readonly RequestPriority: {
         readonly HIGH: "high";
         readonly LOW: "low";
         readonly AUTO: "auto";
     };
-    /** Redirect Policies */
-    static readonly RedirectPolicies: {
+    /** Redirect Policy */
+    static readonly RedirectPolicy: {
         readonly ERROR: "error";
         readonly FOLLOW: "follow";
         readonly MANUAL: "manual";
     };
-    /** Referrer Policies */
+    /** Referrer Policy */
     static readonly ReferrerPolicy: {
         readonly NO_REFERRER: "no-referrer";
         readonly NO_REFERRER_WHEN_DOWNGRADE: "no-referrer-when-downgrade";
@@ -783,19 +842,19 @@ declare class Transportr {
         readonly STRICT_ORIGIN_WHEN_CROSS_ORIGIN: "strict-origin-when-cross-origin";
         readonly UNSAFE_URL: "unsafe-url";
     };
-    /** Request Events	*/
-    static readonly RequestEvents: typeof RequestEvent;
+    /** Request Event */
+    static readonly RequestEvent: typeof RequestEvent;
     /** Default Request Options */
     private static readonly defaultRequestOptions;
     /**
-     * Returns a {@link EventRegistration} used for subscribing to global events.
+     * Returns a {@link EventRegistration} used for subscribing to global events with typed data.
      *
      * @param event The event to subscribe to.
-     * @param handler The event handler.
+     * @param handler The event handler with typed data parameter.
      * @param context The context to bind the handler to.
      * @returns A new {@link EventRegistration} instance.
      */
-    static register(event: RequestEvent, handler: RequestEventHandler, context?: unknown): EventRegistration;
+    static register<E extends keyof RequestEventDataMap>(event: E, handler: TypedRequestEventHandler<E>, context?: unknown): EventRegistration;
     /**
      * Removes a {@link EventRegistration} from the global event handler.
      *
@@ -809,6 +868,29 @@ declare class Transportr {
      * This will also clear the {@link Transportr#signalControllers} set.
      */
     static abortAll(): void;
+    /**
+     * Executes multiple requests concurrently and resolves when all complete.
+     * @param requests An array of promises from Transportr request methods.
+     * @returns A promise resolving to an array of all results.
+     */
+    static all<T extends readonly Promise<unknown>[]>(requests: T): Promise<{
+        -readonly [K in keyof T]: Awaited<T[K]>;
+    }>;
+    /**
+     * Races multiple requests concurrently. The first to settle wins; all others are aborted.
+     * Each factory receives an AbortSignal that the caller should pass to the request options.
+     * @template T The expected result type.
+     * @param requests An array of functions that accept an AbortSignal and return a promise.
+     * @returns A promise resolving to the first settled result.
+     * @example
+     * ```typescript
+     * const result = await Transportr.race([
+     *   (signal) => api.getJson('/primary', { signal }),
+     *   (signal) => api.getJson('/fallback', { signal })
+     * ]);
+     * ```
+     */
+    static race<T>(requests: ReadonlyArray<(signal: AbortSignal) => Promise<T>>): Promise<T>;
     /**
      * Registers a custom content-type response handler.
      * The handler will be matched against response content-type headers using MediaType matching.
@@ -848,14 +930,14 @@ declare class Transportr {
      */
     get baseUrl(): URL;
     /**
-     * Registers an event handler with a {@link Transportr} instance.
+     * Registers an event handler with a {@link Transportr} instance with typed data.
      *
      * @param event The name of the event to listen for.
      * @param handler The function to call when the event is triggered.
      * @param context The context to bind to the handler.
      * @returns An object that can be used to remove the event handler.
      */
-    register(event: RequestEvent, handler: RequestEventHandler, context?: unknown): EventRegistration;
+    register<E extends keyof RequestEventDataMap>(event: E, handler: TypedRequestEventHandler<E>, context?: unknown): EventRegistration;
     /**
      * Unregisters an event handler from a {@link Transportr} instance.
      *
@@ -877,172 +959,176 @@ declare class Transportr {
      */
     clearHooks(): this;
     /**
-     * Tears down this instance: clears all instance subscriptions and hooks.
-     * The instance should not be used after calling this method.
-     */
-    destroy(): void;
-    /**
-     * This function returns a promise that resolves to the result of a request to the specified path with
-     * the specified options, where the method is GET.
-     *
-     * @async
-     * @param path The path to the resource you want to get.
-     * @param options The options for the request.
-     * @returns A promise that resolves to the response of the request.
-     */
-    get<T extends ResponseBody = ResponseBody>(path?: string | RequestOptions, options?: RequestOptions): Promise<T | undefined>;
-    /**
-     * This function makes a POST request to the given path with the given body and options.
-     *
-     * @async
-     * @template T The expected response type (defaults to ResponseBody)
-     * @param path The path to the endpoint you want to call.
-     * @param options The options for the request.
-     * @returns A promise that resolves to the response body.
-     */
-    post<T extends ResponseBody = ResponseBody>(path?: string | RequestOptions, options?: RequestOptions): Promise<T | undefined>;
-    /**
-     * This function returns a promise that resolves to the result of a request to the specified path with
-     * the specified options, where the method is PUT.
+     * Updates the instance's default options after construction.
+     * Mirrors what the constructor accepts: headers and searchParams are merged onto
+     * the existing defaults; all other options overwrite the current value; hooks
+     * are appended via {@link addHooks}.
      *
-     * @async
-     * @template T The expected response type (defaults to ResponseBody)
-     * @param path The path to the endpoint you want to call.
-     * @param options The options for the request.
-     * @returns The return value of the #request method.
-     */
-    put<T extends ResponseBody = ResponseBody>(path?: string | RequestOptions, options?: RequestOptions): Promise<T | undefined>;
-    /**
-     * It takes a path and options, and returns a request with the method set to PATCH.
-     *
-     * @async
-     * @template T The expected response type (defaults to ResponseBody)
-     * @param path The path to the endpoint you want to hit.
-     * @param options The options for the request.
-     * @returns A promise that resolves to the response of the request.
-     */
-    patch<T extends ResponseBody = ResponseBody>(path?: string | RequestOptions, options?: RequestOptions): Promise<T | undefined>;
-    /**
-     * It takes a path and options, and returns a request with the method set to DELETE.
-     *
-     * @async
-     * @param path The path to the resource you want to access.
-     * @param options The options for the request.
-     * @returns The result of the request.
-     */
-    delete<T extends ResponseBody = ResponseBody>(path?: string | RequestOptions, options?: RequestOptions): Promise<T | undefined>;
-    /**
-     * Returns the response headers of a request to the given path.
-     *
-     * @async
-     * @param path The path to the resource you want to access.
-     * @param options The options for the request.
-     * @returns A promise that resolves to the response object.
-     */
-    head<T extends ResponseBody = ResponseBody>(path?: string | RequestOptions, options?: RequestOptions): Promise<T | undefined>;
-    /**
-     * It returns a promise that resolves to the allowed request methods for the given resource path.
-     *
-     * @async
-     * @param path The path to the resource.
-     * @param options The options for the request.
-     * @returns A promise that resolves to an array of allowed request methods for this resource.
-     */
-    options(path?: string | RequestOptions, options?: RequestOptions): Promise<string[] | undefined>;
-    /**
-     * It takes a path and options, and makes a request to the server
-     * @async
-     * @param path The path to the endpoint you want to hit.
-     * @param options The options for the request.
-     * @returns The return value of the function is the return value of the function that is passed to the `then` method of the promise returned by the `fetch` method.
-     * @throws {HttpError} If an error occurs during the request.
-     */
-    request<T = unknown>(path?: string | RequestOptions, options?: RequestOptions): Promise<TypedResponse<T>>;
-    /**
-     * It gets the JSON representation of the resource at the given path.
-     *
-     * @async
-     * @template T The expected JSON response type (defaults to JsonObject)
-     * @param path The path to the resource.
-     * @param options The options object to pass to the request.
-     * @returns A promise that resolves to the response body as a typed JSON value.
-     */
-    getJson(path?: string | RequestOptions, options?: RequestOptions): Promise<Json | undefined>;
-    /**
-     * It gets the XML representation of the resource at the given path.
-     *
-     * @async
-     * @param path The path to the resource you want to get.
-     * @param options The options for the request.
-     * @returns The result of the function call to #get.
-     */
-    getXml(path?: string | RequestOptions, options?: RequestOptions): Promise<Document | undefined>;
-    /**
-     * Get the HTML content of the specified path.
-     * When a selector is provided, returns only the first matching element from the parsed document.
-     *
-     * @async
-     * @param path The path to the resource.
-     * @param options The options for the request.
-     * @param selector An optional CSS selector to extract a specific element from the parsed HTML.
-     * @returns A promise that resolves to a Document, an Element (if selector matched), or void.
-     */
-    getHtml(path?: string | RequestOptions, options?: RequestOptions, selector?: string): Promise<Document | Element | null | undefined>;
-    /**
-     * It returns a promise that resolves to the HTML fragment at the given path.
-     * When a selector is provided, returns only the first matching element from the parsed fragment.
-     *
-     * @async
-     * @param path The path to the resource.
-     * @param options The options for the request.
-     * @param selector An optional CSS selector to extract a specific element from the parsed fragment.
-     * @returns A promise that resolves to a DocumentFragment, an Element (if selector matched), or void.
-     */
-    getHtmlFragment(path?: string | RequestOptions, options?: RequestOptions, selector?: string): Promise<DocumentFragment | Element | null | undefined>;
-    /**
-     * It gets a script from the server, and appends the script to the Document HTMLHeadElement
-     * @param path The path to the script.
-     * @param options The options for the request.
-     * @returns A promise that resolves to void.
-     */
-    getScript(path?: string | RequestOptions, options?: RequestOptions): Promise<void>;
-    /**
-     * Gets a stylesheet from the server, and adds it as a Blob URL.
-     * @param path The path to the stylesheet.
-     * @param options The options for the request.
-     * @returns A promise that resolves to void.
-     */
-    getStylesheet(path?: string | RequestOptions, options?: RequestOptions): Promise<void>;
-    /**
-     * It returns a blob from the specified path.
-     * @param path The path to the resource.
-     * @param options The options for the request.
-     * @returns A promise that resolves to a Blob or void.
-     */
-    getBlob(path?: string | RequestOptions, options?: RequestOptions): Promise<Blob | undefined>;
-    /**
-     * It returns a promise that resolves to an `HTMLImageElement`.
-     * The object URL created to load the image is automatically revoked to prevent memory leaks.
-     * Works in both browser and Node.js (via JSDOM) environments.
-     * @param path The path to the image.
-     * @param options The options for the request.
-     * @returns A promise that resolves to an `HTMLImageElement` or `void`.
-     */
-    getImage(path?: string, options?: RequestOptions): Promise<HTMLImageElement | undefined>;
-    /**
-     * It gets a buffer from the specified path
-     * @param path The path to the resource.
-     * @param options The options for the request.
-     * @returns A promise that resolves to an ArrayBuffer or void.
+     * @param options The options to apply. Accepts the same shape as the constructor.
+     * @returns This instance for method chaining.
      */
-    getBuffer(path?: string | RequestOptions, options?: RequestOptions): Promise<ArrayBuffer | undefined>;
+    configure({ headers, searchParams, hooks, ...options }: RequestOptions): this;
     /**
-     * It returns a readable stream of the response body from the specified path.
-     * @param path The path to the resource.
-     * @param options The options for the request.
-     * @returns A promise that resolves to a ReadableStream, null, or void.
+     * Tears down this instance: clears all instance subscriptions and hooks.
+     * The instance should not be used after calling this method.
      */
-    getStream(path?: string | RequestOptions, options?: RequestOptions): Promise<ReadableStream<Uint8Array> | null | undefined>;
+    destroy(): void;
+    /** Returns a Result tuple instead of throwing. */
+    get<T extends ResponseBody = ResponseBody>(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    get<T extends ResponseBody = ResponseBody>(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    post<T extends ResponseBody = ResponseBody>(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    post<T extends ResponseBody = ResponseBody>(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    put<T extends ResponseBody = ResponseBody>(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    put<T extends ResponseBody = ResponseBody>(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    patch<T extends ResponseBody = ResponseBody>(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    patch<T extends ResponseBody = ResponseBody>(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    delete<T extends ResponseBody = ResponseBody>(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    delete<T extends ResponseBody = ResponseBody>(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    head<T extends ResponseBody = ResponseBody>(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    head<T extends ResponseBody = ResponseBody>(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<T | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    options(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<string[] | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    options(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<string[] | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    request<T = unknown>(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<TypedResponse<T>>>;
+    /** Returns a Result tuple instead of throwing. */
+    request<T = unknown>(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<TypedResponse<T>>>;
+    /** Returns a Result tuple instead of throwing. */
+    getJson(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<Json | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getJson(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<Json | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getXml(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<Document | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getXml(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<Document | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getHtml(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }, selector?: string): Promise<Result<Document | Element | null | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getHtml(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<Document | Element | null | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getHtmlFragment(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }, selector?: string): Promise<Result<DocumentFragment | Element | null | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getHtmlFragment(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<DocumentFragment | Element | null | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getScript(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<void>>;
+    /** Returns a Result tuple instead of throwing. */
+    getScript(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<void>>;
+    /** Returns a Result tuple instead of throwing. */
+    getStylesheet(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<void>>;
+    /** Returns a Result tuple instead of throwing. */
+    getStylesheet(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<void>>;
+    /** Returns a Result tuple instead of throwing. */
+    getBlob(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<Blob | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getBlob(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<Blob | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getImage(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<HTMLImageElement | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getBuffer(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<ArrayBuffer | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getBuffer(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<ArrayBuffer | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getStream(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<ReadableStream<Uint8Array> | null | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getStream(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<ReadableStream<Uint8Array> | null | undefined>>;
+    /** Returns a Result tuple instead of throwing. */
+    getEventStream(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<AsyncIterable<ServerSentEvent>>>;
+    /** Returns a Result tuple instead of throwing. */
+    getEventStream(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<AsyncIterable<ServerSentEvent>>>;
+    /** Returns a Result tuple instead of throwing. */
+    getJsonStream<T = Json>(path: string | undefined, options: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<AsyncIterable<T>>>;
+    /** Returns a Result tuple instead of throwing. */
+    getJsonStream<T = Json>(path: RequestOptions & {
+        unwrap: false;
+    }): Promise<Result<AsyncIterable<T>>>;
     /**
      * Handles a GET request.
      * @async
@@ -1168,5 +1254,5 @@ declare class Transportr {
     get [Symbol.toStringTag](): string;
 }
 
-export { HttpError, HttpErrorOptions, HttpMediaType, HttpRequestHeader, Json, JsonArray, JsonObject, JsonPrimitive, JsonString, JsonValue, RequestCachingPolicy, RequestEvent, RequestTiming, ResponseBody, ResponseStatus, SignalErrors, SignalEvents, Transportr, XSRF_COOKIE_NAME, XSRF_HEADER_NAME, abortEvent, aborted, defaultMediaType, endsWithSlashRegEx, eventListenerOptions, internalServerError, mediaTypes, requestBodyMethods, retryBackoffFactor, retryDelay, retryMethods, retryStatusCodes, timedOut, timeoutEvent };
-export type { AbortConfiguration, AbortEvent, AbortSignalEvent, AfterResponseHook, BeforeErrorHook, BeforeRequestHook, Entries, EventRegistration, HookOptions, NormalizedRetryOptions, PublishOptions, ReadOnlyEntries, RequestBody, RequestBodyMethod, RequestEventHandler, RequestHeaders, RequestLifecycleEvent, RequestMethod, RequestOptions, ResponseHandler, RetryOptions, SearchParameters, TimeoutEvent, TypedArray, TypedResponse, XsrfOptions };
+export { ContentType, DownloadProgress, HttpError, HttpErrorOptions, Json, JsonArray, JsonObject, JsonPrimitive, JsonString, JsonValue, RequestCachingPolicy, RequestEvent, RequestHeader, RequestTiming, ResponseBody, ResponseStatus, Result, RetryInfo, ServerSentEvent, SignalErrors, SignalEvents, Transportr, XSRF_COOKIE_NAME, XSRF_HEADER_NAME, abortEvent, aborted, defaultMediaType, defaultOrigin, endsWithSlashRegEx, eventListenerOptions, internalServerError, mediaTypes, requestBodyMethods, retryBackoffFactor, retryDelay, retryMethods, retryStatusCodes, timedOut, timeoutEvent };
+export type { AbortConfiguration, AbortEvent, AbortSignalEvent, AfterResponseHook, BeforeErrorHook, BeforeRequestHook, Entries, EventRegistration, HookOptions, NormalizedRetryOptions, PublishOptions, ReadOnlyEntries, RequestBody, RequestBodyMethod, RequestEventDataMap, RequestEventHandler, RequestHeaders, RequestLifecycleEvent, RequestMethod, RequestOptions, ResponseHandler, RetryOptions, SearchParameters, TimeoutEvent, TypedArray, TypedRequestEventHandler, TypedResponse, XsrfOptions };