Class: RESTAdapter

type

snapshot

Snapshot

Returns

Overrides

AdapterWithBuildURLMixin.createRecord

deleteRecord()

deleteRecord(
   store, 
   schema, 
snapshot): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:769

Called by the store when a record is deleted.

The deleteRecord method makes an Ajax (HTTP DELETE) request to a URL computed by buildURL.

Parameters

store

schema

snapshot

Snapshot

Returns

Overrides

AdapterWithBuildURLMixin.deleteRecord

findAll()

findAll(
   store, 
   type, 
   neverUsed, 
snapshotRecordArray): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:531

Called by the store in order to fetch a JSON array for all of the records for a given type.

The findAll method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a promise for the resulting payload.

Parameters

store

type

neverUsed

null

snapshotRecordArray

SnapshotRecordArray

Returns

Overrides

AdapterWithBuildURLMixin.findAll

findBelongsTo()

findBelongsTo(
   store, 
   snapshot, 
   url, 
relationship): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:708

Called by the store in order to fetch the JSON for the unloaded record in a belongs-to relationship that was originally specified as a URL (inside of links).

For example, if your original payload looks like this:

{
  "person": {
    "id": 1,
    "name": "Tom Dale",
    "links": { "group": "/people/1/group" }
  }
}

This method will be called with the parent record and /people/1/group.

The findBelongsTo method will make an Ajax (HTTP GET) request to the originally specified URL.

The format of your links value will influence the final request URL via the urlPrefix method:

Links beginning with //, http://, https://, will be used as is, with no further manipulation.
Links beginning with a single / will have the current adapter's host value prepended to it.
Links with no beginning / will have a parentURL prepended to it, via the current adapter's buildURL.

Parameters

store

snapshot

Snapshot

url

string

relationship

unknown

Returns

findHasMany()

findHasMany(
   store, 
   snapshot, 
   url, 
relationship): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:659

Called by the store in order to fetch a JSON array for the unloaded records in a has-many relationship that were originally specified as a URL (inside of links).

For example, if your original payload looks like this:

{
  "post": {
    "id": 1,
    "title": "Rails is omakase",
    "links": { "comments": "/posts/1/comments" }
  }
}

This method will be called with the parent record and /posts/1/comments.

The findHasMany method will make an Ajax (HTTP GET) request to the originally specified URL.

The format of your links value will influence the final request URL via the urlPrefix method:

Links beginning with //, http://, https://, will be used as is, with no further manipulation.
Links beginning with a single / will have the current adapter's host value prepended to it.
Links with no beginning / will have a parentURL prepended to it, via the current adapter's buildURL.

Parameters

store

snapshot

Snapshot

url

string

relationship

Record<string, unknown>

Returns

findMany()

findMany(
   store, 
   type, 
   ids, 
snapshots): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:623

Called by the store in order to fetch several records together if coalesceFindRequests is true

For example, if the original payload looks like:

{
  "id": 1,
  "title": "Rails is omakase",
  "comments": [ 1, 2, 3 ]
}

The IDs will be passed as a URL-encoded Array of IDs, in this form:

ids[]=1&ids[]=2&ids[]=3

Many servers, such as Rails and PHP, will automatically convert this URL-encoded array into an Array for you on the server-side. If you want to encode the IDs, differently, just override this (one-line) method.

The findMany method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a promise for the resulting payload.

Parameters

store

type

ids

string[]

snapshots

Snapshot<unknown>[]

Returns

findRecord()

findRecord(
   store, 
   type, 
   id, 
snapshot): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:515

Called by the store in order to fetch the JSON for a given type and ID.

The findRecord method makes an Ajax request to a URL computed by buildURL, and returns a promise for the resulting payload.

This method performs an HTTP GET request with the id provided as part of the query string.

Parameters

store

type

id

string

snapshot

Snapshot

Returns

Since

1.13.0

Overrides

AdapterWithBuildURLMixin.findRecord

groupRecordsForFindMany()

groupRecordsForFindMany(store, snapshots): Snapshot<unknown>[][];

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:830

Organize records into groups, each of which is to be passed to separate calls to findMany.

This implementation groups together records that have the same base URL but differing ids. For example /comments/1 and /comments/2 will be grouped together because we know findMany can coalesce them together as /comments?ids[]=1&ids[]=2

It also supports urls where ids are passed as a query param, such as /comments?id=1 but not those where there is more than 1 query param such as /comments?id=2&name=David Currently only the query param of id is supported. If you need to support others, please override this or the _stripIDFromURL method.

It does not group records that have differing base urls, such as for example: /posts/1/comments/2 and /posts/2/comments/3

Parameters

store

snapshots

Snapshot<unknown>[]

Returns

Snapshot<unknown>[][]

an array of arrays of records, each of which is to be loaded separately by findMany.

Overrides

