@atproto/xrpc/dist/fetch-handler.d.ts

atproto HTTP API (XRPC) client library

import { Gettable } from './types';
export type FetchHandler = (this: void, 
/**
 * The URL (pathname + query parameters) to make the request to, without the
 * origin. The origin (protocol, hostname, and port) must be added by this
 * {@link FetchHandler}, typically based on authentication or other factors.
 */
url: string, init: RequestInit) => Promise<Response>;
export type FetchHandlerOptions = BuildFetchHandlerOptions | string | URL;
export type BuildFetchHandlerOptions = {
    /**
     * The service URL to make requests to. This can be a string, URL, or a
     * function that returns a string or URL. This is useful for dynamic URLs,
     * such as a service URL that changes based on authentication.
     */
    service: Gettable<string | URL>;
    /**
     * Headers to be added to every request. If a function is provided, it will be
     * called on each request to get the headers. This is useful for dynamic
     * headers, such as authentication tokens that may expire.
     */
    headers?: {
        [_ in string]?: Gettable<null | string>;
    };
    /**
     * Bring your own fetch implementation. Typically useful for testing, logging,
     * mocking, or adding retries, session management, signatures, proof of
     * possession (DPoP), etc. Defaults to the global `fetch` function.
     */
    fetch?: typeof globalThis.fetch;
};
export interface FetchHandlerObject {
    fetchHandler: (this: FetchHandlerObject, 
    /**
     * The URL (pathname + query parameters) to make the request to, without the
     * origin. The origin (protocol, hostname, and port) must be added by this
     * {@link FetchHandler}, typically based on authentication or other factors.
     */
    url: string, init: RequestInit) => Promise<Response>;
}
export declare function buildFetchHandler(options: FetchHandler | FetchHandlerObject | FetchHandlerOptions): FetchHandler;
//# sourceMappingURL=fetch-handler.d.ts.map