Signal
import type { Signal } from 'pixi-silk/signal';
A value you can read, watch and change.
Extends#
ReadSignal<T>
Type Parameters#
| Type Parameter |
|---|
T |
Properties#
| Property | Type | Description | Overrides | Defined in |
|---|---|---|---|---|
value | T | Current value. Assigning an equal value does nothing, otherwise listeners run. | ReadSignal.value | signal.ts:22 |
Methods#
set()#
set(value: T): void;
Same as assigning value.
Parameters#
| Parameter | Type |
|---|---|
value | T |
Returns#
void
subscribe()#
subscribe(fn: Listener<T>): () => void;
Calls fn on every change, not with the current value. Returns the unsubscribe function.
Parameters#
| Parameter | Type |
|---|---|
fn | Listener<T> |
Returns#
() => void
Inherited from#
update()#
update(fn: (value: T) => T): void;
Sets the value to fn(current).
Parameters#
| Parameter | Type |
|---|---|
fn | (value: T) => T |
Returns#
void