Type Alias GeneratorOptions

GeneratorOptions: {
    lazy: Lazy;
    readInterval: Interval;
    readTimeout: Interval;
    signal: AbortSignal;
    traceLifecycle: boolean;
    whenStopped: "continue" | "reset";
}

Type declaration

  • lazy: Lazy

    If true, only accesses the generator if there is a subscriber. Default: true

  • readInterval: Interval

    Wait between reading from generator Default: 5ms

  • readTimeout: Interval

    Timeout when waiting for a value Default: { mins: 5 }

  • signal: AbortSignal
  • traceLifecycle: boolean
  • whenStopped: "continue" | "reset"

    Behaviour when reactive stops, for example due to having no subscribers

    • continue: iteration continues through array where it left off
    • reset: iteration begins from start of array