Configuration

Configure the ARM instance from wherever it’s stored (your arm-config-provider, typically) before making any requests.

Required configuration

setHost(host)

Sets the API endpoint host URL. Defaults to window.location.origin when unset.

ARM.setHost('https://api.example.com')

setNamespace(namespace)

Sets the API endpoint namespace, appended between the host and resource path. Defaults to 'api/v1'.

ARM.setNamespace('api/v1')

setHeadersCommon(key, value)

Sets a header sent on every request.

ARM.setHeadersCommon('Authorization', `Token ${token}`)
ARM.setHeadersCommon('Content-Type', 'application/vnd.api+json')
ARM.setHeadersCommon('X-Client-Platform', 'Web')

Optional configuration

setGlobal()

Attaches the ARM instance to window.ARM, so it’s reachable without an import - useful for debugging in the browser console.

ARM.setGlobal()

setPayloadIncludeReference(key)

Sets the key used to resolve a JSON:API included array’s records back to their collections.

// Given a payload shaped like:
// { data: [...], included: [{ id: 1, type: 'addresses' }], meta: {...} }
ARM.setPayloadIncludeReference('type')

See setHost, setNamespace, setHeadersCommon, setGlobal, and setPayloadIncludeReference in the API reference for full signatures.