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:
ErrorIfresourceis not a registered collection.
| Param | Type | Default | Description |
|---|---|---|---|
| resource | string | The resource name / collection name. | |
| id | number | string | The record ID to fetch. | |
| [params] | Object | | Query parameters appended to the request URL. |
| [config] | RequestConfig | | Request configuration options. |
Example
// Reactive - numeric ID
const result = ARM.findRecord('addresses', 123, null, { alias: 'currentAddress' })
result.isLoading // true while fetching
result.data // CollectionRecord once resolvedExample
// 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