Interface WritableTweenSignal<T>

Returned from returned from tweenSignal. It's like a writable a signal, but with extended options when setting and updating.

interface WritableTweenSignal<T> {
    [SIGNAL]: unknown;
    asReadonly(): Signal<T>;
    set(value: T, options?: TweenOptions<T>): void;
    setOptions(options: TweenOptions<T>): void;
    update(updateFn: ((value: T) => T), options?: TweenOptions<T>): void;
    (): T;
}

Type Parameters

T

Hierarchy (view full)

TweenSignal<T>
- WritableTweenSignal

WritableTweenSignal(): T
Returns T
- Defined in projects/signal-generators/src/lib/signals/tween-signal.ts:57

Index

Methods

asReadonly set setOptions update

Properties

Methods

asReadonly

asReadonly(): Signal<T>
Returns a readonly version of this signal

Returns Signal<T>
- Defined in projects/signal-generators/src/lib/signals/tween-signal.ts:63

set

set(value, options?): void
Sets the value of signal with optional options.
Parameters
- value: T
- Optionaloptions: TweenOptions<T>
Returns void
- Defined in projects/signal-generators/src/lib/signals/tween-signal.ts:59

setOptions

setOptions(options): void
Sets the default animation parameters for the signal. This won't updated a running animation.
Parameters
- options: TweenOptions<T>
Returns void
Inherited from TweenSignal.setOptions
- Defined in projects/signal-generators/src/lib/signals/tween-signal.ts:53

update

update(updateFn, options?): void
Update the value of the signal based on its current value.
Parameters
- updateFn: ((value: T) => T)
  - - (value): T
    - Parameters
      value: T
      Returns T
- Optionaloptions: TweenOptions<T>
Returns void
- Defined in projects/signal-generators/src/lib/signals/tween-signal.ts:61

Properties

[SIGNAL]

[SIGNAL]: unknown