Class BaseSocket

Hierarchy

TypedEventEmitter<BaseSocketEvents>
- BaseSocket

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseSocket(): BaseSocket

Inherited from TypedEventEmitter<BaseSocketEvents>.constructor
- Defined in src/utils/TypedEventEmitter.ts:4
Returns BaseSocket

Properties

bytesReceived

bytesReceived: number = 0

bytesSent

bytesSent: number = 0

Methods

addListener

addListener<E>(event: E, listener: BaseSocketEvents[E]): BaseSocket

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

connect

connect(port: number, host: string): void

- Defined in src/structures/BaseSocket.ts:13
Parameters
- port: number
- host: string
Returns void

disconnect

disconnect(): void

- Defined in src/structures/BaseSocket.ts:17
Returns void

emit

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

Inherited from TypedEventEmitter.emit
- Defined in node_modules/typed-emitter/index.d.ts:34
Type parameters
- E: keyof BaseSocketEvents
Parameters
- event: E
- Rest ...args: Arguments<BaseSocketEvents[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

listenerCount

listenerCount<E>(event: E): number

Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:38
Type parameters
- E: keyof BaseSocketEvents
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 BaseSocketEvents
Parameters
- event: E
Returns Function[]

off

off<E>(event: E, listener: BaseSocketEvents[E]): BaseSocket

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

on

on<E>(event: E, listener: BaseSocketEvents[E]): BaseSocket

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

once

once<E>(event: E, listener: BaseSocketEvents[E]): BaseSocket

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

prependListener

prependListener<E>(event: E, listener: BaseSocketEvents[E]): BaseSocket

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

prependOnceListener

prependOnceListener<E>(event: E, listener: BaseSocketEvents[E]): BaseSocket

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

rawListeners

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

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

removeAllListeners

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

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

removeListener

removeListener<E>(event: E, listener: BaseSocketEvents[E]): BaseSocket

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

send

send(buffer: Buffer): void

- Defined in src/structures/BaseSocket.ts:22
Parameters
- buffer: Buffer
Returns void

setMaxListeners

setMaxListeners(maxListeners: number): BaseSocket

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

Generated using TypeDoc