@valoranchi/riot-client / index / StoreWatcher

Class: StoreWatcher

Defined in: src/watch/StoreWatcher.ts:13

Extends

• TypedEmitter<StoreWatchEventMap>

Constructors

Constructor

new StoreWatcher(store, options?): StoreWatcher

Defined in: src/watch/StoreWatcher.ts:24

Parameters

store

StoreApi

options?

StoreWatcherOptions = {}

Returns

StoreWatcher

Overrides

TypedEmitter.constructor

Methods

[asyncIterator]()

[asyncIterator](): AsyncIterableIterator<StoreWatchItem>

Defined in: src/watch/StoreWatcher.ts:68

Returns

AsyncIterableIterator<StoreWatchItem>

---

check()

check(): Promise<void>

Defined in: src/watch/StoreWatcher.ts:77

Returns

Promise<void>

---

emit()

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

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

Type Parameters

E

E extends "error" | "hit"

Parameters

event

E

args

...StoreWatchEventMap[E]

Returns

boolean

Inherited from

TypedEmitter.emit

---

listenerCount()

listenerCount<E>(event): number

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

Type Parameters

E

E extends "error" | "hit"

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 "error" | "hit"

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 "error" | "hit"

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 "error" | "hit"

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 "error" | "hit"

Parameters

event?

E

Returns

this

Inherited from

TypedEmitter.removeAllListeners

---

start()

start(): this

Defined in: src/watch/StoreWatcher.ts:35

Returns

this

---

stop()

stop(): void

Defined in: src/watch/StoreWatcher.ts:48

Returns

void