@revideo/core / signals / Signal
Interface: Signal()<TSetterValue, TValue, TOwner, TContext>
Defined in: signals/SignalContext.ts:24
Extends
SignalSetter<TSetterValue,TOwner>.SignalGetter<TValue>.SignalTween<TSetterValue,TValue>
Type Parameters
TSetterValue
TSetterValue
TValue
TValue extends TSetterValue
TOwner
TOwner = void
TContext
TContext = SignalContext<TSetterValue, TValue, TOwner>
Call Signature
Signal(
value):TOwner
Defined in: signals/SignalContext.ts:24
Parameters
value
typeof DEFAULT | SignalValue<TSetterValue>
Returns
TOwner
Call Signature
Signal():
TValue
Defined in: signals/SignalContext.ts:24
Returns
TValue
Call Signature
Signal(
value,time,timingFunction?,interpolationFunction?):SignalGenerator<TSetterValue,TValue>
Defined in: signals/SignalContext.ts:24
Parameters
value
typeof DEFAULT | SignalValue<TSetterValue>
time
number
timingFunction?
interpolationFunction?
InterpolationFunction<TValue, any[]>
Returns
SignalGenerator<TSetterValue, TValue>
Properties
context
context:
TContext
Defined in: signals/SignalContext.ts:47
Methods
isInitial()
isInitial():
boolean
Defined in: signals/SignalContext.ts:45
Check if the signal is currently using its initial value.
Returns
boolean
reset()
reset():
TOwner
Defined in: signals/SignalContext.ts:35
Reset the signal to its initial value (if one has been set).
Returns
TOwner
save()
save():
TOwner
Defined in: signals/SignalContext.ts:40
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.