Class InSim

Hierarchy

TypedEventEmitter<InSimEvents>
- InSim

Index

Constructors

constructor

Properties

Accessors

initPacket

Constructors

constructor

new InSim(options: InSimOptions): InSim

Overrides TypedEventEmitter<InSimEvents>.constructor
- Defined in src/client/InSim.ts:45
Parameters
- options: InSimOptions
Returns InSim

Properties

logger

logger: Logger

packetHandler

packetHandler: PacketHandler

Private tcpSocket

tcpSocket: TcpSocket = ...

Private udpSocket

udpSocket: null = null

Accessors

Private initPacket

get initPacket(): IS_ISI

- Defined in src/client/InSim.ts:96
Returns IS_ISI

Methods

addListener

addListener<E>(event: E, listener: InSimEvents[E]): InSim

Inherited from TypedEventEmitter.addListener
- Defined in node_modules/typed-emitter/index.d.ts:24
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
- listener: InSimEvents[E]
Returns InSim

Private applyInternalHooks

applyInternalHooks(): void

- Defined in src/client/InSim.ts:100
Returns void

bind

bind<T>(packetType: PacketType, callback: (data: T) => void): void

- Defined in src/client/InSim.ts:79
Type parameters
- T = Packet
Parameters
- packetType: PacketType
- callback: (data: T) => void
  - - (data: T): void
    - Parameters
      - data: T
      Returns void
Returns void

connect

connect(): void

- Defined in src/client/InSim.ts:66
Returns void

disconnect

disconnect(): void

- Defined in src/client/InSim.ts:70
Returns void

emit

emit<E>(event: E, ...args: Arguments<InSimEvents[E]>): boolean

Inherited from TypedEventEmitter.emit
- Defined in node_modules/typed-emitter/index.d.ts:34
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
- Rest ...args: Arguments<InSimEvents[E]>
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from TypedEventEmitter.eventNames
- Defined in node_modules/typed-emitter/index.d.ts:35
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40
Returns number

Private handleSocketEvents

handleSocketEvents(): void

- Defined in src/client/InSim.ts:109
Returns void

listenerCount

listenerCount<E>(event: E): number

Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:38
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
Returns number

listeners

listeners<E>(event: E): Function[]

Inherited from TypedEventEmitter.listeners
- Defined in node_modules/typed-emitter/index.d.ts:37
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
Returns Function[]

off

off<E>(event: E, listener: InSimEvents[E]): InSim

Inherited from TypedEventEmitter.off
- Defined in node_modules/typed-emitter/index.d.ts:30
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
- listener: InSimEvents[E]
Returns InSim

on

on<E>(event: E, listener: InSimEvents[E]): InSim

Inherited from TypedEventEmitter.on
- Defined in node_modules/typed-emitter/index.d.ts:25
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
- listener: InSimEvents[E]
Returns InSim

once

once<E>(event: E, listener: InSimEvents[E]): InSim

Inherited from TypedEventEmitter.once
- Defined in node_modules/typed-emitter/index.d.ts:26
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
- listener: InSimEvents[E]
Returns InSim

prependListener

prependListener<E>(event: E, listener: InSimEvents[E]): InSim

Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/typed-emitter/index.d.ts:27
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
- listener: InSimEvents[E]
Returns InSim

prependOnceListener

prependOnceListener<E>(event: E, listener: InSimEvents[E]): InSim

Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:28
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
- listener: InSimEvents[E]
Returns InSim

rawListeners

rawListeners<E>(event: E): Function[]

Inherited from TypedEventEmitter.rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:36
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
Returns Function[]

reconnect

reconnect(): void

- Defined in src/client/InSim.ts:74
Returns void

removeAllListeners

removeAllListeners<E>(event?: E): InSim

Inherited from TypedEventEmitter.removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:31
Type parameters
- E: keyof InSimEvents
Parameters
- Optional event: E
Returns InSim

removeListener

removeListener<E>(event: E, listener: InSimEvents[E]): InSim

Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/typed-emitter/index.d.ts:32
Type parameters
- E: keyof InSimEvents
Parameters
- event: E
- listener: InSimEvents[E]
Returns InSim

send

send(packet: Packet): void

- Defined in src/client/InSim.ts:87
Parameters
- packet: Packet
Returns void

sendMessage

sendMessage(message: string, args?: string[]): void

- Defined in src/client/InSim.ts:92
Parameters
- message: string
- args: string[] = []
Returns void

setMaxListeners

setMaxListeners(maxListeners: number): InSim

Inherited from TypedEventEmitter.setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:41
Parameters
- maxListeners: number
Returns InSim

unbind

unbind<T>(packetType: PacketType, callback: (data: T) => void): void

- Defined in src/client/InSim.ts:83
Type parameters
- T = Packet
Parameters
- packetType: PacketType
- callback: (data: T) => void
  - - (data: T): void
    - Parameters
      - data: T
      Returns void
Returns void

Generated using TypeDoc