Class PassThroughHandler

Hierarchy (view full)

PassThroughHandlerDefinition
- PassThroughHandler

Index

Constructors

Properties

beforeRequest? beforeResponse? clientCertificateHostMap extraCACertificates forwarding? ignoreHostHttpsErrors lookupOptions? proxyConfig? simulateConnectionErrors transformRequest? transformResponse? type

Methods

dispose explain handle

Constructors

constructor

new PassThroughHandler(options?): PassThroughHandler
Parameters
- options: PassThroughHandlerOptions = {}
Returns PassThroughHandler
Inherited from PassThroughHandlerDefinition.constructor
- Defined in rules/requests/request-handler-definitions.ts:796

Properties

`Optional` `Readonly`beforeRequest

beforeRequest?: ((req: CompletedRequest) => MaybePromise<void | CallbackRequestResult>)

`Optional` `Readonly`beforeResponse

beforeResponse?: ((res: PassThroughResponse) => MaybePromise<void | CallbackResponseResult>)

`Readonly`clientCertificateHostMap

clientCertificateHostMap: {
    [host: string]: {
        passphrase?: string;
        pfx: Buffer;
    };
}

`Readonly`extraCACertificates

extraCACertificates: CADefinition[] = []

`Optional` `Readonly`forwarding

forwarding?: ForwardingOptions

`Readonly`ignoreHostHttpsErrors

ignoreHostHttpsErrors: boolean | string[] = []

`Optional` `Readonly`lookupOptions

lookupOptions?: PassThroughLookupOptions

`Optional` `Readonly`proxyConfig

proxyConfig?: ProxyConfig

`Readonly`simulateConnectionErrors

simulateConnectionErrors: boolean

`Optional` `Readonly`transformRequest

transformRequest?: RequestTransform

`Optional` `Readonly`transformResponse

transformResponse?: ResponseTransform

`Readonly`type

type: "passthrough" = 'passthrough'

Methods

dispose

dispose(): void
Returns void
Inherited from PassThroughHandlerDefinition.dispose
- Defined in serialization/serialization.ts:96

explain

explain(): string
Returns string
Inherited from PassThroughHandlerDefinition.explain
- Defined in rules/requests/request-handler-definitions.ts:890

handle

handle(clientReq, clientRes, options): Promise<void>
Parameters
- clientReq: OngoingRequest
- clientRes: OngoingResponse
- options: RequestHandlerOptions
Returns Promise<void>
- Defined in rules/requests/request-handlers.ts:398