AdapterWithBuildURLMixin.groupRecordsForFindMany

handleResponse()

handleResponse(
   status, 
   headers, 
   payload, 
   requestData): 
  | AdapterRequestErrorConstructor<AdapterError>
  | Payload;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:878

Takes an ajax response, and returns the json payload or an error.

By default this hook just returns the json payload passed to it. You might want to override it in two cases:

Your API might return useful results in the response headers. Response headers are passed in as the second argument.
Your API might return errors as successful responses with status code 200 and an Errors text or object. You can return a InvalidError or a AdapterError (or a sub class) from this hook and it will automatically reject the promise and put your record into the invalid or error state.

Returning a InvalidError from this method will cause the record to transition into the invalid state and make the errors object available on the record. When returning an InvalidError the store will attempt to normalize the error data returned from the server using the serializer's extractErrors method.

Parameters

status

number

headers

Record<string, string>

payload

Payload

requestData

RequestData

Returns

| AdapterRequestErrorConstructor<AdapterError> | Payload

Since

1.13.0

isInvalid()

isInvalid(
   status, 
   _headers, 
   _payload): boolean;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:930

Default handleResponse implementation uses this hook to decide if the response is an invalid error.

Parameters

status

number

_headers

Record<string, unknown>

_payload

Payload

Returns

boolean

Since

1.13.0

isSuccess()

isSuccess(
   status, 
   _headers, 
   _payload): boolean;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:919

Default handleResponse implementation uses this hook to decide if the response is a success.

Parameters

status

number

_headers

Record<string, unknown>

_payload

Payload

Returns

boolean

Since

1.13.0

pathForType()

pathForType(this, modelName): string;

Defined in: warp-drive-packages/legacy/src/adapter/-private/build-url-mixin.ts:103

Parameters

this

MixtBuildURLMixin

modelName

string

Returns

string

query()

query(
   store, 
   type, 
query): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:556

Called by the store in order to fetch a JSON array for the records that match a particular query.

The query method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a promise for the resulting payload.

The query argument is a simple JavaScript object that will be passed directly to the server as parameters.

Parameters

store

type

query

Record<string, unknown>

Returns

Overrides

AdapterWithBuildURLMixin.query

queryRecord()

queryRecord(
   store, 
   type, 
   query, 
adapterOptions): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:580

Called by the store in order to fetch a JSON object for the record that matches a particular query.

The queryRecord method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a promise for the resulting payload.

The query argument is a simple JavaScript object that will be passed directly to the server as parameters.

Parameters

store

type

query

Record<string, unknown>

adapterOptions

Record<string, unknown>

Returns

Since

1.13.0

Overrides

AdapterWithBuildURLMixin.queryRecord

serialize()

serialize(snapshot, options): Record<string, unknown>;

Defined in: warp-drive-packages/legacy/src/adapter.ts:458

Proxies to the serializer's serialize method.

Example

app/adapters/application.js

import { Adapter } from '@warp-drive/legacy/adapter';

export default class ApplicationAdapter extends Adapter {
  createRecord(store, type, snapshot) {
    let data = this.serialize(snapshot, { includeId: true });
    let url = `/${type.modelName}`;

    // ...
  }
}

Parameters

snapshot

Snapshot

options

SerializerOptions

Returns

Record<string, unknown>

Inherited from

AdapterWithBuildURLMixin.serialize

shouldBackgroundReloadAll()

shouldBackgroundReloadAll(store, snapshotRecordArray): boolean;

Defined in: warp-drive-packages/legacy/src/adapter.ts:865

This method is used by the store to determine if the store should reload a record array after the store.findAll method resolves with a cached record array.

This method is only checked by the store when the store is returning a cached record array.

If this method returns true the store will re-fetch all records from the adapter.

For example, if you do not want to fetch complex data over a mobile connection, or if the network is down, you can implement shouldBackgroundReloadAll as follows:

javascript

shouldBackgroundReloadAll(store, snapshotArray) {
  let { downlink, effectiveType } = navigator.connection;

  return downlink > 0 && effectiveType === '4g';
}

By default this method returns true, indicating that a background reload should always be triggered.

Parameters

store

snapshotRecordArray

SnapshotRecordArray

Returns

boolean

Since

1.13.0

Inherited from

AdapterWithBuildURLMixin.shouldBackgroundReloadAll

shouldBackgroundReloadRecord()

shouldBackgroundReloadRecord(store, snapshot): boolean;

Defined in: warp-drive-packages/legacy/src/adapter.ts:829

This method is used by the store to determine if the store should reload a record after the store.findRecord method resolves a cached record.

This method is only checked by the store when the store is returning a cached record.

If this method returns true the store will re-fetch a record from the adapter.

For example, if you do not want to fetch complex data over a mobile connection, or if the network is down, you can implement shouldBackgroundReloadRecord as follows:

javascript

