ixfx
    Preparing search index...

    Type Alias ValueToPingOptions<TUpstream>

    ValueToPingOptions: {
        gate: (value: TUpstream) => boolean;
        lazy: Lazy;
        signal: AbortSignal;
    }

    Type Parameters

    • TUpstream

    Type declaration

    • gate: (value: TUpstream) => boolean

      If set, this function acts as a threshold gate. If the function returns true the upstream value will trigger a ping Otherwise the value won't trigger a ping.

      By default all values trigger a ping.

    • lazy: Lazy

      Laziness

      • start: only begins on first subscriber. Keeps running even when there are no subscribers
      • very: only begins on first subscriber. Stops looping if there are no subscribers
      • never: begins calling function when initalised and doesn't stop until Reactive is disposed
    • signal: AbortSignal

      If specified, signal is checked to prevent function execution. Also used for aborting a looped fromFunction.