Counter

Hierarchy

• ControlBlock

  ↳ Counter

Table of contents

Constructors

• constructor

Properties

• uid

Methods

• close
• decrease
• increase
• off
• on
• reset
• set
• update

Constructors

constructor

new Counter(uid?, opts?)

Define a counter

Parameters

Name	Type	Description
uid?	string	Optional, provides recallable uid
opts?	CounterOpts

Inherited from

ControlBlock.constructor

Properties

uid

Readonly uid: string

Inherited from

ControlBlock.uid

Methods

close

close(): void

Returns

void

Inherited from

ControlBlock.close

---

decrease

decrease(): void

Decrease the counter by the step value

Returns

void

---

increase

increase(): void

Increase the counter by the step value

Returns

void

---

off

off(event, handler): any

Parameters

Name	Type
event	string
handler	any

Returns

any

Inherited from

ControlBlock.off

---

on

on(event, listener): Counter

Parameters

Name	Type
event	"increase"
listener	(output: number) => void

Returns

Counter

Inherited from

ControlBlock.on

on(event, listener): Counter

Parameters

Name	Type
event	"decrease"
listener	(output: number) => void

Returns

Counter

on(event, listener): Counter

Parameters

Name	Type
event	"change"
listener	(output: number) => void

Returns

Counter

on(event, listener): Counter

Parameters

Name	Type
event	"reset"
listener	(output: number) => void

Returns

Counter

on(event, listener): Counter

Parameters

Name	Type
event	"output"
listener	(output: string) => void

Returns

Counter

---

reset

reset(): void

Reset the counter

Returns

void

---

set

set(value): void

Set the counter to value

Parameters

Name	Type
value	number

Returns

void

---

update

update(opts): void

Update the counter settings

Function

setup

Parameters

Name	Type	Description
opts	CounterOpts	start?: number,

Returns

void