Documentation / @ember-data/adapter / rest / default

Class: default

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

⚠️ This is LEGACY documentation for a feature that is no longer encouraged to be used. If starting a new app or thinking of implementing a new adapter, consider writing a Handler instead to be used with the RequestManager

The REST adapter allows your store to communicate with an HTTP server by transmitting JSON via XHR.

This adapter is designed around the idea that the JSON exchanged with the server should be conventional. It builds URLs in a manner that follows the structure of most common REST-style web services.

Success and failure

The REST adapter will consider a success any response with a status code of the 2xx family ("Success"), as well as 304 ("Not Modified"). Any other status code will be considered a failure.

On success, the request promise will be resolved with the full response payload.

Failed responses with status code 422 ("Unprocessable Entity") will be considered "invalid". The response will be discarded, except for the errors key. The request promise will be rejected with a InvalidError. This error object will encapsulate the saved errors value.

Any other status codes will be treated as an "adapter error". The request promise will be rejected, similarly to the "invalid" case, but with an instance of AdapterError instead.

JSON Structure

The REST adapter expects the JSON returned from your server to follow these conventions.

Object Root

The JSON payload should be an object that contains the record inside a root property. For example, in response to a GET request for /posts/1, the JSON should look like this:

{
"posts": {
"id": 1,
"title": "I'm Running to Reform the W3C",
"author": "Yehuda Katz"
}
}

Similarly, in response to a GET request for /posts, the JSON should look like this:

{
"posts": [
{
"id": 1,
"title": "I'm Running to Reform the W3C",
"author": "Yehuda Katz"
},
{
"id": 2,
"title": "Rails is omakase",
"author": "D2H"
}
]
}

Note that the object root can be pluralized for both a single-object response and an array response: the REST adapter is not strict on this. Further, if the HTTP server responds to a GET request to /posts/1 (e.g. the response to a findRecord query) with more than one object in the array, Ember Data will only display the object with the matching ID.

Conventional Names

Attribute names in your JSON payload should be the camelCased versions of the attributes in your Ember.js models.

For example, if you have a Person model:

app/models/person.js

import { Model, attr } from '@warp-drive/legacy/model';

export default Model.extend({
firstName: attr('string'),
lastName: attr('string'),
occupation: attr('string')
});

The JSON returned should look like this:

{
"people": {
"id": 5,
"firstName": "Zaphod",
"lastName": "Beeblebrox",
"occupation": "President"
}
}

Relationships

Relationships are usually represented by ids to the record in the relationship. The related records can then be sideloaded in the response under a key for the type.

{
"posts": {
"id": 5,
"title": "I'm Running to Reform the W3C",
"author": "Yehuda Katz",
"comments": [1, 2]
},
"comments": [{
"id": 1,
"author": "User 1",
"message": "First!",
}, {
"id": 2,
"author": "User 2",
"message": "Good Luck!",
}]
}

If the records in the relationship are not known when the response is serialized it's also possible to represent the relationship as a URL using the links key in the response. Ember Data will fetch this URL to resolve the relationship when it is accessed for the first time.

{
"posts": {
"id": 5,
"title": "I'm Running to Reform the W3C",
"author": "Yehuda Katz",
"links": {
"comments": "/posts/5/comments"
}
}
}

Errors

If a response is considered a failure, the JSON payload is expected to include a top-level key errors, detailing any specific issues. For example:

{
"errors": {
"msg": "Something went wrong"
}
}

This adapter does not make any assumptions as to the format of the errors object. It will simply be passed along as is, wrapped in an instance of InvalidError or AdapterError. The serializer can interpret it afterwards.

Customization

Endpoint path customization

Endpoint paths can be prefixed with a namespace by setting the namespace property on the adapter:

app/adapters/application.js

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

export default class ApplicationAdapter extends RESTAdapter {
namespace = 'api/1';
}

Requests for the Person model would now target /api/1/people/1.

Host customization

An adapter can target other hosts by setting the host property.

app/adapters/application.js

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

export default class ApplicationAdapter extends RESTAdapter {
host = 'https://api.example.com';
}

Headers customization

Some APIs require HTTP headers, e.g. to provide an API key. Arbitrary headers can be set as key/value pairs on the RESTAdapter's headers object and WarpDrive will send them along with each ajax request.

app/adapters/application.js

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

export default class ApplicationAdapter extends RESTAdapter {
get headers() {
return {
'API_KEY': 'secret key',
'ANOTHER_HEADER': 'Some header value'
};
}
}

RESTAdapter

Uses

BuildURLMixin

Extends

