Interface SequenceSignal<T>

interface SequenceSignal<T> {
    "[SIGNAL]": unknown;
    next(relativeChange?: number): void;
    reset(): void;
    set(value: T): void;
    update(updateFn: (value: T) => T): void;
    (): T;
}

Type Parameters

T

Hierarchy

Signal<T>
- SequenceSignal

SequenceSignal(): T
Returns T
- Defined in projects/signal-generators/src/lib/signals/sequence-signal.ts:30

Index

Methods

next reset set update

Properties

Methods

next

next(relativeChange?: number): void
Updates the signal to the next item in sequence.
If at end and the option SequenceSignalOptions.disableAutoReset was passed as true, then it will move to the start.
Parameters
- OptionalrelativeChange: number
Returns void
- Defined in projects/signal-generators/src/lib/signals/sequence-signal.ts:35

reset

reset(): void
Updates the signal to the first item in sequence.

Returns void
- Defined in projects/signal-generators/src/lib/signals/sequence-signal.ts:37

set

set(value: T): void
Moves the sequence to the next element that matches the passed value, ignoring the current element. Will throw if not found.
Parameters
- value: T
Returns void
- Defined in projects/signal-generators/src/lib/signals/sequence-signal.ts:39

update

update(updateFn: (value: T) => T): void
Moves the sequence to the next element that matches the passed value, ignoring the current element. Will throw if not found.
Parameters
- updateFn: (value: T) => T
Returns void
- Defined in projects/signal-generators/src/lib/signals/sequence-signal.ts:41

Properties

[SIGNAL]

"[SIGNAL]": unknown