@revideo/core

@revideo/core / signals / SignalContext

Class: SignalContext<TSetterValue, TValue, TOwner>

Defined in: signals/SignalContext.ts:50 

Extends

• DependencyContext<TOwner>

Extended by

• CompoundSignalContext

Type Parameters

TSetterValue

TSetterValue

TValue

TValue extends TSetterValue = TSetterValue

TOwner

TOwner = void

Constructors

Constructor

new SignalContext<TSetterValue, TValue, TOwner>(initial, interpolation, owner?, parser?, extensions?): SignalContext<TSetterValue, TValue, TOwner>

Defined in: signals/SignalContext.ts:60 

Parameters

initial

SignalValue<TSetterValue> | undefined

interpolation

InterpolationFunction<TValue>

owner?

TOwner = ...

parser?

(value) => TValue

extensions?

Partial<SignalExtensions<TSetterValue, TValue>> = {}

Returns

SignalContext<TSetterValue, TValue, TOwner>

Overrides

DependencyContext.constructor

Properties

current

protected current: SignalValue<TSetterValue> | undefined

Defined in: signals/SignalContext.ts:56 

dependencies

protected dependencies: Set<Subscribable<void, EventHandler<void>>>

Defined in: signals/DependencyContext.ts:61 

Inherited from

DependencyContext.dependencies

event

protected event: FlagDispatcher

Defined in: signals/DependencyContext.ts:62 

Inherited from

DependencyContext.event

extensions

protected extensions: SignalExtensions<TSetterValue, TValue>

Defined in: signals/SignalContext.ts:55 

invokable

protected readonly invokable: any

Defined in: signals/DependencyContext.ts:59 

Inherited from

DependencyContext.invokable

last

protected last: TValue | undefined

Defined in: signals/SignalContext.ts:57 

owner

protected owner: TOwner

Defined in: signals/DependencyContext.ts:65 

Inherited from

DependencyContext.owner

parser

protected parser: (value) => TValue

Defined in: signals/SignalContext.ts:64 

Parameters

value

TSetterValue

Returns

TValue

tweening

protected tweening: boolean = false

Defined in: signals/SignalContext.ts:58 

collectionSet

protected static collectionSet: Set<DependencyContext<any>>

Defined in: signals/DependencyContext.ts:16 

Inherited from

DependencyContext.collectionSet

collectionStack

protected static collectionStack: DependencyContext<any>[] = []

Defined in: signals/DependencyContext.ts:17 

Inherited from

DependencyContext.collectionStack

promises

protected static promises: PromiseHandle<any>[] = []

Defined in: signals/DependencyContext.ts:18 

Inherited from

DependencyContext.promises

Methods

clearDependencies()

protected clearDependencies(): void

Defined in: signals/DependencyContext.ts:101 

Returns

void

Inherited from

DependencyContext.clearDependencies

collect()

protected collect(): void

Defined in: signals/DependencyContext.ts:106 

Returns

void

Inherited from

DependencyContext.collect

createQueue()

protected createQueue(defaultTimingFunction, defaultInterpolationFunction): SignalGenerator<TSetterValue, TValue>

Defined in: signals/SignalContext.ts:171 

Parameters

defaultTimingFunction

TimingFunction

defaultInterpolationFunction

InterpolationFunction<TValue>

Returns

SignalGenerator<TSetterValue, TValue>

dispose()

dispose(): void

Defined in: signals/SignalContext.ts:277 

Returns

void

Overrides

DependencyContext.dispose

finishCollecting()

protected finishCollecting(): void

Defined in: signals/DependencyContext.ts:94 

Returns

void

Inherited from

DependencyContext.finishCollecting

get()

get(): TValue

Defined in: signals/SignalContext.ts:129 

Returns

TValue

getInitial()

getInitial(): SignalValue<TSetterValue> | undefined

Defined in: signals/SignalContext.ts:345 

Get the initial value of this signal.

Returns

SignalValue<TSetterValue> | undefined

getter()

getter(): TValue

Defined in: signals/SignalContext.ts:133 

Returns

TValue

invoke()

protected invoke(value?, duration?, timingFunction?, interpolationFunction?): TValue | TOwner | SignalGenerator<TSetterValue, TValue>

Defined in: signals/SignalContext.ts:153 

Parameters

value?

SignalValue<TSetterValue> | typeof DEFAULT

duration?

number

timingFunction?

TimingFunction = easeInOutCubic

interpolationFunction?

