Class PassThroughWebSocketHandlerDefinition

Hierarchy (view full)

Serializable
- PassThroughWebSocketHandlerDefinition
  - PassThroughWebSocketHandler

Implements

WebSocketHandlerDefinition

Index

Constructors

Properties

clientCertificateHostMap extraCACertificates forwarding? ignoreHostHttpsErrors lookupOptions proxyConfig? simulateConnectionErrors type

Methods

dispose explain

Constructors

constructor

new PassThroughWebSocketHandlerDefinition(options?): PassThroughWebSocketHandlerDefinition
Parameters
- options: PassThroughHandlerConnectionOptions = {}
Returns PassThroughWebSocketHandlerDefinition
Overrides Serializable.constructor
- Defined in rules/websockets/websocket-handler-definitions.ts:77

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`simulateConnectionErrors

simulateConnectionErrors: boolean

`Readonly`type

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

Methods

dispose

dispose(): void
Returns void
Implementation of WebSocketHandlerDefinition.dispose
Inherited from Serializable.dispose
- Defined in serialization/serialization.ts:96

explain

explain(): string
Returns string
Implementation of WebSocketHandlerDefinition.explain
- Defined in rules/websockets/websocket-handler-definitions.ts:112