Remote / foldkit-remote/why

ReadWhy

const · packages/remote/src/whyTerms.ts:115

const ReadWhy: Schema.Struct<{ readonly state: Schema.Literals<readonly ["Initial", "Loading", "Ready", "Refreshing", "Failed", "NotFound"]>; readonly because: Schema.$Array<TaggedUnion<{ readonly NotObserved: {}; readonly NotFetching: { readonly surfaces: Schema.$Array<Schema.String>; }; readonly CacheOnly: { readonly surfaces: Schema.$Array<Schema.String>; }; readonly NoActiveRecord: {}; readonly List: { readonly list: Schema.Struct<{ readonly query: Schema.String; readonly identity: Schema.String; }>; readonly held: Schema.Literals<readonly ["Missing", "Evicted", "Stale"]>; readonly inFlight: Schema.Boolean; }; readonly HeldForHistory: { readonly list: Schema.Struct<{ readonly query: Schema.String; readonly identity: Schema.String; }>; }; readonly Fields: { readonly row: Schema.Struct<{ readonly entity: Schema.String; readonly id: Schema.String; }>; readonly via: Schema.$Array<Schema.String>; readonly fields: Schema.$Array<Schema.String>; readonly held: Schema.Literals<readonly ["Missing", "Evicted", "Stale"]>; readonly inFlight: Schema.Boolean; }; readonly ListFailed: { readonly list: Schema.Struct<{ readonly query: Schema.String; readonly identity: Schema.String; }>; readonly error: Schema.Struct<{ readonly _tag: Schema.String; readonly message: Schema.String; readonly refusal: Schema.optional<Schema.Unknown>; readonly reason: Schema.optional<Schema.String>; }>; }; readonly FieldsFailed: { readonly row: Schema.Struct<{ readonly entity: Schema.String; readonly id: Schema.String; }>; rea …;

Its type

type ReadWhy = typeof ReadWhy.Type

Why a read shows what it shows. because is every fact the Model holds about what it reads, the reason that decides state first; message is that reason in words. surfaces are the active Surfaces reading all of it, when the active record was given. Encode it with this schema for JSON.

In the guides