InterpolationFunction<TValue> = ...

Returns

TValue | TOwner | SignalGenerator<TSetterValue, TValue>

Overrides

DependencyContext.invoke

isInitial()

isInitial(): boolean

Defined in: signals/SignalContext.ts:337 

Check if the signal is currently using its initial value.

Returns

boolean

Example

 
const signal = createSignal(0);
signal.isInitial(); // true
 
signal(5);
signal.isInitial(); // false
 
signal(DEFAULT);
signal.isInitial(); // true

isTweening()

isTweening(): boolean

Defined in: signals/SignalContext.ts:379 

Is the signal undergoing a tween?

Returns

boolean

markDirty()

protected markDirty(): void

Defined in: signals/DependencyContext.ts:63 

Returns

void

Inherited from

DependencyContext.markDirty

parse()

parse(value): TValue

Defined in: signals/SignalContext.ts:100 

Parameters

value

TSetterValue

Returns

TValue

raw()

raw(): SignalValue<TSetterValue> | undefined

Defined in: signals/SignalContext.ts:372 

Get the raw value of this signal.

Returns

SignalValue<TSetterValue> | undefined

Remarks

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.

Example

const a = createSignal(2);
const b = createSignal(() => a);
// b() == 2
 
const bClone = createSignal(b.raw());
// bClone() == 2
 
a(4);
// b() == 4
// bClone() == 4

reset()

reset(): TOwner

Defined in: signals/SignalContext.ts:296 

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

Returns

TOwner

Example

const signal = createSignal(7);
 
signal.reset();
// same as:
signal(7);

save()

save(): TOwner

Defined in: signals/SignalContext.ts:317 

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

Returns

TOwner

Remarks

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

Example

signal.save();
// same as:
signal(signal());

set()

set(value): TOwner

Defined in: signals/SignalContext.ts:104 

Parameters

value

SignalValue<TSetterValue> | typeof DEFAULT

Returns

TOwner

setter()

setter(value): TOwner

Defined in: signals/SignalContext.ts:109 

Parameters

value

SignalValue<TSetterValue> | typeof DEFAULT

Returns

TOwner

startCollecting()

protected startCollecting(): void

Defined in: signals/DependencyContext.ts:81 

Returns

void

Inherited from

DependencyContext.startCollecting

toPromise()

toPromise(): Promise<SignalContext<TSetterValue, TValue, TOwner>>

Defined in: signals/DependencyContext.ts:120 

Returns

Promise<SignalContext<TSetterValue, TValue, TOwner>>

Inherited from

DependencyContext.toPromise

toSignal()

toSignal(): Signal<TSetterValue, TValue, TOwner>

Defined in: signals/SignalContext.ts:96 

Returns

Signal<TSetterValue, TValue, TOwner>

tween()

protected tween(value, duration, timingFunction, interpolationFunction): ThreadGenerator

Defined in: signals/SignalContext.ts:238 

Parameters

value

SignalValue<TSetterValue> | typeof DEFAULT

duration

number

timingFunction

TimingFunction

interpolationFunction

InterpolationFunction<TValue>

Returns

ThreadGenerator

tweener()

tweener(value, duration, timingFunction, interpolationFunction): ThreadGenerator

Defined in: signals/SignalContext.ts:259 

Parameters

value

SignalValue<TSetterValue>

duration

number

timingFunction

TimingFunction

interpolationFunction

InterpolationFunction<TValue>

Returns

ThreadGenerator

collectPromise()

Call Signature

static collectPromise<T>(promise): PromiseHandle<T | null>

Defined in: signals/DependencyContext.ts:20 

Type Parameters

T

T

Parameters

promise

Promise<T>

Returns

PromiseHandle<T | null>

Inherited from

DependencyContext.collectPromise

Call Signature

static collectPromise<T>(promise, initialValue): PromiseHandle<T>

Defined in: signals/DependencyContext.ts:21 

Type Parameters

T

T

Parameters

promise

Promise<T>

initialValue

T

Returns

PromiseHandle<T>

Inherited from

DependencyContext.collectPromise

consumePromises()

static consumePromises(): Promise<PromiseHandle<any>[]>

Defined in: signals/DependencyContext.ts:52 

Returns

Promise<PromiseHandle<any>[]>

Inherited from

DependencyContext.consumePromises

hasPromises()

static hasPromises(): boolean

Defined in: signals/DependencyContext.ts:48 

Returns

boolean

Inherited from

DependencyContext.hasPromises