Global

Type Definitions

VracOnlyOptions

Vrac only class initilisation options.
Type:
  • object
Properties:
Name Type Description
cacheSingle function Function to cache a single item returned from the API.
cacheMultiple function Function to cache multiple items returned from the API.
cacheDestroy function Function to remove an item from the cache after a `destroy` call.
cacheBinary function Function to cache cache a binary item returned from the API.
singleton boolean Whether this is a singleton endpoint or not.
Source:

VracOptions

Vrac and Vra combined class initilisation options.
Type:
Source:

VraOptions

Vra class initilisation options.
Type:
  • object
Properties:
Name Type Description
baseUrl string URL of the endpoint, without the models ID.
only Array.<string> | string Which actions to create for this model.
except Array.<string> | string Which actions not to create for this model.
identifier string The identifier field, e.g. `id`.
children object Children for this module.
singleton boolean Whether this is a singleton endpoint or not - i.e. Only `read` and `update` calls.
toModel function Convert API data to a model.
customCalls object Custom and extra API calls to add to this model.
parseSingle function Function to parse a single item returned from the API.
parseMultiple function Function to parse a multiple items returned from the API.
parseBinary function Function to parse a binary item returned from the API.
Source: