Interface RRStackOptions

Constructor input and serialized output (round-trippable).

version is optional on input and ignored by the constructor.
toJson() always writes the current package version.

interface RRStackOptions {
    defaultEffect?: DefaultEffect;
    rules?: RuleJson[];
    timeUnit?: UnixTimeUnit;
    timezone: string;
    version?: string;
}

Index

Properties

defaultEffect? rules? timeUnit? timezone version?

Properties

`Optional`defaultEffect

defaultEffect?: DefaultEffect

Baseline effect for uncovered instants. Defaults to 'auto'.

`Optional`rules

rules?: RuleJson[]

Rule list. Defaults to empty.

`Optional`timeUnit

timeUnit?: UnixTimeUnit

Time unit ('ms' | 's'). Defaults to 'ms'.

timezone

timezone: string

IANA timezone id (validated at runtime).

`Optional`version

version?: string

Optional version string; ignored by the constructor.