Type Alias Read<DB>

Read: Pick<DB, "get" | "read" | "resources"> & {
    archetypes: {
        readonly [K in keyof DB["archetypes"]]: Pick<
            DB["archetypes"][K],
            ("components" | "id") & keyof DB["archetypes"][K],
        >
    };
    indexes: {
        readonly [K in keyof DB["indexes"]]: Omit<DB["indexes"][K], "observe">
    };
    select(
        include: readonly string[] | ReadonlySet<string>,
        options?: { exclude?: readonly string[] },
    ): readonly number[];
}

The read-only projection of a Database that a db.derive callback receives. It exposes only the auto-trackable read surface —

value reads: get, read, select
resource reads: resources
index lookups: indexes.<name>.find / findRange / get
archetype identity: archetypes.<name>.components / id — and structurally OMITS everything a derived computation must not touch:
observe (a derive subscribes to what it reads for you)
transactions / actions / any write
direct table access: queryArchetypes, locate, and per-archetype columns / rowCount / insert / row reads
services / computed / lifecycle (extend, reset, toData, …)

Because the surface is narrowed structurally, misuse is a compile error rather than a value that must be guarded / thrown on at runtime.

Type Parameters

DB extends Database<any, any, any, any, any, any, any, any, any, any>

Type Alias Read<DB>

Type Parameters

Settings