@valoranchi/riot-client / index / Instalock

Class: Instalock

Defined in: src/watch/Instalock.ts:60

Extends

• TypedEmitter<InstalockEventMap>

Implements

• InstalockHandle

Constructors

Constructor

new Instalock(watcher, matches, options, ownsWatcher?): Instalock

Defined in: src/watch/Instalock.ts:67

Parameters

watcher

MatchWatcher

matches

MatchesApi

options

InstalockOptions

ownsWatcher?

boolean = false

Returns

Instalock

Overrides

TypedEmitter.constructor

Methods

[asyncIterator]()

[asyncIterator](): AsyncIterableIterator<InstalockItem>

Defined in: src/watch/Instalock.ts:111

Returns

AsyncIterableIterator<InstalockItem>

Implementation of

InstalockHandle.[asyncIterator]

---

emit()

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

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

Type Parameters

E

E extends "locked" | "error" | "skipped"

Parameters

event

E

args

...InstalockEventMap[E]

Returns

boolean

Inherited from

TypedEmitter.emit

---

listenerCount()

listenerCount<E>(event): number

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

Type Parameters

E

E extends "locked" | "error" | "skipped"

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 "locked" | "error" | "skipped"

Parameters

event

E

listener

(...args) => void

Returns

this

Implementation of

InstalockHandle.off

Inherited from

TypedEmitter.off

---

on()

on<E>(event, listener): this

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

Type Parameters

E

E extends "locked" | "error" | "skipped"

Parameters

event

E

listener

(...args) => void

Returns

this

Implementation of

InstalockHandle.on

Inherited from

TypedEmitter.on

---

once()

once<E>(event, listener): this

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

Type Parameters

E

E extends "locked" | "error" | "skipped"

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 "locked" | "error" | "skipped"

Parameters

event?

E

Returns

this

Inherited from

TypedEmitter.removeAllListeners

---

stop()

stop(): void

Defined in: src/watch/Instalock.ts:94

Returns

void

Implementation of

InstalockHandle.stop