Latch

Hierarchy

• ControlBlock

  ↳ Latch

Table of contents

Constructors

• constructor

Properties

• uid

Methods

• close
• off
• on
• setState

Constructors

constructor

new Latch(uid, opts?)

Provides a latch function with cached state

Parameters

Name	Type	Description
uid	string	A unique identifier the latch
opts?	Object	A default_state for the latch
opts.default_state?	boolean	-

Overrides

ControlBlock.constructor

Properties

uid

Readonly uid: string

Inherited from

ControlBlock.uid

Methods

close

close(): void

Returns

void

Inherited from

ControlBlock.close

---

off

off(event, handler): any

Parameters

Name	Type
event	string
handler	any

Returns

any

Inherited from

ControlBlock.off

---

on

on(event, handler): any

Parameters

Name	Type
event	string
handler	any

Returns

any

Inherited from

ControlBlock.on

---

setState

setState(state): void

Set the state of the latch

Parameters

Name	Type	Description
state	string | number | boolean	The state to set the toggle to

Returns

void