Skip to main content

FiltersSignalContext

class FiltersSignalContextTOwner extends SignalContextFilter[]Filter[]TOwner

Type Parameters

Constructors

constructor

public override new FiltersSignalContextinitial: Filter[]owner: TOwner: FiltersSignalContextTOwner

Parameters

Overwrites SignalContext< Filter[], Filter[], TOwner >.constructor

Methods

dispose

public dispose(): void
Inherited from SignalContext.dispose

get

public get(): Filter[]
Inherited from SignalContext.get

getInitial

public getInitial(): undefinedSignalValueFilter[]

Get the initial value of this signal.

Inherited from SignalContext.getInitial

getter

public getter(): Filter[]
Inherited from SignalContext.getter

isInitial

public isInitial(): boolean

Check if the signal is currently using its initial value.

Examples

Inherited from SignalContext.isInitial

isTweening

public isTweening(): boolean

Is the signal undergoing a tween?

Inherited from SignalContext.isTweening

parse

public parsevalue: Filter[]: Filter[]

Parameters

Inherited from SignalContext.parse

raw

public raw(): undefinedSignalValueFilter[]

Get the raw value of this signal.

If the signal was provided with a factory function, the function itself will be returned, without invoking it.

This method can be used to create copies of signals.

Examples

Inherited from SignalContext.raw

reset

public reset(): TOwner

Reset the signal to its initial value (if one has been set).

Examples

Inherited from SignalContext.reset

save

public save(): TOwner

Compute the current value of the signal and immediately set it.

This method can be used to stop the signal from updating while keeping its current value.

Examples

Inherited from SignalContext.save

set

public setvalue: typeof DEFAULTSignalValueFilter[]: TOwner

Parameters

Inherited from SignalContext.set

setter

public settervalue: typeof DEFAULTSignalValueFilter[]: TOwner

Parameters

Inherited from SignalContext.setter

toPromise

public toPromise(): PromiseFiltersSignalContextTOwner
Inherited from SignalContext.toPromise

toSignal

public toSignal(): SignalFilter[]Filter[]TOwner
Inherited from SignalContext.toSignal

tweener

Parameters

Overwrites SignalContext.tweener

collectPromise

static public collectPromisepromise: PromiseT: PromiseHandlenullT
static public collectPromisepromise: PromiseTinitialValue: T: PromiseHandleT

Parameters

Inherited from SignalContext.collectPromise

consumePromises

static public consumePromises(): PromisePromiseHandleany[]
Inherited from SignalContext.consumePromises

hasPromises

static public hasPromises(): boolean
Inherited from SignalContext.hasPromises