UNPKG

mockttp

Version:

Mock HTTP server for testing HTTP clients and stubbing webservices

73 lines 3.69 kB
import { TypedError } from 'typed-error'; import { OngoingRequest, OngoingResponse } from "../../types"; import { ClientServerChannel } from '../../serialization/serialization'; import { MockttpDeserializationOptions } from '../rule-deserialization'; import { ForwardingOptions, PassThroughLookupOptions } from '../passthrough-handling-definitions'; import { CallbackStep, CallbackRequestResult, CallbackResponseMessageResult, CallbackResponseResult, CloseConnectionStep, FileStep, StepDefinitionLookup, JsonRpcResponseStep, PassThroughStep, PassThroughStepOptions, PassThroughResponse, RequestStepDefinition, RequestTransform, ResetConnectionStep, ResponseTransform, SerializedCallbackStepData, SerializedPassThroughData, SerializedStreamStepData, FixedResponseStep, StreamStep, TimeoutStep, DelayStep } from './request-step-definitions'; export { CallbackRequestResult, CallbackResponseMessageResult, CallbackResponseResult, ForwardingOptions, PassThroughResponse, PassThroughStepOptions, PassThroughLookupOptions, RequestTransform, ResponseTransform }; export declare class AbortError extends TypedError { readonly code: string; constructor(message: string, code: string); } export interface RequestStepImpl extends RequestStepDefinition { handle(request: OngoingRequest, response: OngoingResponse, options: RequestStepOptions): Promise<undefined | { continue: boolean; }>; } export interface RequestStepOptions { emitEventCallback?: (type: string, event: unknown) => void; debug: boolean; } export declare class FixedResponseStepImpl extends FixedResponseStep { handle(_request: OngoingRequest, response: OngoingResponse): Promise<void>; } export declare class CallbackStepImpl extends CallbackStep { handle(request: OngoingRequest, response: OngoingResponse): Promise<void>; /** * @internal */ static deserialize({ name }: SerializedCallbackStepData, channel: ClientServerChannel, options: MockttpDeserializationOptions): CallbackStep; } export declare class StreamStepImpl extends StreamStep { handle(_request: OngoingRequest, response: OngoingResponse): Promise<void>; /** * @internal */ static deserialize(stepData: SerializedStreamStepData, channel: ClientServerChannel): StreamStep; } export declare class FileStepImpl extends FileStep { handle(_request: OngoingRequest, response: OngoingResponse): Promise<void>; } export declare class PassThroughStepImpl extends PassThroughStep { private _trustedCACertificates; private trustedCACertificates; handle(clientReq: OngoingRequest, clientRes: OngoingResponse, options: RequestStepOptions): Promise<void>; /** * @internal */ static deserialize(data: SerializedPassThroughData, channel: ClientServerChannel, { ruleParams, bodySerializer }: MockttpDeserializationOptions): PassThroughStep; } export declare class CloseConnectionStepImpl extends CloseConnectionStep { handle(request: OngoingRequest): Promise<void>; } export declare class ResetConnectionStepImpl extends ResetConnectionStep { constructor(); handle(request: OngoingRequest): Promise<void>; /** * @internal */ static deserialize(): ResetConnectionStep; } export declare class TimeoutStepImpl extends TimeoutStep { handle(): Promise<void>; } export declare class JsonRpcResponseStepImpl extends JsonRpcResponseStep { handle(request: OngoingRequest, response: OngoingResponse): Promise<void>; } export declare class DelayStepImpl extends DelayStep { handle(): Promise<{ continue: true; }>; } export declare const StepLookup: typeof StepDefinitionLookup; //# sourceMappingURL=request-step-impls.d.ts.map