WebSocketProxyServer | jade-service-runner

Hierarchy

Server
- WebSocketProxyServer

Index

Constructors

constructor

Properties

Constructors

constructor

new WebSocketProxyServer(options: ServerOptions, callback: undefined | function): WebSocketProxyServer

Overrides Server.__constructor
- Defined in src/lib/wsProxyServer.ts:30
Parameters
- options: ServerOptions
- Optional callback: undefined | function
Returns WebSocketProxyServer

Properties

clients

clients: Set<WebSocket>

options

options: ServerOptions

path

path: string

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: "connection", cb: function): this
addListener(event: "error", cb: function): this
addListener(event: "headers", cb: function): this
addListener(event: "close" | "listening", cb: function): this
addListener(event: string | symbol, listener: function): this

Inherited from Server.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:261
Parameters
- event: "connection"
- cb: function
  - - (client: WebSocket): void
    - Parameters
      - client: WebSocket
      Returns void
Returns this
Inherited from Server.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:262
Parameters
- event: "error"
- cb: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Server.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:263
Parameters
- event: "headers"
- cb: function
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns this
Inherited from Server.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:264
Parameters
- event: "close" | "listening"
- cb: function
  - - (): void
    - Returns void
Returns this
Inherited from Server.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:265
Parameters
- event: string | symbol
- listener: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns this

address

address(): AddressInfo | string

Inherited from Server.address
- Defined in node_modules/@types/ws/index.d.ts:236
Returns AddressInfo | string

close

close(cb: undefined | function): void

Inherited from Server.close
- Defined in node_modules/@types/ws/index.d.ts:237
Parameters
- Optional cb: undefined | function
Returns void

emit

emit(event: string | symbol, args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

handleUpgrade

handleUpgrade(request: IncomingMessage, socket: Socket, upgradeHead: Buffer, callback: function): void

Inherited from Server.handleUpgrade
- Defined in node_modules/@types/ws/index.d.ts:238
Parameters
- request: IncomingMessage
- socket: Socket
- upgradeHead: Buffer
- callback: function
  - - (client: WebSocket): void
    - Parameters
      - client: WebSocket
      Returns void
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

off(event: "connection", cb: function): this
off(event: "error", cb: function): this
off(event: "headers", cb: function): this
off(event: "close" | "listening", cb: function): this
off(event: string | symbol, listener: function): this

Inherited from Server.off

Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:255
Parameters
- event: "connection"
- cb: function
  - - (this: Server, socket: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: Server
      - socket: WebSocket
      - request: IncomingMessage
      Returns void
Returns this
Inherited from Server.off

Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:256
Parameters
- event: "error"
- cb: function
  - - (this: Server, error: Error): void
    - Parameters
      - this: Server
      - error: Error
      Returns void
Returns this
Inherited from Server.off

Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:257
Parameters
- event: "headers"
- cb: function
  - - (this: Server, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns this
Inherited from Server.off

Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:258
Parameters
- event: "close" | "listening"
- cb: function
  - - (this: Server): void
    - Parameters
      - this: Server
      Returns void
Returns this
Inherited from Server.off

Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:259
Parameters
- event: string | symbol
- listener: function
  - - (this: Server, args: any[]): void
    - Parameters
      - this: Server
      - Rest args: any[]
      Returns void
Returns this

on

on(event: "connection", cb: function): this
on(event: "error", cb: function): this
on(event: "headers", cb: function): this
on(event: "close" | "listening", cb: function): this
on(event: string | symbol, listener: function): this

Inherited from Server.on

Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:243
Parameters
- event: "connection"
- cb: function
  - - (this: Server, socket: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: Server
      - socket: WebSocket
      - request: IncomingMessage
      Returns void
Returns this
Inherited from Server.on

Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:244
Parameters
- event: "error"
- cb: function
  - - (this: Server, error: Error): void
    - Parameters
      - this: Server
      - error: Error
      Returns void
Returns this
Inherited from Server.on

Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:245
Parameters
- event: "headers"
- cb: function
  - - (this: Server, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns this
Inherited from Server.on

Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:246
Parameters
- event: "close" | "listening"
- cb: function
  - - (this: Server): void
    - Parameters
      - this: Server
      Returns void
Returns this
Inherited from Server.on

Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:247
Parameters
- event: string | symbol
- listener: function
  - - (this: Server, args: any[]): void
    - Parameters
      - this: Server
      - Rest args: any[]
      Returns void
Returns this

once

once(event: "connection", cb: function): this
once(event: "error", cb: function): this
once(event: "headers", cb: function): this
once(event: "close" | "listening", cb: function): this
once(event: string | symbol, listener: function): this

Inherited from Server.once

Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:249
Parameters
- event: "connection"
- cb: function
  - - (this: Server, socket: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: Server
      - socket: WebSocket
      - request: IncomingMessage
      Returns void
Returns this
Inherited from Server.once

Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:250
Parameters
- event: "error"
- cb: function
  - - (this: Server, error: Error): void
    - Parameters
      - this: Server
      - error: Error
      Returns void
Returns this
Inherited from Server.once

Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:251
Parameters
- event: "headers"
- cb: function
  - - (this: Server, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns this
Inherited from Server.once

Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:252
Parameters
- event: "close" | "listening"
- cb: function
  - - (this: Server): void
    - Parameters
      - this: Server
      Returns void
Returns this
Inherited from Server.once

Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:253
Parameters
- event: string | symbol
- listener: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "connection", cb: function): this
removeListener(event: "error", cb: function): this
removeListener(event: "headers", cb: function): this
removeListener(event: "close" | "listening", cb: function): this
removeListener(event: string | symbol, listener: function): this

Inherited from Server.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:267
Parameters
- event: "connection"
- cb: function
  - - (client: WebSocket): void
    - Parameters
      - client: WebSocket
      Returns void
Returns this
Inherited from Server.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:268
Parameters
- event: "error"
- cb: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Server.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:269
Parameters
- event: "headers"
- cb: function
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns this
Inherited from Server.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:270
Parameters
- event: "close" | "listening"
- cb: function
  - - (): void
    - Returns void
Returns this
Inherited from Server.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:271
Parameters
- event: string | symbol
- listener: function
  - - (args: any[]): void
    - Parameters
      - Rest args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

shouldHandle

shouldHandle(request: IncomingMessage): boolean | Promise<boolean>

Inherited from Server.shouldHandle
- Defined in node_modules/@types/ws/index.d.ts:240
Parameters
- request: IncomingMessage
Returns boolean | Promise<boolean>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:8
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: ServerOptions

Optional callback: undefined | function

Returns WebSocketProxyServer

Properties

clients

options

path

Static defaultMaxListeners

Methods

addListener

Parameters

event: "connection"

cb: function

Parameters

client: WebSocket

Returns void

Returns this

Parameters

event: "error"

cb: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "headers"

cb: function

Parameters

headers: string[]

request: IncomingMessage

Returns void

Returns this

Parameters

event: "close" | "listening"

cb: function

Returns void

Returns this

Parameters

event: string | symbol

listener: function

Parameters

Rest args: any[]

Returns void

Returns this

address

Returns AddressInfo | string

close

Parameters

Optional cb: undefined | function

Returns void

emit

Parameters

event: string | symbol

Rest args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getMaxListeners

Returns number

handleUpgrade

Parameters

request: IncomingMessage

socket: Socket

upgradeHead: Buffer

callback: function

Parameters

client: WebSocket

Returns void

Returns void

listenerCount

Parameters

type: string | symbol