forge.timers
    Preparing search index...

    Interface ITimer

    A stored row.

    interface ITimer {
        args?: string[];
        authorID?: string | null;
        channelID?: string | null;
        code: string;
        commandName?: string | null;
        config?: IStoredOverrides | null;
        cron?: string | null;
        duration: number;
        fireAt: number;
        guildID?: string | null;
        id: string;
        kind: TimerKind;
        messageID?: string | null;
        name: string;
        path?: string | null;
        pausedAt?: number | null;
        timestamp: number;
        timezone?: string | null;
        vars?: IPersistedVars;
        version?: number | null;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    args? authorID? channelID? code commandName? config? cron? duration fireAt guildID? id kind messageID? name path? pausedAt? timestamp timezone? vars? version?
    args?: string[]

    The command arguments present when the timer was scheduled.

    authorID?: string | null
    channelID?: string | null
    code: string

    The ForgeScript code to run.

    commandName?: string | null

    The name of the command this timer was scheduled from.

    config?: IStoredOverrides | null

    The options this timer was scheduled with.

    cron?: string | null

    The cron expression a cron timer runs on.

    duration: number

    Delay for timeouts, tick length for intervals, in ms. Always 0 for a cron.

    fireAt: number

    Absolute unix ms timestamp of the next time this should fire.

    guildID?: string | null
    id: string
    kind: TimerKind
    messageID?: string | null
    name: string

    The name the timer was scheduled under. Unique per kind.

    path?: string | null
    pausedAt?: number | null

    When it was paused, or null while it is running.

    timestamp: number
    timezone?: string | null

    The zone that expression is read in, or null for whatever the process runs in.

    vars?: IPersistedVars
    version?: number | null

    The variable schema this timer was written under.

    Settings
    Member Visibility

    On This Page
    Properties