forge.timers
    Preparing search index...

    Interface ITimeoutStartOptions

    A timer that runs once, a delay from now.

    interface ITimeoutStartOptions {
        args?: string[];
        authorID?: string | null;
        channelID?: string | null;
        code?: string;
        commandName?: string | null;
        config?: IStoredOverrides | null;
        duration: number;
        guildID?: string | null;
        kind: timeout;
        messageID?: string | null;
        name: string;
        path?: string | null;
        vars?: IPersistedVars;
    }

    Hierarchy (View Summary)

    Index
    args? authorID? channelID? code? commandName? config? duration guildID? kind messageID? name path? vars?
    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.

    duration: number

    How long from now it runs, in ms.

    guildID?: string | null
    kind: timeout
    messageID?: string | null
    name: string

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

    path?: string | null
    vars?: IPersistedVars

    Settings
    Member Visibility

    On This Page
    Properties