• AdapterWithBuildURLMixin.MixtBuildURLMixin

Extended by

• default

Methods

_ajax()

_ajax(options): void;

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

Parameters

options

JQueryRequestInit | FetchRequestInit

Returns

void

---

_ajaxURL()

_ajaxURL(url): string;

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

Parameters

url

string

Returns

string

---

_buildURL()

_buildURL(
   this, 
   modelName, 
   id?): string;

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

Parameters

this

MixtBuildURLMixin

modelName

undefined | null | string

id?

null | string

Returns

string

Inherited from

AdapterWithBuildURLMixin._buildURL

---

_fetchRequest()

_fetchRequest(options): Promise<Response>;

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

Parameters

options

FetchRequestInit

Returns

Promise<Response>

---

_stripIDFromURL()

_stripIDFromURL(store, snapshot): string;

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

Parameters

store

default

snapshot

Snapshot

Returns

string

---

buildQuery()

buildQuery(snapshot): QueryState;

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

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

---

buildURL()

Call Signature

buildURL(
   this, 
   modelName, 
   id, 
   snapshot, 
   requestType): 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

requestType

"findRecord"

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

null

snapshot

SnapshotRecordArray

requestType

"findAll"

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

null

snapshot

null

requestType

"query"

query

Record<string, unknown>

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

null

snapshot

null

requestType

"queryRecord"

query

Record<string, unknown>

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

string[]

snapshot

Snapshot<unknown>[]

requestType

"findMany"

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"findHasMany"

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"findBelongsTo"

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

null | string

snapshot

Snapshot

requestType

"createRecord"

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"updateRecord"

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

requestType

"deleteRecord"

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

Call Signature

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

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

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

Returns

string

Inherited from

AdapterWithBuildURLMixin.buildURL

---

createRecord()

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

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

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

default

type

ModelSchema

snapshot

Snapshot

Returns

Promise<AdapterPayload>

promise

---

deleteRecord()

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

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

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

default

schema

ModelSchema

snapshot

Snapshot

Returns

Promise<AdapterPayload>

promise

---

findAll()

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

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

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

default

type

ModelSchema

sinceToken

null

snapshotRecordArray

SnapshotRecordArray

Returns

Promise<AdapterPayload>

promise

---

findBelongsTo()

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

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

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

snapshot

Snapshot

url

string

relationship

unknown

Returns

Promise<AdapterPayload>

---

findHasMany()

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

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

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

default

snapshot

Snapshot

url

string

relationship

Record<string, unknown>

meta object describing the relationship

Returns

Promise<AdapterPayload>

promise

---

findMany()

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

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

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

default

type

ModelSchema

ids

string[]

snapshots

Snapshot<unknown>[]

Returns

Promise<AdapterPayload>

promise

---

findRecord()

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

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

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

default

type

ModelSchema

id

string

snapshot

Snapshot

Returns

Promise<AdapterPayload>

promise

Since

1.13.0

---

groupRecordsForFindMany()

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

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

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

snapshots

Snapshot<unknown>[]

Returns

Snapshot<unknown>[][]

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

---

handleResponse()

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

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

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:

1. Your API might return useful results in the response headers. Response headers are passed in as the second argument.

2. 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

| AdapterRequestErrorConstructor<default> | Payload

response

Since

1.13.0

---

isInvalid()

isInvalid(
   status, 
   _headers, 
   _payload): boolean;

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

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/declarations/adapter/rest.d.ts:719

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/declarations/adapter/-private/build-url-mixin.d.ts:37

Parameters

this

MixtBuildURLMixin

modelName

string

Returns

string

Inherited from

AdapterWithBuildURLMixin.pathForType

---

query()

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

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

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

default

type

ModelSchema

query

Record<string, unknown>

Returns

Promise<AdapterPayload>

promise

---

queryRecord()

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

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

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

default

type

ModelSchema

query

Record<string, unknown>

adapterOptions

Record<string, unknown>

Returns

Promise<AdapterPayload>

promise

Since

1.13.0

---

sortQueryParams()

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

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

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/declarations/adapter/rest.d.ts:639

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

default

schema

ModelSchema

snapshot

Snapshot

Returns

Promise<AdapterPayload>

promise

---

urlForCreateRecord()

urlForCreateRecord(
   this, 
   modelName, 
   snapshot): string;

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

Parameters

this

MixtBuildURLMixin

modelName

string

snapshot

Snapshot

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForCreateRecord

---

urlForDeleteRecord()

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

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

Parameters

this

MixtBuildURLMixin

id

string

modelName

