RemoteDataSourceProps

Configuration properties for the remote data source. Extends the basic DataSourceProps with remote data operations capabilities.

Name	Type	Default	Description
creates?	Map<"null" | string | number | symbol>		Map of created items that need to be synced with the remote source.
data?	T[]		The current data array to be managed by the hook. This represents the data items that are currently available in the data source. If not provided, the defaultData will be used as the initial value.
defaultData?	T[]		The initial data array to be managed by the hook.
defaultFilter?	CompositeFilterDescriptor		The initial filter configuration.
defaultGroup?	GroupDescriptor[]		The initial grouping configuration.
defaultSkip?	number		The initial number of records to skip (for paging).
defaultSort?	SortDescriptor[]		The initial sorting configuration.
defaultTake?	number		The initial number of records to take per page.
defaultTotal?	number		The initial total number of records in the data source.
deletes?	Map<"null" | string | number | symbol>		Map of items marked for deletion that need to be synced with the remote source.
filter?	CompositeFilterDescriptor		The current filter configuration.
filterable?	boolean	true	Specifies whether filtering is enabled.
group?	GroupDescriptor[]		The current grouping configuration.
groupable?	boolean	true	Specifies whether grouping is enabled.
pageable?	boolean	true	Specifies whether paging is enabled.
reads?	Map<"null" | string | number | symbol>		Map of original data items read from the remote source, indexed by ID.
schema	{ model: { id: string; }; } intersected with { data?: string | (data: any) => T[]; errors?: string | (data: any) => any; total?: string | (data: any) => number; }		Schema configuration for parsing and mapping server responses. Extends the base DataSourceProps schema with additional properties for remote data.
serverFiltering?	boolean	true	Determines if filtering operations should be performed on the server. When true, filter parameters are sent to the server during read operations.
serverGrouping?	boolean	true	Determines if grouping operations should be performed on the server. When true, group parameters are sent to the server during read operations.
serverPaging?	boolean	true	Determines if paging operations should be performed on the server. When true, skip and take parameters are sent to the server during read operations.
serverSorting?	boolean	true	Determines if sorting operations should be performed on the server. When true, sort parameters are sent to the server during read operations.
skip?	number		The current number of records to skip (for paging).
sort?	SortDescriptor[]		The current sorting configuration.
sortable?	boolean	true	Specifies whether sorting is enabled.
take?	number		The current number of records to take per page.
total?	number		The total number of records in the data source.
transport?	{ create?: { contentType?: string; data?: {[key: string]: any}; method?: string; onError?: (error: any) => void; onResponse?: (response: any) => "null" | T; onSuccess?: (data: T) => void; parameterMap?: (data: T) => any; url: string | (dataItem: T) => string; } | (options: { data: T; }) => Promise<T>; delete?: { contentType?: string; data?: {[key: string]: any}; method?: string; onError?: (error: any) => void; onResponse?: (response: any) => "null" | T; onSuccess?: (data: T) => void; parameterMap?: (data: T) => any; url: string | (dataItem: T) => string; } | (options: { data: T; }) => Promise<T>; read?: { contentType?: string; data?: {[key: string]: any}; method?: string; onError?: (error: any) => void; onResponse?: (response: any) => "null" | T; onSuccess?: (data: T[]) => void; parameterMap?: (data: { filter?: CompositeFilterDescriptor; group?: GroupDescriptor[]; skip?: number; sort?: SortDescriptor[]; take?: number; }) => any; url: string | () => string; } | (options: { filter?: CompositeFilterDescriptor; group?: GroupDescriptor[]; onError?: (error: any) => void; onResponse?: (response: any) => "null" | T; onSuccess?: (data: T[]) => void; skip?: number; sort?: SortDescriptor[]; take?: number; }) => Promise<T[]>; update?: { contentType?: string; data?: {[key: string]: any}; method?: string; onError?: (error: any) => void; onResponse?: (response: any) => "null" | T; onSuccess?: (data: T) => void; parameterMap?: (data: T) => any; url: string | (dataItem: T) => string; } | (options: { data: T; }) => Promise<T>; }		Configuration for CRUD operations transport. Defines how data is sent to and received from the server.
updates?	Map<"null" | string | number | symbol>		Map of updated items that need to be synced with the remote source.