openmixer — generated API reference
    Preparing search index...

    Class DerivedResource<A, S>

    Type Parameters

    • A
    • S extends object

    Hierarchy (View Summary)

    Implements

    Index
    carried: CarriedSeriesDeclaration | undefined

    The carrying declaration, published for the registry, the router and the hub to read.

    confirm: ConfirmGate | undefined

    The confirm gate a write here must pass, when the row declared one — see ConsoleResource.confirm. Declared on the row and executed by the registry; every mold carries it the same way, so a gated operation and a gated record are one clause.

    lifecycle: ResourceLifecycle | undefined

    The row's CREATE/DELETE doors, when it declared any.

    path: string

    The path template, e.g. /channel/{kind}/{index}/headAmp. Braced segments become ResourceId keys. One template per entity type; instances differ only by id.

    policy: ResourcePolicy | undefined

    The row's declared bookkeeping policy — see ResourcePolicy.

    served: ((id: ResourceId, view: ReadView) => object | undefined) | undefined

    See ConsoleResource.served: the instance re-read, then the row's projection — PRESENT only on a row that declares one (served, or carried), so a row served as it stands has no door here and a published frame reaches its watchers exactly as committed.

    • The one documented divergence from the shared trunk (see resource.ts): a derived view's instance EXISTS only while derive answers, so existence folds into the canonical id and an address whose instance is not there right now canonicalises to undefined.

      Parameters

      Returns Readonly<Record<string, string | number>> | undefined

    • The addresses the view answers for, canonically spelled — absent when it cannot say.

      Returns Iterable<Readonly<Record<string, string | number>>, any, any> | undefined

    • Project the state onto the audio — the southbound half. Called by the registry after every accepted patch that changed something. The implementation re-reads its own state and drives the backend from that read; there is no state argument to trust. A resource whose state has no audio consequence returns PROJECTED; an unwired backend returns notProjected so the refusal is visible on the first attempt.

      Synchronous by contract. Hardware that lands later uses a queued sink: dispatch now, and the landing (confirmation or refusal) reaches every client as the next frame of the same instance via ResourceRegistry.reproject.

      Returns ProjectionResult

    • Read the ONE state. undefined when the instance does not exist — the layer turns that into a not-found rather than an empty object, so "absent" and "default" stay distinct. Pure: a read may not bind, seed, or persist anything.

      Parameters

      Returns S | undefined