@valoranchi/riot-client / index / FriendsWatcher

Class: FriendsWatcher

Defined in: src/watch/FriendsWatcher.ts:21

Extends

• TypedEmitter<FriendsWatchEventMap>

Constructors

Constructor

new FriendsWatcher(events, options?): FriendsWatcher

Defined in: src/watch/FriendsWatcher.ts:36

Parameters

events

RiotEvents

options?

FriendsWatcherOptions = {}

Returns

FriendsWatcher

Overrides

TypedEmitter.constructor

Methods

[asyncIterator]()

[asyncIterator](): AsyncIterableIterator<FriendsWatchItem>

Defined in: src/watch/FriendsWatcher.ts:103

Returns

AsyncIterableIterator<FriendsWatchItem>

---

emit()

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

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

Type Parameters

E

E extends "online" | "offline" | "message" | "error" | "request" | "in-game" | "out-of-game"

Parameters

event

E

args

...FriendsWatchEventMap[E]

Returns

boolean

Inherited from

TypedEmitter.emit

---

listenerCount()

listenerCount<E>(event): number

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

Type Parameters

E

E extends "online" | "offline" | "message" | "error" | "request" | "in-game" | "out-of-game"

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 "online" | "offline" | "message" | "error" | "request" | "in-game" | "out-of-game"

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 "online" | "offline" | "message" | "error" | "request" | "in-game" | "out-of-game"

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 "online" | "offline" | "message" | "error" | "request" | "in-game" | "out-of-game"

Parameters

event

E

listener

(...args) => void

Returns

this

Inherited from

TypedEmitter.once

---

removeAllListeners()

removeAllListeners<E>(event?): this

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

Type Parameters

E

E extends "online" | "offline" | "message" | "error" | "request" | "in-game" | "out-of-game"

Parameters

event?

E

Returns

this

Inherited from

TypedEmitter.removeAllListeners

---

start()

start(): this

Defined in: src/watch/FriendsWatcher.ts:44

Returns

this

---

stop()

stop(): void

Defined in: src/watch/FriendsWatcher.ts:82

Returns

void