Skip to content
pixi-silk
GitHub repository
Interface

Signal

import type { Signal } from 'pixi-silk/signal';

A value you can read, watch and change.

Extends#

Type Parameters#

Type Parameter
T

Properties#

PropertyTypeDescriptionOverridesDefined in
valueTCurrent value. Assigning an equal value does nothing, otherwise listeners run.ReadSignal.valuesignal.ts:22

Methods#

set()#

set(value: T): void;

Same as assigning value.

Parameters#

ParameterType
valueT

Returns#

void


subscribe()#

subscribe(fn: Listener<T>): () => void;

Calls fn on every change, not with the current value. Returns the unsubscribe function.

Parameters#

ParameterType
fnListener<T>

Returns#

() => void

Inherited from#

ReadSignal.subscribe


update()#

update(fn: (value: T) => T): void;

Sets the value to fn(current).

Parameters#

ParameterType
fn(value: T) => T

Returns#

void