Retrieve an item from the data connector.
The identifier used to retrieve an item.
A promise that bears a data payload if available.
The promise returned by this method may be rejected if an error occurs in
retrieving the data. Nonexistence of an id
resolves with undefined
.
Retrieve the list of items available from the data connector.
Optional
query: WThe optional query filter to apply to the connector request.
A promise that bears a list of values
and an associated list of
fetch ids
.
The promise returned by this method may be rejected if an error occurs in
retrieving the data. The two lists will always be the same size. If there
is no data, this method will succeed with empty ids
and values
.
Remove a value using the data connector.
The identifier for the data being removed.
A promise that is rejected if remove fails and succeeds otherwise.
This promise may resolve with a back-end response or undefined
.
Existence of resolved content in the promise is not prescribed and must be
tested for. For example, some back-ends may return a copy of the item of
type T
being removed while others may return no content.
Save a value using the data connector.
A promise that is rejected if saving fails and succeeds otherwise.
This promise may resolve with a back-end response or undefined
.
Existence of resolved content in the promise is not prescribed and must be
tested for. For example, some back-ends may return a copy of the item of
type T
being saved while others may return no content.
The description of a general purpose data connector.
Typeparam
T - The basic entity response type a service's connector.
Typeparam
U - The basic entity request type, which is conventionally the same as the response type but may be different if a service's implementation requires input data to be different from output responses. Defaults to
T
.Typeparam
V - The basic token applied to a request, conventionally a string ID or filter, but may be set to a different type when an implementation requires it. Defaults to
string
.Typeparam
W - The type of the optional
query
parameter of thelist
method. Defaults tostring
;