forge.timers
    Preparing search index...

    Interface IForgeTimersOptions

    interface IForgeTimersOptions {
        cronConfig?: IIntervalConfig;
        events?: (
            | "timerStart"
            | "timerFire"
            | "timerCancel"
            | "timerPause"
            | "timerResume"
            | "timerRestore"
            | "timerDrop"
            | "timersReady"
            | "databaseConnect"
            | "databaseFail"
        )[];
        intervalConfig?: IIntervalConfig;
        keepSource?: boolean;
        migrateFrom?: TimerStorage;
        pruneUnknownGuilds?: boolean;
        storage?: TimerStorage;
        timeoutConfig?: IBaseTimerConfig;
    }
    Index
    cronConfig? events? intervalConfig? keepSource? migrateFrom? pruneUnknownGuilds? storage? timeoutConfig?
    cronConfig?: IIntervalConfig
    events?: (
        | "timerStart"
        | "timerFire"
        | "timerCancel"
        | "timerPause"
        | "timerResume"
        | "timerRestore"
        | "timerDrop"
        | "timersReady"
        | "databaseConnect"
        | "databaseFail"
    )[]

    Which timer events to listen to.

    intervalConfig?: IIntervalConfig
    keepSource?: boolean

    Copy on migration instead of moving. The source keeps its timers, which means the migration runs again on every boot until migrateFrom is removed.

    migrateFrom?: TimerStorage

    Move stored timers out of this database and into storage on startup, once. Both extensions have to be loaded for that boot. Names already taken in the target are left alone.

    pruneUnknownGuilds?: boolean

    Delete timers whose guild this process can't see on startup. Off by default. That's usually an outage or a sibling shard. Only safe unsharded.

    storage?: TimerStorage

    Which extension keeps the timers: "forgedb" (default) or "quorieldb".

    timeoutConfig?: IBaseTimerConfig

    Settings
    Member Visibility

    On This Page
    Properties