Interface Intervals

Interface for interval management functionality

interface Intervals {
    clear(name: string): void;
    clearCron(name: string): void;
    get(name: string): undefined | Timeout;
    getCron(name: string): undefined | ITimerHandle;
    listCrons(): string[];
    set(name: string, callback: () => void, interval: number): Timeout;
    setCron(
        name: string,
        cronExpression: string,
        callback: () => void,
        opts?: { errorHandler?: (err: unknown) => unknown },
    ): ITimerHandle;
}

Methods

clear clearCron get getCron listCrons set setCron

Methods

clear

  • clear(name: string): void

  • Clear an interval by name

    Parameters

    • name: string

      Name of the interval to clear

    Returns void

clearCron

  • clearCron(name: string): void

  • Clear a cron job by name

    Parameters

    • name: string

      Name of the cron job to clear

    Returns void

get

  • get(name: string): undefined | Timeout

  • Get an interval by name

    Parameters

    • name: string

      Name of the interval

    Returns undefined | Timeout

getCron

listCrons

set

  • set(name: string, callback: () => void, interval: number): Timeout

  • Set a new interval

    Parameters

    • name: string

      Name for the interval

    • callback: () => void

      Function to execute

    • interval: number

      Time in milliseconds between executions

    Returns Timeout

setCron

  • setCron(
        name: string,
        cronExpression: string,
        callback: () => void,
        opts?: { errorHandler?: (err: unknown) => unknown },
    ): ITimerHandle

  • Set a new cron job

    Parameters

    • name: string

      Name for the cron job

    • cronExpression: string

      Cron expression (e.g., "0 5 * * *" for every 5 minutes past the hour)

    • callback: () => void

      Function to execute

    • Optionalopts: { errorHandler?: (err: unknown) => unknown }

      Optional error handler

    Returns ITimerHandle

Settings

Member Visibility

On This Page

Methods