ElkConnection | elk-client

Hierarchy

ElkConnection

Implemented by

ElkSocketConnection

Index

Events

addListener

Properties

state

Methods

Events

addListener

addListener(event: "connecting" | "connected" | "disconnecting", listener: StateChangeListener): this
addListener(event: "disconnected", listener: DisconnectedListener): this
addListener(event: "error", listener: ErrorListener): this
addListener(event: "data", listener: DataListener): this

- Defined in src/connection/ElkConnection.ts:24
Emitted whenever the connection state has changed.

Parameters
- event: "connecting" | "connected" | "disconnecting"
- listener: StateChangeListener
Returns this
- Defined in src/connection/ElkConnection.ts:33
Emitted whenever the connection state has changed.

Parameters
- event: "disconnected"
- listener: DisconnectedListener
Returns this
- Defined in src/connection/ElkConnection.ts:39
Emitted whenever an error occurs.

Parameters
- event: "error"
- listener: ErrorListener
Returns this
- Defined in src/connection/ElkConnection.ts:45
Emitted whenever data is received.

Parameters
- event: "data"
- listener: DataListener
Returns this

Properties

state

state: ElkConnectionState

Methods

connect

connect(): Promise<ElkConnection>

- Defined in src/connection/ElkConnection.ts:91
Returns Promise<ElkConnection>

disconnect

disconnect(): Promise<ElkConnection>

- Defined in src/connection/ElkConnection.ts:92
Returns Promise<ElkConnection>

emit

emit(event: string | symbol, ...args: any[]): boolean
emit(event: "connecting" | "connected" | "disconnecting", previousState: ElkConnectionState): void
emit(event: "disconnected", previousState: ElkConnectionState, error?: Error): void
emit(event: "error", error: Error): void
emit(event: "data", data: string): void

- Defined in src/connection/ElkConnection.ts:81
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
- Defined in src/connection/ElkConnection.ts:82
Parameters
- event: "connecting" | "connected" | "disconnecting"
- previousState: ElkConnectionState
Returns void
- Defined in src/connection/ElkConnection.ts:86
Parameters
- event: "disconnected"
- previousState: ElkConnectionState
- Optional error: Error
Returns void
- Defined in src/connection/ElkConnection.ts:87
Parameters
- event: "error"
- error: Error
Returns void
- Defined in src/connection/ElkConnection.ts:88
Parameters
- event: "data"
- data: string
Returns void

on

on(event: "connecting" | "connected" | "disconnecting", listener: StateChangeListener): this
on(event: "disconnected", listener: DisconnectedListener): this
on(event: "error", listener: ErrorListener): this
on(event: "data", listener: DataListener): this

- Defined in src/connection/ElkConnection.ts:55
Parameters
- event: "connecting" | "connected" | "disconnecting"
- listener: StateChangeListener
Returns this
- Defined in src/connection/ElkConnection.ts:56
Parameters
- event: "disconnected"
- listener: DisconnectedListener
Returns this
- Defined in src/connection/ElkConnection.ts:57
Parameters
- event: "error"
- listener: ErrorListener
Returns this
- Defined in src/connection/ElkConnection.ts:58
Parameters
- event: "data"
- listener: DataListener
Returns this

once

once(event: "connecting" | "connected" | "disconnecting", listener: StateChangeListener): this
once(event: "disconnected", listener: DisconnectedListener): this
once(event: "error", listener: ErrorListener): this
once(event: "data", listener: DataListener): this

- Defined in src/connection/ElkConnection.ts:60
Parameters
- event: "connecting" | "connected" | "disconnecting"
- listener: StateChangeListener
Returns this
- Defined in src/connection/ElkConnection.ts:61
Parameters
- event: "disconnected"
- listener: DisconnectedListener
Returns this
- Defined in src/connection/ElkConnection.ts:62
Parameters
- event: "error"
- listener: ErrorListener
Returns this
- Defined in src/connection/ElkConnection.ts:63
Parameters
- event: "data"
- listener: DataListener
Returns this

prependListener

