Collection · datx

The JSON API Collection enhances the datx collection with the following properties and methods:

cache

static cache: boolean;

Should the GET network calls be cached (default is true for browser and false for server).

defaultModel

static defaultModel: typeof PureModel

A default model that will be used if no model is defined for a certain model type received from the server (default is GenericModel which is a combination of JSON API Model and PureModel).

sync

sync<T extends IJsonapiModel = IJsonapiModel>(body?: IResponse): T|Array<T>|null;

Add the data from a JSON API response to the store. The return value is a model or an array of models from the JSON API data property.

fetch

fetch<T extends IJsonapiModel = IJsonapiModel>(type: IType|IModelConstructor<T>, id: number|string, options?: IRequestOptions): Promise<Response<T>>;

Fetch a single model from the server.

The options can be used to send additional parameters to the server.

If an error happens, the function will reject with the Response object with the error property set.

fetchAll

fetchAll<T extends IJsonapiModel = IJsonapiModel>(type: IType|IModelConstructor<T>, options?: IRequestOptions): Promise<Response<T>>

Fetch multiple models of the given type from the server. This will either be all models or a first page of models, depending on the server configuration.

The options can be used to send additional parameters to the server.

If an error happens, the function will reject with the Response object with the error property set.

request

request<T extends IJsonapiModel = IJsonapiModel>(url: string, method: string = 'GET', data?: object, options?: IRequestOptions): Promise<Response<T>>;

Make a custom API request to the server. The response will still be parsed in the same way it would be in fetch or fetchAll.

remove

remove(type: IType|typeof PureModel, id?: IIdentifier, remote?: boolean|IRequestOptions): Promise<void>;
remove(model: PureModel, remote?: boolean|IRequestOptions): Promise<void>;

The remove method equal to the one in the datx collection, but with an additional optional remote property. If set, the model will also be removed from the server.

removeAll and reset

The removeAll and reset methods are equal to the datx collection methods, but will also clear the network cache.