Type Alias: ClientStore<Entities, S>
ClientStore<
Entities,S> =object
Defined in: fate/src/client-schema.ts:247
Type Parameters
Entities
Entities
S
S extends ClientSchema
Methods
append()
append<
N,K>(type,id,field, ...ids):void
Defined in: fate/src/client-schema.ts:249
Append existing entities by ID without materializing the list. Duplicate IDs keep their position.
Type Parameters
N
N extends string
K
K extends never
Parameters
type
N
id
string | number
field
K
ids
...ListMemberId<Entities[N][K]>[]
Returns
void
create()
create<
N>(type,data):Partial<Entities[N]> &object
Defined in: fate/src/client-schema.ts:258
Type Parameters
N
N extends string
Parameters
type
N
data
ClientPatch<Entities, S, N> & object
Returns
Partial<Entities[N]> & object
delete()
delete<
N>(type,id):void
Defined in: fate/src/client-schema.ts:262
Type Parameters
N
N extends string
Parameters
type
N
id
string | number
Returns
void
get()
get<
N>(type,id):Readonly<Partial<Entities[N]>> |undefined
Defined in: fate/src/client-schema.ts:263
Type Parameters
N
N extends string
Parameters
type
N
id
string | number
Returns
Readonly<Partial<Entities[N]>> | undefined
has()
has<
N>(type,id):boolean
Defined in: fate/src/client-schema.ts:267
Type Parameters
N
N extends string
Parameters
type
N
id
string | number
Returns
boolean
remove()
remove<
N,K>(type,id,field, ...ids):void
Defined in: fate/src/client-schema.ts:269
Remove list membership by ID without deleting the entities. Missing members are ignored.
Type Parameters
N
N extends string
K
K extends never
Parameters
type
N
id
string | number
field
K
ids
...ListMemberId<Entities[N][K]>[]
Returns
void
update()
update<
N>(type,id,patch):Partial<Entities[N]> &object
Defined in: fate/src/client-schema.ts:278
Type Parameters
N
N extends string
Parameters
type
N
id
string | number
patch
ClientPatch<Entities, S, N>
Returns
Partial<Entities[N]> & object