@revideo/core

@revideo/core / signals / CompoundSignalContext

Class: CompoundSignalContext<TSetterValue, TValue, TKeys, TOwner>

Defined in: signals/CompoundSignalContext.ts:24 

Extends

• SignalContext<TSetterValue, TValue, TOwner>

Type Parameters

TSetterValue

TSetterValue

TValue

TValue extends TSetterValue

TKeys

TKeys extends keyof TValue = keyof TValue

TOwner

TOwner = void

Constructors

Constructor

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

Defined in: signals/CompoundSignalContext.ts:32 

Parameters

entries

(TKeys | [keyof TValue, Signal<any, any, TOwner, SignalContext<any, any, TOwner>>])[]

parser

(value) => TValue

initial

SignalValue<TSetterValue>

interpolation

InterpolationFunction<TValue>

owner?

TOwner = ...

extensions?

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

Returns

CompoundSignalContext<TSetterValue, TValue, TKeys, TOwner>

Overrides

SignalContext.constructor

Properties

current

protected current: SignalValue<TSetterValue> | undefined

Defined in: signals/SignalContext.ts:56 

Inherited from

SignalContext.current

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 

Inherited from

SignalContext.extensions

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 

Inherited from

SignalContext.last

owner

protected owner: TOwner

Defined in: signals/DependencyContext.ts:65 

Inherited from

SignalContext.owner

parser

protected parser: (value) => TValue

Defined in: signals/SignalContext.ts:64 

Parameters

value

TSetterValue

Returns

TValue

Inherited from

SignalContext.parser

signals

readonly signals: [keyof TValue, Signal<any, any, TOwner, SignalContext<any, any, TOwner>>][] = []

Defined in: signals/CompoundSignalContext.ts:30 

tweening

protected tweening: boolean = false

Defined in: signals/SignalContext.ts:58 

Inherited from

SignalContext.tweening

collectionSet

protected static collectionSet: Set<DependencyContext<any>>

Defined in: signals/DependencyContext.ts:16 

Inherited from

SignalContext.collectionSet

collectionStack

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

Defined in: signals/DependencyContext.ts:17 

Inherited from

SignalContext.collectionStack

promises

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

Defined in: signals/DependencyContext.ts:18 

Inherited from

SignalContext.promises

Methods

clearDependencies()

protected clearDependencies(): void

Defined in: signals/DependencyContext.ts:101 

Returns

void

Inherited from

SignalContext.clearDependencies

collect()

protected collect(): void

Defined in: signals/DependencyContext.ts:106 

Returns

void

Inherited from

SignalContext.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>

Inherited from

SignalContext.createQueue

dispose()

dispose(): void

Defined in: signals/SignalContext.ts:277 

Returns

void

Inherited from

SignalContext.dispose

finishCollecting()

protected finishCollecting(): void

Defined in: signals/DependencyContext.ts:94 

Returns

void

Inherited from

SignalContext.finishCollecting

get()

get(): TValue

Defined in: signals/SignalContext.ts:129 

Returns

TValue

Inherited from

SignalContext.get

getInitial()

getInitial(): SignalValue<TSetterValue> | undefined

Defined in: signals/SignalContext.ts:345 

Get the initial value of this signal.

Returns

SignalValue<TSetterValue> | undefined

Inherited from

SignalContext.getInitial

getter()

getter(): TValue

Defined in: signals/CompoundSignalContext.ts:78 

Returns

TValue

Overrides

SignalContext.getter

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>

Inherited from

SignalContext.invoke

isInitial()

isInitial(): boolean

Defined in: signals/CompoundSignalContext.ts:117 

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

Overrides

SignalContext.isInitial

isTweening()

isTweening(): boolean

Defined in: signals/SignalContext.ts:379 

Is the signal undergoing a tween?

Returns

boolean

Inherited from

SignalContext.isTweening

markDirty()

protected markDirty(): void

Defined in: signals/DependencyContext.ts:63 

Returns

void

Inherited from

SignalContext.markDirty

parse()

parse(value): TValue

Defined in: signals/CompoundSignalContext.ts:74 

Parameters

value

TSetterValue

Returns

TValue

Overrides

SignalContext.parse

raw()

raw(): TSetterValue

Defined in: signals/CompoundSignalContext.ts:126 

Get the raw value of this signal.

Returns

TSetterValue

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

Overrides

SignalContext.raw

reset()

reset(): TOwner

Defined in: signals/CompoundSignalContext.ts:103 

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);

Overrides

SignalContext.reset

save()

save(): TOwner

Defined in: signals/CompoundSignalContext.ts:110 

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());

Overrides

SignalContext.save

set()

set(value): TOwner

Defined in: signals/SignalContext.ts:104 

Parameters

value

SignalValue<TSetterValue> | typeof DEFAULT

Returns

TOwner

Inherited from

SignalContext.set

setter()

setter(value): TOwner

Defined in: signals/CompoundSignalContext.ts:88 

Parameters

value

SignalValue<TValue>

Returns

TOwner

Overrides

SignalContext.setter

startCollecting()

protected startCollecting(): void

Defined in: signals/DependencyContext.ts:81 

Returns

void

Inherited from

SignalContext.startCollecting

toPromise()

toPromise(): Promise<CompoundSignalContext<TSetterValue, TValue, TKeys, TOwner>>

Defined in: signals/DependencyContext.ts:120 

Returns

Promise<CompoundSignalContext<TSetterValue, TValue, TKeys, TOwner>>

Inherited from

SignalContext.toPromise

toSignal()

toSignal(): CompoundSignal<TSetterValue, TValue, TKeys, TOwner>

Defined in: signals/CompoundSignalContext.ts:65 

Returns

CompoundSignal<TSetterValue, TValue, TKeys, TOwner>

Overrides

SignalContext.toSignal

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

Inherited from

SignalContext.tween

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

Inherited from

SignalContext.tweener

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

SignalContext.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

SignalContext.collectPromise

consumePromises()

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

Defined in: signals/DependencyContext.ts:52 

Returns

Promise<PromiseHandle<any>[]>

Inherited from

SignalContext.consumePromises

hasPromises()

static hasPromises(): boolean

Defined in: signals/DependencyContext.ts:48 

Returns

boolean

Inherited from

SignalContext.hasPromises