signals

import {...} from "@wangyaoshen/locus-core/lib/signals";

Value wrappers for easy dependency tracking and cache invalidation.

Classes​

• CompoundSignalContext
• ComputedContext
• DeferredEffectContext
• DependencyContext
• EffectContext
• SignalContext
• Vector2SignalContext

Interfaces​

• Computed
• PromiseHandle
• Signal
• SignalExtensions
• SignalGetter
• SignalSetter
• SignalTween
• Vector2Edit
• Vector2Operation
• Vector2SignalHelpers

Type Aliases​

Variables​

DEFAULT​

const DEFAULT: typeof DEFAULT = ...

Functions​

createComputed​

public createComputedfactory: ...args: any[] => TValueowner?: any: ComputedTValue

Parameters

• factory: ...args: any[] => TValue
• owner?: any

createComputedAsync​

public createComputedAsyncfactory: () => PromiseT: ComputednullT

public createComputedAsyncfactory: () => PromiseTinitial: T: ComputedT

Parameters

• factory: () => PromiseT

createDeferredEffect​

public createDeferredEffectcallback: () => void: () => void

Invoke the callback at the end of each frame if any of its dependencies changed.

Parameters

• callback: () => void

  The callback to invoke.

createEffect​

public createEffectcallback: () => void: () => void

Invoke the callback immediately after any of its dependencies change.

Parameters

• callback: () => void

  The callback to invoke.

createSignal​

public createSignalinitial?: SignalValueTValueinterpolation: InterpolationFunctionTValue = deepLerpowner?: TOwner: SimpleSignalTValueTOwner

Parameters

• initial?: SignalValueTValue
• interpolation: InterpolationFunctionTValue = deepLerp
• owner?: TOwner

isReactive​

public isReactivevalue: SignalValueT: value is () => T

Parameters

• value: SignalValueT

modify​

public modifyvalue: SignalValueTFrommodification: value: TFrom => TTo: SignalValueTTo

Parameters

• value: SignalValueTFrom
• modification: value: TFrom => TTo

unwrap​

public unwrapvalue: SignalValueT: T

Parameters

• value: SignalValueT