string

snapshot

Snapshot

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForDeleteRecord

---

urlForFindAll()

urlForFindAll(
   this, 
   modelName, 
   snapshots): string;

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

Parameters

this

MixtBuildURLMixin

modelName

string

snapshots

SnapshotRecordArray

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForFindAll

---

urlForFindBelongsTo()

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

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

Parameters

this

MixtBuildURLMixin

id

string

modelName

string

snapshot

Snapshot

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForFindBelongsTo

---

urlForFindHasMany()

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

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

Parameters

this

MixtBuildURLMixin

id

string

modelName

string

snapshot

Snapshot

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForFindHasMany

---

urlForFindMany()

urlForFindMany(
   this, 
   ids, 
   modelName, 
   snapshots): string;

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

Parameters

this

MixtBuildURLMixin

ids

string[]

modelName

string

snapshots

Snapshot<unknown>[]

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForFindMany

---

urlForFindRecord()

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

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

Parameters

this

MixtBuildURLMixin

id

string

modelName

string

snapshot

Snapshot

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForFindRecord

---

urlForQuery()

urlForQuery(
   this, 
   query, 
   modelName): string;

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

Parameters

this

MixtBuildURLMixin

query

Record<string, unknown>

modelName

string

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForQuery

---

urlForQueryRecord()

urlForQueryRecord(
   this, 
   query, 
   modelName): string;

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

Parameters

this

MixtBuildURLMixin

query

Record<string, unknown>

modelName

string

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForQueryRecord

---

urlForUpdateRecord()

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

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

Parameters

this

MixtBuildURLMixin

id

string

modelName

string

snapshot

Snapshot

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlForUpdateRecord

---

urlPrefix()

urlPrefix(
   this, 
   path?, 
   parentURL?): string;

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

Parameters

this

MixtBuildURLMixin

path?

null | string

parentURL?

string

Returns

string

Inherited from

AdapterWithBuildURLMixin.urlPrefix

Properties

_coalesceFindRequests

_coalesceFindRequests: boolean;

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

---

_defaultContentType

_defaultContentType: string;

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

---

_fastboot

_fastboot: FastBoot;

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

---

headers

headers: 
  | undefined
| Record<string, unknown>;

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

Some APIs require HTTP headers, e.g. to provide an API key. Arbitrary headers can be set as key/value pairs on the RESTAdapter's headers object and Ember Data will send them along with each ajax request. For dynamic headers see headers customization.

app/adapters/application.js

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

export default class ApplicationAdapter extends RESTAdapter {
get headers() {
return {
'API_KEY': 'secret key',
'ANOTHER_HEADER': 'Some header value'
};
}
}

---

host

host: null | string;

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

Overrides

AdapterWithBuildURLMixin.host

---

maxURLLength

maxURLLength: number;

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

---

namespace

namespace: null | string;

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

Overrides

AdapterWithBuildURLMixin.namespace

---

useFetch

useFetch: boolean;

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

This property allows ajax to still be used instead when false.

Default

true
@public

coalesceFindRequests

Get Signature

get coalesceFindRequests(): boolean;

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

By default the RESTAdapter will send each find request coming from a store.find or from accessing a relationship separately to the server. If your server supports passing ids as a query string, you can set coalesceFindRequests to true to coalesce all find requests within a single runloop.

For example, if you have an initial payload of:

{
post: {
id: 1,
comments: [1, 2]
}
}

By default calling post.comments will trigger the following requests(assuming the comments haven't been loaded before):

GET /comments/1
GET /comments/2

If you set coalesceFindRequests to true it will instead trigger the following request:

GET /comments?ids[]=1&ids[]=2

Setting coalesceFindRequests to true also works for store.find requests and belongsTo relationships accessed within the same runloop. If you set coalesceFindRequests: true

store.findRecord('comment', 1);
store.findRecord('comment', 2);

will also send a request to: GET /comments?ids[]=1&ids[]=2

Note: Requests coalescing rely on URL building strategy. So if you override buildURL in your app groupRecordsForFindMany more likely should be overridden as well in order for coalescing to work.

Returns

boolean

Set Signature

set coalesceFindRequests(value): void;

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

Parameters

value

boolean

Returns

void

---

fastboot

Get Signature

get fastboot(): FastBoot;

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

Returns

FastBoot

Set Signature

set fastboot(value): void;

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

Parameters

value

FastBoot

Returns

void

Constructors

Constructor

new default(): RESTAdapter;

Returns

RESTAdapter

Inherited from

AdapterWithBuildURLMixin.constructor