@ascentbv/ts-common - v1.0.123
    Preparing search index...

    Interface NamedIntervalOptions

    Options for creating a named interval. Named intervals can be cleared later by name and tracked for statistics.

    interface NamedIntervalOptions {
        profile?: string | boolean;
        name: string;
        beginImmediately?: boolean;
        force?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    profile?: string | boolean

    Enable profiling for the timer.

    • true → Profile using the interval's name or a default label.
    • string → Profile using the provided custom label.
    • false or undefined → Disable profiling.
    name: string

    Unique identifier for the interval. If another interval with this name exists:

    • It will throw an error unless force is true.
    beginImmediately?: boolean

    If true, the callback will run once immediately before scheduling begins.

    force?: boolean

    If true, replaces an existing interval with the same name.