Class Connection

Hierarchy

TypedEmitter
- Connection

Index

Constructors

constructor

new Connection(node, options): Connection
Parameters
- node: Node
- options: ConnectionOptions
Returns Connection
Overrides TypedEmitter.constructor
- Defined in src/node/Connection.ts:39

Properties

`Private` #node

#node: Node

headers

headers: Record<string, string> = {}

isConnected

isConnected: boolean = false

isDestroyed

isDestroyed: boolean = false

`Readonly` options

options: ConnectionOptions

reconnectTry

reconnectTry: number = 0

resumed

resumed: boolean = false

state

state: NodeState = NodeState.Disconnected

ws

ws: null | WebSocket = null

`Static` defaultMaxListeners

defaultMaxListeners: number

Accessors

canReconnect

get canReconnect(): boolean
Returns boolean
- Defined in src/node/Connection.ts:57

isReconnecting

get isReconnecting(): boolean
Returns boolean
- Defined in src/node/Connection.ts:54

url

get url(): string
Returns string
- Defined in src/node/Connection.ts:50

versionPath

get versionPath(): string
Returns string
- Defined in src/node/Connection.ts:46

Methods

addListener

addListener<U>(event, listener): Connection
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns Connection
Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11

`Private` close

close(code, reason): void
Parameters
- code: number
- reason: string
Returns void
- Defined in src/node/Connection.ts:106

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in src/node/Connection.ts:67

destroy

destroy(): void
Returns void
- Defined in src/node/Connection.ts:165

emit

emit<U>(event, ...args): boolean
Type Parameters
- U extends string | number
Parameters
- event: U
- Rest ...args: Parameters<DefaultListener[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19

`Private` error

error(error): void
Parameters
- error: Error
Returns void
- Defined in src/node/Connection.ts:98

eventNames

eventNames<U>(): U[]
Type Parameters
- U extends string | number
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24

listenerCount

listenerCount(type): number
Parameters
- type: string | number
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners<U>(type): DefaultListener[U][]
Type Parameters
- U extends string | number
Parameters
- type: U
Returns DefaultListener[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22

`Private` message

message(data): void
Parameters
- data: Data
Returns void
- Defined in src/node/Connection.ts:117

off

off<U>(event, listener): Connection
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns Connection
Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on<U>(event, listener): Connection
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns Connection
Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once<U>(event, listener): Connection
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns Connection
Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16

`Private` open

open(): void
Returns void
- Defined in src/node/Connection.ts:83

prependListener

prependListener<U>(event, listener): Connection
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns Connection
Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener<U>(event, listener): Connection
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns Connection
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners<U>(type): DefaultListener[U][]
Type Parameters
- U extends string | number
Parameters
- type: U
Returns DefaultListener[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23

`Private` reconnect

reconnect(): Promise<void>
Returns Promise<void>
- Defined in src/node/Connection.ts:142

removeAllListeners

removeAllListeners(event?): Connection
Parameters
- Optional event: string | number
Returns Connection
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener<U>(event, listener): Connection
Type Parameters
- U extends string | number
Parameters
- event: U
- listener: DefaultListener[U]
Returns Connection
Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14

send

send(data): void
Parameters
- data: Dictionary
Returns void
- Defined in src/node/Connection.ts:180

setMaxListeners

setMaxListeners(n): Connection
Parameters
- n: number
Returns Connection
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25

Generated using TypeDoc