Class PassThroughWebSocketHandler

Hierarchy (view full)

PassThroughWebSocketHandlerDefinition
- PassThroughWebSocketHandler

Index

Constructors

Properties

clientCertificateHostMap extraCACertificates forwarding? ignoreHostHttpsErrors lookupOptions proxyConfig? type

Methods

dispose explain handle

Constructors

constructor

new PassThroughWebSocketHandler(options?): PassThroughWebSocketHandler
Parameters
- options: PassThroughHandlerConnectionOptions = {}
Returns PassThroughWebSocketHandler
Inherited from PassThroughWebSocketHandlerDefinition.constructor
- Defined in rules/websockets/websocket-handler-definitions.ts:75

Properties

`Readonly`clientCertificateHostMap

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

`Readonly`extraCACertificates

extraCACertificates: CADefinition[] = []

`Optional` `Readonly`forwarding

forwarding?: ForwardingOptions

`Readonly`ignoreHostHttpsErrors

ignoreHostHttpsErrors: boolean | string[] = []

`Readonly`lookupOptions

lookupOptions: undefined | PassThroughLookupOptions

`Optional` `Readonly`proxyConfig

proxyConfig?: ProxyConfig

`Readonly`type

type: "ws-passthrough" = 'ws-passthrough'

Methods

dispose

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

explain

explain(): string
Returns string
Inherited from PassThroughWebSocketHandlerDefinition.explain
- Defined in rules/websockets/websocket-handler-definitions.ts:109

handle

handle(req, socket, head): Promise<void>
Parameters
- req: OngoingRequest
- socket: Socket
- head: Buffer
Returns Promise<void>
- Defined in rules/websockets/websocket-handlers.ts:222