Class PassThroughWebSocketHandler

Hierarchy

PassThroughWebSocketHandlerDefinition
- PassThroughWebSocketHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PassThroughWebSocketHandler(options?: PassThroughHandlerConnectionOptions): PassThroughWebSocketHandler

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

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

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

explain

explain(): string

Inherited from PassThroughWebSocketHandlerDefinition.explain
- Defined in src/rules/websockets/websocket-handler-definitions.ts:105
Returns string

handle

handle(req: OngoingRequest, socket: Socket, head: Buffer): Promise<void>

- Defined in src/rules/websockets/websocket-handlers.ts:232
Parameters
- req: OngoingRequest
- socket: Socket
- head: Buffer
Returns Promise<void>

Generated using TypeDoc