@suluk/reference - v0.2.1
    Preparing search index...

    Interface ReferenceOptions

    interface ReferenceOptions {
        pageTitle?: string;
        tagline?: string;
        viewers?: Viewer[];
        costLedgerUrl?: string;
        tryIt?: boolean;
        whoamiUrl?: string;
        sdkUrl?: string;
        conformanceUrl?: string;
        plugins?: ReferencePlugin[];
    }
    Index

    Properties

    pageTitle? tagline? viewers? costLedgerUrl? tryIt? whoamiUrl? sdkUrl? conformanceUrl? plugins?

    Properties

    pageTitle?: string
    tagline?: string
    viewers?: Viewer[]
    costLedgerUrl?: string

    a same-origin URL returning the cost ledger (with opStats) → live declared-vs-actual cost drift.

    tryIt?: boolean

    enable the in-page try-it executor (same-origin fetch). Default true.

    whoamiUrl?: string

    a same-origin URL returning { viewer: "<id>" } for the CURRENT session → the renderer auto-selects that viewer's lens (the council-ratified L2 "live per-user view") and re-checks on focus. The full canonical document is ALWAYS the source + always escapable via "Everything" — the projection is a client-side legible subset.

    sdkUrl?: string

    a URL serving a generated TypeScript SDK (@suluk/sdk) → a prominent "Download SDK" affordance.

    conformanceUrl?: string

    a URL serving a generated conformance suite (@suluk/testgen) → a "Download conformance tests" affordance.

    plugins?: ReferencePlugin[]

    Settings

    Member Visibility

    On This Page

    Properties