Data Models
AppendFetchParams
Section titled “AppendFetchParams”Parameters for an append-mode fetch request.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
Params | Record<string, unknown> |
Properties
Section titled “Properties”cursor
Section titled “cursor”unknown
number
params
Section titled “params”Params
signal
Section titled “signal”AbortSignal
AppendFetchResult
Section titled “AppendFetchResult”Result for an append-mode fetch request.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T |
Properties
Section titled “Properties”cursor
Section titled “cursor”unknown
groups?: object[]
Section titled “groups?: object[]”number
number
hasMore
Section titled “hasMore”boolean
T[]
AppendRemoteModelConfig
Section titled “AppendRemoteModelConfig”Configuration for an append-mode remote model.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
Params | Record<string, unknown> |
Properties
Section titled “Properties”actions?: Record<string, RemoteActionConfig<Params>>
Section titled “actions?: Record<string, RemoteActionConfig<Params>>”fetch()
Section titled “fetch()”fetch: (
params) =>Promise<AppendFetchResult<T>>
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
params | AppendFetchParams<Params> |
Returns
Section titled “Returns”Promise<AppendFetchResult<T>>
initialActions?: InitialModelAction[]
Section titled “initialActions?: InitialModelAction[]”initialParams
Section titled “initialParams”Params
"append"
onError()?
Section titled “onError()?”
optionalonError: (error) =>void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
error | Error |
Returns
Section titled “Returns”void
onViewportChange()?
Section titled “onViewportChange()?”
optionalonViewportChange: (context) =>AppendViewportAction
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
context | AppendViewportContext<Params> |
Returns
Section titled “Returns”pageSize?: number
Section titled “pageSize?: number”AppendViewportAction
Section titled “AppendViewportAction”AppendViewportAction = {
loadMore:true; } |void
Action returned by an append viewport handler.
AppendViewportContext
Section titled “AppendViewportContext”Context passed to an append viewport handler.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
Params | Record<string, unknown> |
Properties
Section titled “Properties”endIndex
Section titled “endIndex”number
fetching
Section titled “fetching”boolean
hasMore
Section titled “hasMore”boolean
loadedCount
Section titled “loadedCount”number
pageSize
Section titled “pageSize”number
params
Section titled “params”Params
startIndex
Section titled “startIndex”number
ConcurrencyStrategy
Section titled “ConcurrencyStrategy”ConcurrencyStrategy =
"supersede"|"queue"|"deduplicate"
Concurrency strategies supported by model actions.
DataModelHandle
Section titled “DataModelHandle”The handle exposed by local and remote data models.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | unknown |
Properties
Section titled “Properties”persistence?: DataModelPersistenceCapability<ModelPersistenceState>
Section titled “persistence?: DataModelPersistenceCapability<ModelPersistenceState>”Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Returns
Section titled “Returns”void
getActionState()?
Section titled “getActionState()?”
optionalgetActionState():ModelActionState
Returns
Section titled “Returns”send()
Section titled “send()”send(
msg):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
msg | { action: string; payload?: unknown; requestId?: string; viewId?: string; } |
msg.action | string |
msg.payload? | unknown |
msg.requestId? | string |
msg.viewId? | string |
Returns
Section titled “Returns”void
setData()?
Section titled “setData()?”
optionalsetData(data,groups?):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | T[] |
groups? | object[] |
Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
listener | (msg) => void |
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
subscribeToActionState()?
Section titled “subscribeToActionState()?”
optionalsubscribeToActionState(handler): () =>void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
handler | (state) => void |
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
DataModelPersistenceCapability
Section titled “DataModelPersistenceCapability”Optional persistence capability exposed by data models.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
State | ModelPersistenceState |
Methods
Section titled “Methods”capture()
Section titled “capture()”capture(
viewId,previous):State
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
viewId | string |
previous | State | null |
Returns
Section titled “Returns”State
restore()
Section titled “restore()”restore(
viewId,state):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
viewId | string |
state | State | null |
Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
viewId,onChange): () =>void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
viewId | string |
onChange | () => void |
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
DataResult
Section titled “DataResult”A normalized table data result returned by data models.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | unknown |
G | never |
Properties
Section titled “Properties”data: (
T|G)[]
groups
Section titled “groups”object[]
number
number
defaultAppendViewportHandler
Section titled “defaultAppendViewportHandler”defaultAppendViewportHandler<
Params>(context):AppendViewportAction
Default viewport strategy for append mode.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Params |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
context | AppendViewportContext<Params> |
Returns
Section titled “Returns”defaultOffsetViewportHandler
Section titled “defaultOffsetViewportHandler”defaultOffsetViewportHandler<
Params>(context):OffsetViewportAction
Default viewport strategy for offset mode.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Params |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
context | OffsetViewportContext<Params> |
Returns
Section titled “Returns”FetchParams
Section titled “FetchParams”Parameters for an offset-based fetch request.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
Params | Record<string, unknown> |
Properties
Section titled “Properties”number
offset
Section titled “offset”number
params
Section titled “params”Params
signal
Section titled “signal”AbortSignal
FetchResult
Section titled “FetchResult”Result for an offset-based fetch request.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T |
Properties
Section titled “Properties”groups?: object[]
Section titled “groups?: object[]”number
number
T[]
totalCount
Section titled “totalCount”number
localModel
Section titled “localModel”localModel<
T,G>(config):DataModelHandle<T|G>
Creates a local reactive data model for the table.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
G | never |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
config | LocalModelConfig<T, G> |
Returns
Section titled “Returns”DataModelHandle<T | G>
LocalModelConfig
Section titled “LocalModelConfig”Configuration for localModel().
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
G | never |
Properties
Section titled “Properties”actions?: Record<string, PipelineActionConfig<T, G> | SourceMutatorConfig<T>>
Section titled “actions?: Record<string, PipelineActionConfig<T, G> | SourceMutatorConfig<T>>”T[]
groups?: object[]
Section titled “groups?: object[]”number
number
initialActions?: InitialModelAction[]
Section titled “initialActions?: InitialModelAction[]”pipeline?: string[]
Section titled “pipeline?: string[]”MessageEnvelope
Section titled “MessageEnvelope”Message envelope used by data model protocols.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
P | unknown |
Properties
Section titled “Properties”action
Section titled “action”string
dataVersion?: number
Section titled “dataVersion?: number”error?: object
Section titled “error?: object”message
Section titled “message”string
operationVersion?: number
Section titled “operationVersion?: number”payload?: P
Section titled “payload?: P”requestId
Section titled “requestId”string
"error" | "request" | "ack" | "result" | "cancel" | "event"
viewId
Section titled “viewId”string
ModelActionPersistenceConfig
Section titled “ModelActionPersistenceConfig”ModelActionPersistenceConfig<
State,SourceState> =boolean| {capture?: (context) =>State;isEmpty?: (state) =>boolean;key?:string;restore?: (context) =>SourceState; }
Persistence configuration for a data model action.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
State | unknown |
SourceState | unknown |
ModelPersistenceState
Section titled “ModelPersistenceState”Serializable model state used by model-backed persistence adapters.
Properties
Section titled “Properties”actions
Section titled “actions”Record<string, unknown>
version
Section titled “version”1
OffsetRemoteModelConfig
Section titled “OffsetRemoteModelConfig”Configuration for an offset-mode remote model.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
Params | Record<string, unknown> |
Properties
Section titled “Properties”actions?: Record<string, RemoteActionConfig<Params>>
Section titled “actions?: Record<string, RemoteActionConfig<Params>>”fetch()
Section titled “fetch()”fetch: (
params) =>Promise<FetchResult<T>>
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
params | FetchParams<Params> |
Returns
Section titled “Returns”Promise<FetchResult<T>>
initialActions?: InitialModelAction[]
Section titled “initialActions?: InitialModelAction[]”initialParams
Section titled “initialParams”Params
mode?: "offset"
Section titled “mode?: "offset"”onError()?
Section titled “onError()?”
optionalonError: (error) =>void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
error | Error |
Returns
Section titled “Returns”void
onViewportChange()?
Section titled “onViewportChange()?”
optionalonViewportChange: (context) =>OffsetViewportAction
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
context | OffsetViewportContext<Params> |
Returns
Section titled “Returns”pageSize?: number
Section titled “pageSize?: number”placeholder?: T
Section titled “placeholder?: T”OffsetViewportAction
Section titled “OffsetViewportAction”OffsetViewportAction = {
fetch:object[]; } |void
Action returned by an offset viewport handler.
OffsetViewportContext
Section titled “OffsetViewportContext”Context passed to an offset viewport handler.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
Params | Record<string, unknown> |
Properties
Section titled “Properties”endIndex
Section titled “endIndex”number
loadedRanges
Section titled “loadedRanges”object[]
number
offset
Section titled “offset”number
pageSize
Section titled “pageSize”number
params
Section titled “params”Params
startIndex
Section titled “startIndex”number
totalCount
Section titled “totalCount”number
ParamTransformer
Section titled “ParamTransformer”ParamTransformer<
Params> = (ctx) =>Params
Transforms action payloads into remote query params.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Params |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
ctx | { params: Params; payload: unknown; } |
ctx.params | Params |
ctx.payload | unknown |
Returns
Section titled “Returns”Params
PipelineActionConfig
Section titled “PipelineActionConfig”Configuration for a derived pipeline action.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
G | never |
Properties
Section titled “Properties”handler
Section titled “handler”PipelineHandler<T, G>
persistence?: ModelActionPersistenceConfig
Section titled “persistence?: ModelActionPersistenceConfig”string
PipelineHandler
Section titled “PipelineHandler”PipelineHandler<
T,G> = (params) =>PipelineResult<T,G>
A pipeline stage handler for localModel().
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
G | never |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
params | { data: (T | G)[]; payload: unknown; } |
params.data | (T | G)[] |
params.payload | unknown |
Returns
Section titled “Returns”PipelineResult<T, G>
PipelineResult
Section titled “PipelineResult”PipelineResult<
T,G> = (T|G)[] |DataResult<T,G>
The result of a local pipeline stage.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
G | never |
RemoteActionConfig
Section titled “RemoteActionConfig”Configuration for a remote action.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Params |
Properties
Section titled “Properties”handler
Section titled “handler”ParamTransformer<Params>
persistence?: ModelActionPersistenceConfig<unknown, Params>
Section titled “persistence?: ModelActionPersistenceConfig<unknown, Params>”remoteModel
Section titled “remoteModel”remoteModel<
T,Params>(config):DataModelHandle<T>
Creates a remote reactive data model for the table.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
Params | Record<string, unknown> |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
config | RemoteModelConfig<T, Params> |
Returns
Section titled “Returns”RemoteModelConfig
Section titled “RemoteModelConfig”RemoteModelConfig<
T,Params> =OffsetRemoteModelConfig<T,Params> |AppendRemoteModelConfig<T,Params>
Configuration for remoteModel().
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T | - |
Params | Record<string, unknown> |
RemoteModelLoadingEvent
Section titled “RemoteModelLoadingEvent”Event payload emitted by remoteModel() through the model event channel.
Properties
Section titled “Properties”errorMessage?: string
Section titled “errorMessage?: string”"loading"
reason
Section titled “reason”RemoteModelLoadingPhase
Section titled “RemoteModelLoadingPhase”RemoteModelLoadingPhase =
"start"|"success"|"error"|"cancel"
Loading lifecycle phase emitted by remoteModel().
RemoteModelLoadingReason
Section titled “RemoteModelLoadingReason”RemoteModelLoadingReason =
"initial"|"refresh"|"end"|"viewport"
Loading reasons emitted by remoteModel().
SourceMutator
Section titled “SourceMutator”SourceMutator<
T> = (params) =>T[]
A mutator that updates the backing source array.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
params | { payload: unknown; source: T[]; } |
params.payload | unknown |
params.source | T[] |
Returns
Section titled “Returns”T[]
SourceMutatorConfig
Section titled “SourceMutatorConfig”Configuration for a source mutation action.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T |