Class Counter

A counter primitive that can be incremented, decremented, and waited upon.

Example

const counter = new Counter(0);

// Increment the counter
counter.increment();
// Decrement the counter
counter.decrement();

// Wait for the counter to reach a specific value
await counter.wait(5);

Index

Constructors

constructor

new Counter(initialValue?: number): Counter
Creates a new Counter instance.
Parameters
- initialValue: number = 0
  The initial value of the counter. Default is 0.
Returns Counter
- Defined in packages/misc-util/src/async/synchro/counter.ts:32

Accessors

value

get value(): number
Returns number
- Defined in packages/misc-util/src/async/synchro/counter.ts:36

Methods

decrement

decrement(): number
Decrements the counter by one.

Returns number
The new value of the counter after decrementing.
- Defined in packages/misc-util/src/async/synchro/counter.ts:63

increment

increment(): number
Increments the counter by one.

Returns number
The new value of the counter after incrementing.
- Defined in packages/misc-util/src/async/synchro/counter.ts:53

reset

reset(): void
Resets the counter to zero.

Returns void
- Defined in packages/misc-util/src/async/synchro/counter.ts:43

wait

wait(targetValue: number, signal?: AbortSignal | null): Promise<void>
Waits until the counter reaches the specified target value.
Parameters
- targetValue: number
  The value to wait for.
- Optionalsignal: AbortSignal | null
  An optional AbortSignal to cancel the wait.
Returns Promise<void>
- Defined in packages/misc-util/src/async/synchro/counter.ts:74

Class Counter

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Counter

Accessors

value

Returns number

Methods

decrement

Returns number

increment

Returns number

reset

Returns void

wait

Parameters

Returns Promise<void>

Settings

On This Page