Interfaces

ICollection

Collection interface

IModelConstructor

Interface for the Model constructor

IModel

Interface for the Model instance

IReferences

Interface for the refs definition.

IDictionary

Basic key/value interface

ICache

Cache interface for fetch and fetchAll methods

IFilters

Interface for the filters property in the IRequestOptions

IHeaders

Interface for the request headers object

IRequestOptions

Interface for the request options object. Can contain, headers, sort, filter, include and fields

IStoreFetchOpts

Fetch options used by the storeFetch and transformRequest methods.

interface IStoreFetchOpts {
  url: string;
  options?: IRequestOptions;
  data?: object;
  method: string;
  store: Store;
}

IRawResponse

Raw response returned by the baseFetch and received by the Response. Includes the JSON API specific data, error and jsonapi properties and library specific headers, requestHeaders and status properties.

IResponseHeaders

Interface for the Headers object

JsonApi

IIdentifier

A valid JSON API identifier

IJsonApiObject

A valid jsonapi property interface

ILink

A valid JSON API link

IError

A valid JSON API error object

IRelationship

A valid JSNO API relationship object

IRecord

A valid JSON API record object

IResponse

A valid JSON API response

IRequest

A valid JSON API request body