Anchorage API reference
    Preparing search index...

    Interface ScheduleRouterOptions

    interface ScheduleRouterOptions {
        audit?: ScheduleRouteAuditSink;
        basePath?: string;
        maxContentBytes?: number;
        maxSchedulesPerTenant?: number;
        minFireIntervalMs?: number;
        resolve: TenantResolver;
        roles?: readonly ApprovalRole[];
        store: ScheduleFacadeStore;
    }
    Index

    Properties

    audit? basePath? maxContentBytes? maxSchedulesPerTenant? minFireIntervalMs? resolve roles? store

    Properties

    audit?: ScheduleRouteAuditSink

    Every mutation (and denied read) is audited through this. Absent ⇒ no audit.

    basePath?: string

    Route prefix. Default '/api/schedules'.

    maxContentBytes?: number

    Max raw request-body size in bytes. Must be a nonnegative safe integer; zero denies every non-empty body. Default 16384 (16 KiB).

    maxSchedulesPerTenant?: number

    Per-tenant count cap: the maximum number of schedules a tenant may own. A create at or over it is REJECTED. Must be a nonnegative safe integer; zero denies every create. Default 100.

    minFireIntervalMs?: number

    Per-schedule fire-rate cap: the minimum interval between two consecutive fires of a schedule's cron, in ms. A cron whose interval is shorter is REJECTED at create/update — bounding the aggregate fire rate a tenant can schedule (with the count cap). Must be a positive safe integer. Default 60000 (1 minute).

    resolve: TenantResolver

    Authenticate, validate the tenant ID, and bind it; undefined means 401.

    roles?: readonly ApprovalRole[]

    Who may create/update/delete/pause/resume. Default RUN_START_ROLES (operator/admin) — reviewers/viewers cannot author schedules. Reads (get/ list/triggers) are not role-gated beyond ownership.

    store: ScheduleFacadeStore

    The schedules domain the facade reads/writes.

    Settings

    Member Visibility

    On This Page

    Properties