Type Alias GeneratorOptions

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

Index

Properties

lazy readInterval readTimeout signal traceLifecycle whenStopped

Properties

lazy

lazy: Lazy

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

readInterval

readInterval: Interval

Wait between reading from generator Default: 5ms

readTimeout

readTimeout: Interval

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

signal

signal: AbortSignal

traceLifecycle

traceLifecycle: boolean

whenStopped

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