Class ECO

Primary Interface Object for ECO servers.

Hierarchy

ECO

Index

Constructors

Properties

_conn _events _isAuthorized _responsePromiseQueue debug messageID onReady rconParser reconnect

Methods

_onError _onResponse _parseResponse disconnect on onEnd removeListener send

Constructors

constructor

new ECO(ip, port, password, options?): ECO
Parameters
- ip: string
- port: number
- password: string
- Optional options: ECOOptions
Returns ECO
- Defined in src/ECO.ts:184

Properties

`Protected` _conn

_conn: Rcon

_events

_events: EventEmitter<DefaultEventMap>

`Protected` _isAuthorized

_isAuthorized: boolean

`Protected` _responsePromiseQueue

_responsePromiseQueue: Map<number, ResponsePromiseQueueObject>

debug

debug: boolean = false

`Protected` messageID

messageID: number

onReady

onReady: Promise<null>

Rejects if an error occurs when connecting.

rconParser

rconParser: default

reconnect

reconnect: (() => Promise<unknown>)

Type declaration

- (): Promise<unknown>
- Reconnect to the client
  
  Returns Promise<unknown>

Methods

`Protected` _onError

_onError(err): void
Parameters
- err: string
Returns void
- Defined in src/ECO.ts:305

`Protected` _onResponse

_onResponse(response): void
Parameters
- response: RconResponse
Returns void
- Defined in src/ECO.ts:271

`Protected` _parseResponse

_parseResponse(res): unknown
Parameters
- res: string
Returns unknown
- Defined in src/ECO.ts:300

disconnect

disconnect(): void
Disconnect the client.

Returns void
- Defined in src/ECO.ts:297

on

on(event, cb): EventEmitter<DefaultEventMap>
Parameters
- event: "READY"
- cb: (() => void)
  - - (): void
    - Returns void
Returns EventEmitter<DefaultEventMap>
- Defined in src/ECO.ts:231

`Protected` onEnd

onEnd(): void
Returns void
- Defined in src/ECO.ts:311

removeListener

removeListener(event, cb): EventEmitter<DefaultEventMap>
Parameters
- event: string | symbol
- cb: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns EventEmitter<DefaultEventMap>
- Defined in src/ECO.ts:236

send

send(cmd): Promise<unknown>
Send a Raw RCON command.
Parameters
- cmd: string
Returns Promise<unknown>
- Defined in src/ECO.ts:243

Generated using TypeDoc