Class PassThroughWebSocketHandlerDefinition

Hierarchy

Serializable
- PassThroughWebSocketHandlerDefinition
  - PassThroughWebSocketHandler

Implements

WebSocketHandlerDefinition

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PassThroughWebSocketHandlerDefinition(options?: PassThroughHandlerConnectionOptions): PassThroughWebSocketHandlerDefinition

Overrides Serializable.constructor
- Defined in src/rules/websockets/websocket-handler-definitions.ts:74
Parameters
- options: PassThroughHandlerConnectionOptions = {}
Returns PassThroughWebSocketHandlerDefinition

Properties

Readonly clientCertificateHostMap

clientCertificateHostMap: {}

Type declaration

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

Readonly extraCACertificates

extraCACertificates: ({ cert: string | Buffer } | { certPath: string })[] = []

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

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

explain

explain(): string

Implementation of WebSocketHandlerDefinition.explain
- Defined in src/rules/websockets/websocket-handler-definitions.ts:105
Returns string

Generated using TypeDoc