Skip to Content

findRecord()

Fetches a single record by ID from the server (GET /{resource}/{id}).

Accepts both numeric and string IDs (string ID support added in v2.9.0).

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.
ParamTypeDefaultDescription
resourcestringThe resource name / collection name.
idnumber | stringThe record ID to fetch.
[params]ObjectQuery parameters appended to the request URL.
[config]RequestConfigRequest configuration options.

Example

// Reactive - numeric ID const result = ARM.findRecord('addresses', 123, null, { alias: 'currentAddress' }) result.isLoading // true while fetching result.data // CollectionRecord once resolved

Example

// String ID ARM.findRecord('addresses', 'JO-26181S4VPU65', null, { alias: 'currentAddress' })

Example

// Awaitable with query params await ARM.findRecord('addresses', 123, { include: 'user' }, { autoResolve: false })
Last updated on