Counter
Defined in: packages/async/src/synchro/counter.ts:17
A counter primitive that can be incremented, decremented, and waited upon.
Example
Section titled “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);Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Counter(
initialValue?):Counter
Defined in: packages/async/src/synchro/counter.ts:29
Creates a new Counter instance.
Parameters
Section titled “Parameters”initialValue?
Section titled “initialValue?”number = 0
The initial value of the counter. Default is 0.
Returns
Section titled “Returns”Counter
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get value():
number
Defined in: packages/async/src/synchro/counter.ts:33
Returns
Section titled “Returns”number
Methods
Section titled “Methods”decrement()
Section titled “decrement()”decrement():
number
Defined in: packages/async/src/synchro/counter.ts:58
Decrements the counter by one.
Returns
Section titled “Returns”number
The new value of the counter after decrementing.
increment()
Section titled “increment()”increment():
number
Defined in: packages/async/src/synchro/counter.ts:48
Increments the counter by one.
Returns
Section titled “Returns”number
The new value of the counter after incrementing.
reset()
Section titled “reset()”reset():
void
Defined in: packages/async/src/synchro/counter.ts:38
Resets the counter to zero.
Returns
Section titled “Returns”void
wait()
Section titled “wait()”wait(
targetValue,signal?):Promise<void>
Defined in: packages/async/src/synchro/counter.ts:69
Waits until the counter reaches the specified target value.
Parameters
Section titled “Parameters”targetValue
Section titled “targetValue”number
The value to wait for.
signal?
Section titled “signal?”AbortSignal | null
An optional AbortSignal to cancel the wait.
Returns
Section titled “Returns”Promise<void>