Class Connection

Class representing a connection to the server, i.e. client.

Hierarchy

EventEmitter
- Connection

Index

Constructors

constructor

Properties

Constructors

constructor

new Connection(socket: WebSocket, server: Server, id: number): Connection

- Defined in server.ts:203
Parameters
- socket: WebSocket
- server: Server
- id: number
Returns Connection

Properties

id

id: number

Unique identifier for this connection.

Private server

server: Server

socket

socket: WebSocket

The underlying WebSocket instance.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from EventEmitter.addListener

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

close

close(): void

- Defined in server.ts:236
Close the connection to the client.

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:32
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:33
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

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

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in ./node_modules/@types/node/events.d.ts:34
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:30
Parameters
- event: string | symbol
Returns Function[]

Private messageHandler

messageHandler(data: any): void

- Defined in server.ts:274
Parameters
- data: any
Returns void

off

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

Inherited from EventEmitter.off

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

on

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

Inherited from EventEmitter.on

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

once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in ./node_modules/@types/node/events.d.ts:22
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:23
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:24
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:31
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:27
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

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

Private requestHandler

requestHandler(request: Request): Promise<Response>

- Defined in server.ts:240
Parameters
- request: Request
Returns Promise<Response>

send

send(name: string, payload?: Uint8Array): Promise<void>

- Defined in server.ts:218
Send event to client with optional payload.

Parameters
- name: string
- Optional payload: Uint8Array
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

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

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in ./node_modules/@types/node/events.d.ts:17
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc