Anchorage API reference
    Preparing search index...

    Interface CreateApprovalDashboardOptions

    interface CreateApprovalDashboardOptions {
        actorId?: string;
        client: ApprovalApiClient;
        components?: Partial<ApprovalUIComponents>;
        now?: () => number;
        pollIntervalMs?: number;
        stream?: ApprovalStreamOption;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actorId? client components? now? pollIntervalMs? stream?

    Properties

    actorId?: string

    Current reviewer id — attributes optimistic decides + enables conflict detection.

    client: ApprovalApiClient
    components?: Partial<ApprovalUIComponents>

    Design-system adapter. Supply a full or partial slot map to style the dashboard with your components; omitted slots (or omitting this entirely) fall back to the built-in unstyled HTML adapter, which you can style via the flowsafe-* class hooks. If you pass a CSS-based adapter (e.g. Astryx), remember to load that library's stylesheet in your app entry.

    now?: () => number

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

    pollIntervalMs?: number

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

    stream?: ApprovalStreamOption

    An injected live-stream transport and ticket thunk. When absent, the dashboard remains poll-only. The host builds both values.

    Settings

    Member Visibility

    On This Page

    Properties