Interface RRStackOptionsNormalized

Normalized options stored on the instance (frozen). * - timeUnit is required.

rules is a readonly array.
timezone is a branded, validated string.

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

Hierarchy

Omit<RRStackOptions, "timeUnit" | "rules" | "timezone">
- RRStackOptionsNormalized

Index

Properties

defaultEffect rules timeUnit timezone version?

Properties

defaultEffect

defaultEffect: DefaultEffect

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

rules

rules: readonly RuleJson[]

timeUnit

timeUnit: UnixTimeUnit

timezone

timezone: TimeZoneId

`Optional`version

version?: string

Optional version string; ignored by the constructor.