Interface ReminderManager

Readonlysize

add

• add(
      reminder: {
          atMs?: number;
          chat: string;
          inMs?: number;
          repeatMs?: number;
          text?: string;
          user: string;
      },
  ): number

  Schedule with inMs (relative) or atMs (absolute). Returns the id.

  Parameters

  • reminder: {
        atMs?: number;
        chat: string;
        inMs?: number;
        repeatMs?: number;
        text?: string;
        user: string;
    }

  Returns number

cancel

• cancel(id: number): boolean

  Parameters

  • id: number

  Returns boolean

cancelAllFor

• cancelAllFor(user: string): number

  Cancel every pending reminder of one user. Returns how many.

  Parameters

  • user: string

  Returns number

clear

• clear(): void

  Returns void

list

• list(filter?: { chat?: string; user?: string }): Reminder[]

  Parameters

  • Optionalfilter: { chat?: string; user?: string }

  Returns Reminder[]

load

• load(snapshot: Record<string, unknown>): void

  Re-arms pending reminders; overdue ones fire immediately (late: true).

  Parameters

  • snapshot: Record<string, unknown>

  Returns void

onDue

• onDue(cb: (reminder: Reminder) => void): () => void

  Parameters

  • cb: (reminder: Reminder) => void

  Returns () => void

renderList

• renderList(
      filter?: { chat?: string; user?: string },
      options?: { title?: string },
  ): string

  Ready-to-send pending-reminders list.

  Parameters

  • Optionalfilter: { chat?: string; user?: string }
  • Optionaloptions: { title?: string }

  Returns string

snooze

• snooze(id: number, extraMs: number): number | null

  Push a pending reminder back by extraMs. Returns the new dueAt or null.

  Parameters

  • id: number
  • extraMs: number

  Returns number | null

toJSON

• toJSON(): Record<string, unknown>

  Returns Record<string, unknown>