query()

Fetches multiple records from the server (GET /{resource}).

By default returns a reactive request hash object immediately (before the request resolves) so it can be bound directly in a component. Set config.autoResolve: false to receive a Promise instead.

Kind: global function
Returns: Object | Promise - Reactive request hash (default) or Axios Promise when autoResolve: false.
Throws:

• Error If resource is not a registered collection.

Example

// Reactive (default) - bind directly in a component
const result = ARM.query('addresses', { 'filter[kind]': 'home' }, { alias: 'homeAddresses' })
result.isLoading // true while fetching
result.data      // array of CollectionRecord

Example

// Awaitable - full control over loading state
const result = await ARM.query('addresses', { include: 'users' }, { autoResolve: false })