Skip to main content

signals

import {...} from "@motion-canvas/core/lib/signals";

Value wrappers for easy dependency tracking and cache invalidation.

Classes​

Interfaces​

Type Aliases​

CompoundSignal​

type CompoundSignalTSetterValueTValue extends TSetterValueTKeys extends keyof TValue = keyof TValueTOwner = voidTContext = CompoundSignalContextTSetterValueTValueTKeysTOwner = SignalTSetterValueTValueTOwnerTContext[K in TKeys]: SignalTValue[K]TValue[K]TOwner extends void ? CompoundSignalTSetterValueTValueTKeysTOwnerTContext : TOwner

Type Parameters

SignalGenerator​

type SignalGeneratorTSetterValueTValue extends TSetterValue = ThreadGeneratorback: public ()do: public ()run: public ()to: SignalTweenTSetterValueTValuewait: public ()

Type Parameters

SignalValue​

type SignalValueTValue = TValuepublic ()

Type Parameters

SimpleSignal​

type SimpleSignalTValueTReturn = void = SignalTValueTValueTReturn

Type Parameters

Variables​

DEFAULT​

const DEFAULT: typeof DEFAULT = ...

Functions​

createComputed​

public createComputedTValuefactory: public ()owner?: any: ComputedTValue

Type Parameters

Parameters

createComputedAsync​

public createComputedAsyncTfactory: public (): ComputedTnull
public createComputedAsyncTfactory: public ()initial: T: ComputedT

Type Parameters

Parameters

createSignal​

public createSignalTValueTOwner = voidinitial?: SignalValueTValueinterpolation: InterpolationFunctionTValueany[] = deepLerpowner?: TOwner: SimpleSignalTValueTOwner

Type Parameters

Parameters

isReactive​

public isReactiveTvalue: SignalValueT: value is public ()

Type Parameters

Parameters

modify​

public modifyTFromTTovalue: SignalValueTFrommodification: public (): SignalValueTTo

Type Parameters

Parameters

unwrap​

public unwrapTvalue: SignalValueT: T

Type Parameters

Parameters