prependListener(event: "connecting" | "connected" | "disconnecting", listener: StateChangeListener): this
prependListener(event: "disconnected", listener: DisconnectedListener): this
prependListener(event: "error", listener: ErrorListener): this
prependListener(event: "data", listener: DataListener): this

- Defined in src/connection/ElkConnection.ts:65
Parameters
- event: "connecting" | "connected" | "disconnecting"
- listener: StateChangeListener
Returns this
- Defined in src/connection/ElkConnection.ts:69
Parameters
- event: "disconnected"
- listener: DisconnectedListener
Returns this
- Defined in src/connection/ElkConnection.ts:70
Parameters
- event: "error"
- listener: ErrorListener
Returns this
- Defined in src/connection/ElkConnection.ts:71
Parameters
- event: "data"
- listener: DataListener
Returns this

prependOnceListener

prependOnceListener(event: "connecting" | "connected" | "disconnecting", listener: StateChangeListener): this
prependOnceListener(event: "disconnected", listener: DisconnectedListener): this
prependOnceListener(event: "error", listener: ErrorListener): this
prependOnceListener(event: "data", listener: DataListener): this

- Defined in src/connection/ElkConnection.ts:73
Parameters
- event: "connecting" | "connected" | "disconnecting"
- listener: StateChangeListener
Returns this
- Defined in src/connection/ElkConnection.ts:77
Parameters
- event: "disconnected"
- listener: DisconnectedListener
Returns this
- Defined in src/connection/ElkConnection.ts:78
Parameters
- event: "error"
- listener: ErrorListener
Returns this
- Defined in src/connection/ElkConnection.ts:79
Parameters
- event: "data"
- listener: DataListener
Returns this

removeListener

removeListener(event: "connecting" | "connected" | "disconnecting", listener: StateChangeListener): this
removeListener(event: "disconnected", listener: DisconnectedListener): this
removeListener(event: "error", listener: ErrorListener): this
removeListener(event: "data", listener: DataListener): this

- Defined in src/connection/ElkConnection.ts:47
Parameters
- event: "connecting" | "connected" | "disconnecting"
- listener: StateChangeListener
Returns this
- Defined in src/connection/ElkConnection.ts:51
Parameters
- event: "disconnected"
- listener: DisconnectedListener
Returns this
- Defined in src/connection/ElkConnection.ts:52
Parameters
- event: "error"
- listener: ErrorListener
Returns this
- Defined in src/connection/ElkConnection.ts:53
Parameters
- event: "data"
- listener: DataListener
Returns this

write

write(data: string): Promise<unknown>

- Defined in src/connection/ElkConnection.ts:93
Parameters
- data: string
Returns Promise<unknown>

Generated using TypeDoc

Hierarchy

Implemented by

Index

Events

Properties

Methods

Events

addListener

Parameters

event: "connecting" | "connected" | "disconnecting"

listener: StateChangeListener

Returns this

Parameters

event: "disconnected"

listener: DisconnectedListener

Returns this

Parameters

event: "error"

listener: ErrorListener

Returns this

Parameters

event: "data"

listener: DataListener

Returns this

Properties

state

Methods

connect

Returns Promise<ElkConnection>

disconnect

Returns Promise<ElkConnection>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

Parameters

event: "connecting" | "connected" | "disconnecting"

previousState: ElkConnectionState

Returns void

Parameters

event: "disconnected"

previousState: ElkConnectionState

Optional error: Error

Returns void

Parameters

event: "error"

error: Error

Returns void

Parameters

event: "data"

data: string

Returns void

on

Parameters

event: "connecting" | "connected" | "disconnecting"

listener: StateChangeListener

Returns this

Parameters

event: "disconnected"

listener: DisconnectedListener

Returns this

Parameters

event: "error"

listener: ErrorListener

Returns this

Parameters

event: "data"

listener: DataListener

Returns this

once

Parameters

event: "connecting" | "connected" | "disconnecting"

listener: StateChangeListener

Returns this

Parameters

event: "disconnected"

listener: DisconnectedListener

Returns this

Parameters