node-request-interceptor/lib/glossary.d.ts

Low-level HTTP/HTTPS/XHR request interception library for NodeJS

/// <reference types="node" />
import { IncomingMessage } from 'http';
import { StrictEventEmitter } from 'strict-event-emitter';
export interface RequestSelf {
    uri?: URL;
}
export interface RequestInterceptorContext {
    emitter: StrictEventEmitter<RequestInterceptorEventsMap>;
}
/**
 * A module override function that accepts a request middleware
 * and returns a cleanup function that restores all the patched modules.
 */
export declare type Interceptor = (middleware: RequestMiddleware, context: RequestInterceptorContext) => () => void;
export declare type HttpRequestCallback = (res: IncomingMessage) => void;
export interface InterceptedRequest {
    url: URL;
    method: string;
    headers?: Record<string, string | string[]>;
    body?: string | undefined;
}
export declare type ReturnedResponse = Partial<MockedResponse> | void;
export declare type RequestMiddleware = (req: InterceptedRequest, ref: IncomingMessage | XMLHttpRequest) => ReturnedResponse | Promise<ReturnedResponse>;
export interface MockedResponse {
    status: number;
    statusText: string;
    headers: Record<string, string | string[]>;
    body: string | undefined;
}
export interface RequestInterceptorEventsMap {
    response: (req: InterceptedRequest, res: MockedResponse) => void;
}