WarpDrive

default._stripIDFromURL

snapshot

Snapshot

Returns

string

Inherited from

buildQuery()

buildQuery(snapshot): QueryState;

Defined in: warp-drive-packages/legacy/declarations/adapter/json-api.d.ts:231

Used by findAll and findRecord to build the query's data hash supplied to the ajax method.

Parameters

snapshot

Snapshot<unknown> | SnapshotRecordArray

Returns

QueryState

Since

2.5.0

Overrides

default.buildQuery

buildURL()

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:4

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"findRecord"

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:5

Parameters

this

MixtBuildURLMixin

modelName

string

id

null

snapshot

SnapshotRecordArray

requestType

"findAll"

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType, 
   query): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:6

Parameters

this

MixtBuildURLMixin

modelName

string

id

null

snapshot

null

requestType

"query"

query

Record<string, unknown>

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType, 
   query): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:7

Parameters

this

MixtBuildURLMixin

modelName

string

id

null

snapshot

null

requestType

"queryRecord"

query

Record<string, unknown>

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:8

Parameters

this

MixtBuildURLMixin

modelName

string

id

string[]

snapshot

Snapshot<unknown>[]

requestType

"findMany"

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:9

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"findHasMany"

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:10

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"findBelongsTo"

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:11

Parameters

this

MixtBuildURLMixin

modelName

string

id

null | string

snapshot

Snapshot

requestType

"createRecord"

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:12

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"updateRecord"

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:13

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"deleteRecord"

Returns

string

Inherited from

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/-private/build-url-mixin.d.ts:14

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

Returns

string

Inherited from

createRecord()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:625

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

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

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

Parameters

store

type

snapshot

Snapshot

Returns

Promise<AdapterPayload>

promise

Inherited from

default.createRecord

deleteRecord()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:654

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

Promise<AdapterPayload>

promise

Inherited from

default.deleteRecord

findAll()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:460

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

sinceToken

null

snapshotRecordArray

SnapshotRecordArray

Returns

Promise<AdapterPayload>

promise

Inherited from

default.findAll

findBelongsTo()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:608

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

default.findBelongsTo

snapshot

Snapshot

url

string

relationship

any

meta object describing the relationship

Returns

Promise<AdapterPayload>

promise

Inherited from

findHasMany()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:571

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>

meta object describing the relationship

Returns

Promise<AdapterPayload>

promise

Inherited from

default.findHasMany

findMany()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/json-api.d.ts:219

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

Promise<AdapterPayload>

promise

Overrides

default.findMany

findRecord()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:445

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

Promise<AdapterPayload>

promise

Since

1.13.0

Inherited from

default.findRecord

groupRecordsForFindMany()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:679

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

default.groupRecordsForFindMany

snapshots

Snapshot<unknown>[]

Returns

Snapshot<unknown>[][]

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

Inherited from

handleResponse()

handleResponse(
   status, 
   headers, 
   payload, 
   requestData): typeof _AdapterError | Payload;

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:709

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

the original request information

Returns

typeof _AdapterError | Payload

response

Since

1.13.0

Inherited from

default.handleResponse

isInvalid()

isInvalid(
   status, 
   _headers, 
   _payload): boolean;

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:733

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

Inherited from

default.isInvalid

isSuccess()

isSuccess(
   status, 
   _headers, 
   _payload): boolean;

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:721

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

Inherited from

default.isSuccess

pathForType()

pathForType(modelName): string;

Defined in: warp-drive-packages/legacy/declarations/adapter/json-api.d.ts:220

Parameters

modelName

string

Returns

string

Overrides

default.pathForType

query()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:480

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

Promise<AdapterPayload>

promise

Inherited from

default.query

queryRecord()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:500

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

default.sortQueryParams

query

Record<string, unknown>

adapterOptions

Record<string, unknown>

Returns

Promise<AdapterPayload>

promise

Since

1.13.0

Inherited from

default.queryRecord

sortQueryParams()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/rest.d.ts:317

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>

Inherited from

updateRecord()

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

Defined in: warp-drive-packages/legacy/declarations/adapter/json-api.d.ts:221

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