openmixer — generated API reference
    Preparing search index...

    Interface CollectionConfig<A, S>

    interface CollectionConfig<A, S extends object> {
        address: AddressCodec<A>;
        fields: CollectionFieldSpecs<S>;
        lifecycle?: LifecycleDoors<A>;
        path: string;
        policy?: ResourcePolicy;
        ripples?: (addr: A, before: S, after: S) => readonly RippleTarget[];
        sink?: (addr: A, state: S) => ProjectionResult;
        station: StateStation<A, S>;
    }

    Type Parameters

    • A
    • S extends object
    Index
    address: AddressCodec<A>
    lifecycle?: LifecycleDoors<A>

    The item-lifecycle doors. Clearing a collection is writing the empty value (see above); DELETE is the strictly stronger request — the COLLECTION itself stops existing, which for a DCA or a mute group means the engine's slot is freed, not emptied.

    path: string

    What a committed write here means for the session's dirtiness and the operator's history. Absent means the layer default: it dirties the session, is not undoable, and is not a barrier (see ResourcePolicy).

    ripples?: (addr: A, before: S, after: S) => readonly RippleTarget[]
    sink?: (addr: A, state: S) => ProjectionResult
    station: StateStation<A, S>