/// import type {IncomingHttpHeaders} from 'http' import type {IncomingMessage} from 'http' import type {ProgressStream} from 'progress-stream' import type {UrlWithStringQuery} from 'url' /** @public */ export declare const adapter: RequestAdapter /** @public */ export declare type ApplyMiddleware = ( hook: T, value: MiddlewareHooks[T] extends (defaultValue: infer V, ...rest: any[]) => any ? V : never, ...args: MiddlewareHooks[T] extends (defaultValue: any, ...rest: infer P) => any ? P : never ) => ReturnType /** @public */ export declare type DefineApplyMiddleware = (middleware: MiddlewareReducer) => ApplyMiddleware /** @public */ export declare const environment: ExportEnv /** * Reports the environment as either "node" or "browser", depending on what entry point was used to aid bundler debugging. * If 'browser' is used, then the globally available `fetch` class is used. While `node` will always use either `node:https` or `node:http` depending on the protocol. * @public */ export declare type ExportEnv = 'node' | 'react-server' | 'browser' /** @public */ export declare interface FinalizeNodeOptionsPayload extends UrlWithStringQuery { method: RequestOptions['method'] headers: RequestOptions['headers'] maxRedirects: RequestOptions['maxRedirects'] agent?: any cert?: any key?: any ca?: any } /** @public */ export declare const getIt: (initMiddleware?: Middlewares, httpRequest?: HttpRequest) => Requester /** @public */ export declare type HookOnRequestEvent = HookOnRequestEventNode | HookOnRequestEventBrowser /** @public */ export declare interface HookOnRequestEventBase { options: RequestOptions context: HttpContext request: any } /** @public */ export declare interface HookOnRequestEventBrowser extends HookOnRequestEventBase { adapter: Omit progress?: undefined } /** @public */ export declare interface HookOnRequestEventNode extends HookOnRequestEventBase { adapter: 'node' progress: any } /** @public */ export declare interface HttpContext { options: RequestOptions channels: MiddlewareChannels applyMiddleware: ApplyMiddleware } /** * request-node in node, browser-request in browsers * @public */ export declare type HttpRequest = ( context: HttpContext, callback: (err: Error | null, response?: MiddlewareResponse) => void, ) => HttpRequestOngoing /** @public */ export declare interface HttpRequestOngoing { abort: () => void } /** @public */ export declare type Middleware = Partial /** @public */ export declare interface MiddlewareChannels { request: PubSub response: PubSub progress: PubSub error: PubSub abort: PubSub } /** @public */ export declare type MiddlewareHookName = keyof MiddlewareHooks /** @public */ export declare interface MiddlewareHooks { processOptions: (options: RequestOptions) => RequestOptions validateOptions: (options: RequestOptions) => void | undefined interceptRequest: ( prevValue: MiddlewareResponse | undefined, event: { adapter: RequestAdapter context: HttpContext }, ) => MiddlewareResponse | undefined | void finalizeOptions: ( options: FinalizeNodeOptionsPayload | RequestOptions, ) => FinalizeNodeOptionsPayload | RequestOptions onRequest: (evt: HookOnRequestEvent) => void onResponse: (response: MiddlewareResponse, context: HttpContext) => MiddlewareResponse onError: (err: Error | null, context: HttpContext) => any onReturn: (channels: MiddlewareChannels, context: HttpContext) => any onHeaders: ( response: IncomingMessage, evt: { headers: IncomingHttpHeaders adapter: RequestAdapter context: HttpContext }, ) => ProgressStream } /** @public */ export declare type MiddlewareReducer = { [T in keyof MiddlewareHooks]: (( ...args: Parameters ) => ReturnType)[] } /** @public */ export declare interface MiddlewareRequest {} /** @public */ export declare interface MiddlewareResponse { body: any url: string method: string headers: any statusCode: number statusMessage: string } /** @public */ export declare type Middlewares = Middleware[] /** @public */ export declare interface PubSub { publish: (message: Message) => void subscribe: (subscriber: Subscriber) => () => void } /** * Reports the request adapter in use. `node` is only available if `ExportEnv` is also `node`. * When `ExportEnv` is `browser` then the adapter can be either `xhr` or `fetch`. * In the future `fetch` will be available in `node` as well. * @public */ export declare type RequestAdapter = 'node' | 'xhr' | 'fetch' /** @public */ export declare type Requester = { use: (middleware: Middleware) => Requester clone: () => Requester (options: RequestOptions | string): any } /** @public */ export declare interface RequestOptions { url: string body?: any bodySize?: number cancelToken?: any compress?: boolean headers?: any maxRedirects?: number maxRetries?: number method?: string proxy?: any query?: any rawBody?: boolean shouldRetry?: any stream?: boolean timeout?: any tunnel?: boolean debug?: any requestId?: number attemptNumber?: number withCredentials?: boolean /** * Enables using the native `fetch` API instead of the default `http` module, and allows setting its options like `cache` */ fetch?: boolean | Omit /** * Some frameworks have special behavior for `fetch` when an `AbortSignal` is used, and may want to disable it unless userland specifically opts-in. */ useAbortSignal?: boolean } /** @public */ export declare interface RetryOptions { shouldRetry: (err: any, num: number, options: any) => boolean maxRetries?: number retryDelay?: (attemptNumber: number) => number } /** @public */ export declare interface Subscriber { (event: Event): void } export {}