Typedef

Static Public Summary
public	Action: object A generic action object that is dispatched by {APIDispatcher}
public	CountAction: object An action object that is dispatched when counts should be added to a store
public	DestroyAction: object An action object the is dispatched when an object is destroyed
public	FailedRequestCallback(error: Error): Function A method signature for rejected request promises
public	MergeAction: object An action object that is dispatched when items should be added to a store
public	RequestPromise: Promise A Promise that resolves with a SuccessfulRequestCallback and rejects with a FailedRequestCallback
public	ResourceQuery: number \| string \| object An object representing a resource query.
public	SuccessfulRequestCallback(json: object): Function A method signature for resolved request promises

Static Public

A generic action object that is dispatched by {APIDispatcher}

Name	Type	Attribute	Description
actionType	string		The type of action being dispatched

An action object that is dispatched when counts should be added to a store

Name	Type	Attribute	Description
actionType	string		The type of action being dispatched
count	number		The count returned from the API call
query	ResourceQuery	optional	The query params for the count call

An action object the is dispatched when an object is destroyed

Name	Type	Attribute	Description
actionType	string		The type of action being dispatched
id	number \| string		The id of the destroyed resource

A method signature for rejected request promises

import WebAPI from "./WebAPI";

WebAPI.get("/failed/request").catch(error => {
  // do something with the error
  console.log(error.message);
});

An action object that is dispatched when items should be added to a store

Name	Type	Attribute	Description
actionType	string		The type of action being dispatched
items	Array<object>		An array of items to be added to the store

An object representing a resource query.

Can be one of the following:

A method signature for resolved request promises

import WebAPI from "./WebAPI";

WebAPI.get("/some/path").then(json => {
  // do something with the result
  console.log(json);
});