Type Alias PingedFunctionOptions

PingedFunctionOptions: {
    closeOnError: boolean;
    lazy: Lazy;
    predelay: Interval;
    signal: AbortSignal;
}

Type declaration

  • closeOnError: boolean

    If true, stream closes if function throws an error. If false, errors are emitted as signals, but stream is not closed. Default: true

  • 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
  • predelay: Interval

    If specified, a time before invoking function. If repeat is used, this is in addition to interval time.

  • signal: AbortSignal

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