@valoranchi/riot-client / index / RiotEvents

Class: RiotEvents

Defined in: src/events/RiotEvents.ts:51

Extends

• TypedEmitter<RiotEventMap>

Constructors

Constructor

new RiotEvents(socket, chatApi, catalogueLoader, puuidResolver): RiotEvents

Defined in: src/events/RiotEvents.ts:70

Parameters

socket

RiotSocket

chatApi

ChatApi

catalogueLoader

CatalogueLoader

puuidResolver

PuuidResolver

Returns

RiotEvents

Overrides

TypedEmitter.constructor

Methods

emit()

emit<E>(event, ...args): boolean

Defined in: src/events/TypedEmitter.ts:21

Type Parameters

E

E extends "party" | "raw" | "message" | "error" | "connected" | "disconnected" | "friend:presence" | "friend:added" | "friend:removed" | "friend:request" | "game" | "self:state"

Parameters

event

E

args

...RiotEventMap[E]

Returns

boolean

Inherited from

TypedEmitter.emit

---

listenerCount()

listenerCount<E>(event): number

Defined in: src/events/TypedEmitter.ts:33

Type Parameters

E

E extends "party" | "raw" | "message" | "error" | "connected" | "disconnected" | "friend:presence" | "friend:added" | "friend:removed" | "friend:request" | "game" | "self:state"

Parameters

event

E

Returns

number

Inherited from

TypedEmitter.listenerCount

---

off()

off<E>(event, listener): this

Defined in: src/events/TypedEmitter.ts:11

Type Parameters

E

E extends "party" | "raw" | "message" | "error" | "connected" | "disconnected" | "friend:presence" | "friend:added" | "friend:removed" | "friend:request" | "game" | "self:state"

Parameters

event

E

listener

(...args) => void

Returns

this

Inherited from

TypedEmitter.off

---

on()

on<E>(event, listener): this

Defined in: src/events/TypedEmitter.ts:6

Type Parameters

E

E extends "party" | "raw" | "message" | "error" | "connected" | "disconnected" | "friend:presence" | "friend:added" | "friend:removed" | "friend:request" | "game" | "self:state"

Parameters

event

E

listener

(...args) => void

Returns

this

Inherited from

TypedEmitter.on

---

once()

once<E>(event, listener): this

Defined in: src/events/TypedEmitter.ts:16

Type Parameters

E

E extends "party" | "raw" | "message" | "error" | "connected" | "disconnected" | "friend:presence" | "friend:added" | "friend:removed" | "friend:request" | "game" | "self:state"

Parameters

event

E

listener

(...args) => void

Returns

this

Inherited from

TypedEmitter.once

---

refreshFriends()

refreshFriends(): Promise<void>

Defined in: src/events/RiotEvents.ts:102

Returns

Promise<void>

---

removeAllListeners()

removeAllListeners<E>(event?): this

Defined in: src/events/TypedEmitter.ts:28

Type Parameters

E

E extends "party" | "raw" | "message" | "error" | "connected" | "disconnected" | "friend:presence" | "friend:added" | "friend:removed" | "friend:request" | "game" | "self:state"

Parameters

event?

E

Returns

this

Inherited from

TypedEmitter.removeAllListeners

---

start()

start(): this

Defined in: src/events/RiotEvents.ts:85

Returns

this

---

stop()

stop(): void

Defined in: src/events/RiotEvents.ts:90

Returns

void