@karmaniverous/rrstack
    Preparing search index...

    Interface DescribeConfig

    Unified configuration for rule descriptions. Translators own the entire sentence (effect, duration, cadence, bounds, tz).

    interface DescribeConfig {
        boundsFormat?: string;
        formatTimezoneLabel?: (tzId: string) => string;
        hourCycle?: "h23" | "h12";
        lexicon?: Partial<FrequencyLexicon>;
        locale?: string;
        lowercase?: boolean;
        ordinals?: "long" | "short";
        showBounds?: boolean;
        showRecurrenceCount?: boolean;
        showTimezone?: boolean;
        timeFormat?: "auto" | "hm" | "hms";
        translator?: DescribeTranslator | "strict-en";
    }
    Index

    Properties

    boundsFormat? formatTimezoneLabel? hourCycle? lexicon? locale? lowercase? ordinals? showBounds? showRecurrenceCount? showTimezone? timeFormat? translator?

    Properties

    boundsFormat?: string

    Format for bounds when shown (Luxon toFormat); default ISO without ms.

    formatTimezoneLabel?: (tzId: string) => string

    Customize timezone label string.

    hourCycle?: "h23" | "h12"

    24h vs 12h clock for time-of-day formatting.

    lexicon?: Partial<FrequencyLexicon>

    Frequency lexicon overrides.

    locale?: string

    Locale applied to label/time rendering (Luxon setLocale).

    lowercase?: boolean

    Lowercase labels (default: true).

    ordinals?: "long" | "short"

    Ordinal labels (e.g., third vs 3rd).

    showBounds?: boolean

    Show inline bounds: "from … until …".

    showRecurrenceCount?: boolean

    Append "for N occurrence(s)" when a COUNT is present.

    showTimezone?: boolean

    Show "(timezone

    timeFormat?: "auto" | "hm" | "hms"

    Time-of-day formatting in the rule timezone.

    translator?: DescribeTranslator | "strict-en"

    Translator chooser (default: 'strict-en').

    Settings

    Member Visibility

    On This Page

    Properties