Anchorage API reference
    Preparing search index...

    Interface UseApprovalDashboardOptions

    interface UseApprovalDashboardOptions {
        actorId?: string;
        filter?: ApprovalListFilter;
        now?: () => number;
        pollIntervalMs?: number;
        stream?: ApprovalStreamOption;
    }
    Index

    Properties

    actorId? filter? now? pollIntervalMs? stream?

    Properties

    actorId?: string

    The current reviewer's id — attributes an optimistic decide so a live 'decided' event naming a DIFFERENT decider surfaces a conflict. Absent ⇒ optimistic decide still greys the row, but no conflict is ever raised (no id to compare against); the host supplies it.

    filter?: ApprovalListFilter

    The queue list filter, re-applied on every poll. Default: DEFAULT_QUEUE_FILTER (open statuses, limit 100) — bounded so the dashboard never issues an unfiltered full-table scan.

    now?: () => number

    Injectable clock (deterministic SLA countdowns in tests/stories).

    pollIntervalMs?: number

    Queue/metrics refresh cadence; <= 0 disables polling. Default 10s.

    stream?: ApprovalStreamOption

    Live streaming through an injected StreamTransport and ticket() thunk. Absent means poll-only. When present the hook opens the tenant's approval stream and live-merges events on top of the interval poll, which keeps running as the periodic reconciler.

    Settings

    Member Visibility

    On This Page

    Properties