Anchorage API reference
    Preparing search index...

    Interface SignalRouterOptions

    interface SignalRouterOptions {
        attributeAllowlist?: readonly string[];
        audit?: SignalAuditSink;
        basePath?: string;
        maxContentBytes?: number;
        rateLimit?: SignalRateLimiter;
        resolve: TenantResolver;
        roles?: readonly ApprovalRole[];
        topology: ThreadTopology;
    }
    Index

    Properties

    attributeAllowlist? audit? basePath? maxContentBytes? rateLimit? resolve roles? topology

    Properties

    attributeAllowlist?: readonly string[]

    The attribute KEYS a signal body may carry. When set, an attributes object naming any key outside it is 400'd (defense-in-depth over core's own name validation). Absent ⇒ attributes pass through (the host opted out).

    audit?: SignalAuditSink

    Every ingest is audited through this (accepted + rejected). Absent ⇒ no audit (wire one).

    basePath?: string

    Route prefix. Default '/api/threads'.

    maxContentBytes?: number

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

    rateLimit?: SignalRateLimiter

    Per-tenant rate cap. Absent ⇒ unmetered.

    resolve: TenantResolver

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

    roles?: readonly ApprovalRole[]

    Who may signal. Default RUN_START_ROLES (operator/admin) — reviewers/viewers are read-only.

    topology: ThreadTopology

    The sanctioned reach into a thread DO — stamps the tenant header, 404s a foreign threadId.

    Settings

    Member Visibility

    On This Page

    Properties