shouldBackgroundReloadRecord(store, snapshot) {
  let { downlink, effectiveType } = navigator.connection;

  return downlink > 0 && effectiveType === '4g';
}

By default, this hook returns true so the data for the record is updated in the background.

Parameters

store

snapshot

Snapshot

Returns

boolean

Since

1.13.0

Inherited from

AdapterWithBuildURLMixin.shouldBackgroundReloadRecord

shouldReloadAll()

shouldReloadAll(store, snapshotRecordArray): boolean;

Defined in: warp-drive-packages/legacy/src/adapter.ts:793

This method is used by the store to determine if the store should reload all records from the adapter when records are requested by store.findAll.

If this method returns true, the store will re-fetch all records from the adapter. If this method returns false, the store will resolve immediately using the cached records.

For example, if you are building an events ticketing system, in which users can only reserve tickets for 20 minutes at a time, and want to ensure that in each route you have data that is no more than 20 minutes old you could write:

javascript

shouldReloadAll(store, snapshotArray) {
  let snapshots = snapshotArray.snapshots();

  return snapshots.any((ticketSnapshot) => {
    let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt');
    let timeDiff = moment().diff(lastAccessedAt, 'minutes');

    if (timeDiff > 20) {
      return true;
    } else {
      return false;
    }
  });
}

This method would ensure that whenever you do store.findAll('ticket') you will always get a list of tickets that are no more than 20 minutes old. In case a cached version is more than 20 minutes old, findAll will not resolve until you fetched the latest versions.

By default, this method returns true if the passed snapshotRecordArray is empty (meaning that there are no records locally available yet), otherwise, it returns false.

Note that, with default settings, shouldBackgroundReloadAll will always re-fetch all the records in the background even if shouldReloadAll returns false. You can override shouldBackgroundReloadAll if this does not suit your use case.

Parameters

store

snapshotRecordArray

SnapshotRecordArray

Returns

boolean

Since

1.13.0

Inherited from

AdapterWithBuildURLMixin.shouldReloadAll

shouldReloadRecord()

shouldReloadRecord(store, snapshot): boolean;

Defined in: warp-drive-packages/legacy/src/adapter.ts:738

This method is used by the store to determine if the store should reload a record from the adapter when a record is requested by store.findRecord.

If this method returns true, the store will re-fetch a record from the adapter. If this method returns false, the store will resolve immediately using the cached record.

javascript

shouldReloadRecord(store, ticketSnapshot) {
  let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt');
  let timeDiff = moment().diff(lastAccessedAt, 'minutes');

  if (timeDiff > 20) {
    return true;
  } else {
    return false;
  }
}

This method would ensure that whenever you do store.findRecord('ticket', id) you will always get a ticket that is no more than 20 minutes old. In case the cached version is more than 20 minutes old, findRecord will not resolve until you fetched the latest version.

By default this hook returns false, as most UIs should not block user interactions while waiting on data update.

Note that, with default settings, shouldBackgroundReloadRecord will always re-fetch the records in the background even if shouldReloadRecord returns false. You can override shouldBackgroundReloadRecord if this does not suit your use case.

Parameters

store

snapshot

Snapshot

Returns

boolean

Since

1.13.0

Inherited from

AdapterWithBuildURLMixin.shouldReloadRecord

sortQueryParams()

sortQueryParams(obj): Record<string, unknown>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:374

By default, the RESTAdapter will send the query params sorted alphabetically to the server.

For example:

store.query('posts', { sort: 'price', category: 'pets' });

will generate a requests like this /posts?category=pets&sort=price, even if the parameters were specified in a different order.

That way the generated URL will be deterministic and that simplifies caching mechanisms in the backend.

Setting sortQueryParams to a falsey value will respect the original order.

In case you want to sort the query parameters with a different criteria, set sortQueryParams to your custom sort function.

app/adapters/application.js

import { RESTAdapter } from '@warp-drive/legacy/adapter/rest';

export default class ApplicationAdapter extends RESTAdapter {
  sortQueryParams(params) {
    let sortedKeys = Object.keys(params).sort().reverse();
    let len = sortedKeys.length, newParams = {};

    for (let i = 0; i < len; i++) {
      newParams[sortedKeys[i]] = params[sortedKeys[i]];
    }

    return newParams;
  }
}

Parameters

obj

Record<string, unknown>

Returns

Record<string, unknown>

updateRecord()

updateRecord(
   store, 
   schema, 
snapshot): Promise<AdapterPayload>;

Defined in: warp-drive-packages/legacy/src/adapter/rest.ts:752

Called by the store when an existing record is saved via the save method on a model record instance.

The updateRecord method serializes the record and makes an Ajax (HTTP PUT) request to a URL computed by buildURL.

See serialize for information on how to customize the serialized form of a record.

Parameters

store

schema

snapshot

Snapshot

Returns