Class RCONClient

Hierarchy

TypedEmitter<IRCONClientEvents>
- RCONClient

Index

Constructors

Properties

ip password port socket defaultMaxListeners

Constructors

constructor

new RCONClient(opts: RCONClientOptions): RCONClient
Parameters
- opts: RCONClientOptions
Returns RCONClient
Overrides TypedEmitter<IRCONClientEvents>.constructor
- Defined in src/rcon.ts:28

Properties

`Private` `Readonly` ip

ip: string = '127.0.0.1'

`Private` password

password: string

`Private` `Readonly` port

port: number = 7777

`Private` socket

socket: Socket = ...

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener<U>(event: U, listener: IRCONClientEvents[U]): RCONClient
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- event: U
- listener: IRCONClientEvents[U]
Returns RCONClient
Inherited from TypedEmitter.addListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:11

call

call(cmd: string, responseTimeout?: number): Promise<string>
Parameters
- cmd: string
- responseTimeout: number = 5000
Returns Promise<string>
- Defined in src/rcon.ts:82

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in src/rcon.ts:37

disconnect

disconnect(): void
Returns void
- Defined in src/rcon.ts:46

emit

emit<U>(event: U, ...args: Parameters<IRCONClientEvents[U]>): boolean
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- event: U
- Rest ...args: Parameters<IRCONClientEvents[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames<U>(): U[]
Type Parameters
- U extends keyof IRCONClientEvents
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:20

getMaxListeners

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

listenerCount

listenerCount(type: keyof IRCONClientEvents): number
Parameters
- type: keyof IRCONClientEvents
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners<U>(type: U): IRCONClientEvents[U][]
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- type: U
Returns IRCONClientEvents[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off<U>(event: U, listener: IRCONClientEvents[U]): RCONClient
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- event: U
- listener: IRCONClientEvents[U]
Returns RCONClient
Inherited from TypedEmitter.off
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on<U>(event: U, listener: IRCONClientEvents[U]): RCONClient
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- event: U
- listener: IRCONClientEvents[U]
Returns RCONClient
Inherited from TypedEmitter.on
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:17

`Private` onReceive

onReceive(message: Buffer): void
Parameters
- message: Buffer
Returns void
- Defined in src/rcon.ts:50

once

once<U>(event: U, listener: IRCONClientEvents[U]): RCONClient
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- event: U
- listener: IRCONClientEvents[U]
Returns RCONClient
Inherited from TypedEmitter.once
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:16

prependListener

prependListener<U>(event: U, listener: IRCONClientEvents[U]): RCONClient
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- event: U
- listener: IRCONClientEvents[U]
Returns RCONClient
Inherited from TypedEmitter.prependListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener<U>(event: U, listener: IRCONClientEvents[U]): RCONClient
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- event: U
- listener: IRCONClientEvents[U]
Returns RCONClient
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners<U>(type: U): IRCONClientEvents[U][]
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- type: U
Returns IRCONClientEvents[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?: keyof IRCONClientEvents): RCONClient
Parameters
- Optional event: keyof IRCONClientEvents
Returns RCONClient
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener<U>(event: U, listener: IRCONClientEvents[U]): RCONClient
Type Parameters
- U extends keyof IRCONClientEvents
Parameters
- event: U
- listener: IRCONClientEvents[U]
Returns RCONClient
Inherited from TypedEmitter.removeListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:14

send

send(cmd: string): void
Parameters
- cmd: string
Returns void
- Defined in src/rcon.ts:66

setMaxListeners

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

Generated using TypeDoc