openmixer — generated API reference
    Preparing search index...

    Interface CarriedIndexCodec

    The index entry codec: a key over the carried row's id. write answers undefined for an id that addresses no instance of the carried row; read answers undefined for an entry that spells none, and the index that holds one such entry is refused whole (projectCarried and carriedInstanceOf treat the frame as unindexed) — a reader never throws on a frame off the wire.

    interface CarriedIndexCodec {
        read(
            entry: unknown,
        ): Readonly<Record<string, string | number>> | undefined;
        write(id: ResourceId): string | undefined;
    }
    Index
    • Parameters

      • entry: unknown

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