Anchorage API reference
    Preparing search index...

    Interface InventoryPage

    One page of one category.

    interface InventoryPage {
        category:
            | "schedules"
            | "runs"
            | "approvals-waiting"
            | "schedule-deferred-dispatches"
            | "pending-notifications"
            | "background-tasks"
            | "resource-owners"
            | "start-reservations"
            | "signal-subscriptions";
        class: InventoryCategoryClass;
        count?: number;
        cursor?: string;
        entries: readonly InventoryEntry[];
        table: string;
        totals?: Readonly<Record<string, number>>;
    }
    Index

    Properties

    category class count? cursor? entries table totals?

    Properties

    category:
        | "schedules"
        | "runs"
        | "approvals-waiting"
        | "schedule-deferred-dispatches"
        | "pending-notifications"
        | "background-tasks"
        | "resource-owners"
        | "start-reservations"
        | "signal-subscriptions"
    class: InventoryCategoryClass
    count?: number

    Total rows matching this category, counted on the FIRST page of a sweep only (a caller that is paging has already committed to walking them). Absent on continuation pages, and absent when the table does not exist.

    cursor?: string

    Pass back as ?cursor= to continue. Absent means this page reached the end of the category as of this read — which, for a work category, is the observation a drain proof is built from.

    entries: readonly InventoryEntry[]
    table: string

    The table read, with the deployment's storage prefix applied.

    totals?: Readonly<Record<string, number>>

    Category-specific totals taken with count, in the same read: the numbers that answer an operator's next question without a second sweep. See background-tasks (fenceSuspended) and pending-notifications (notDue).

    Settings

    Member Visibility

    On This Page

    Properties