Class: JSONAPIAdapter

RESTAdapter._stripIDFromURL

snapshot

Snapshot

Returns

string

Inherited from

addObserver()

Call Signature

addObserver<Target>(
   key, 
   target, 
   method): this;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:333

Adds an observer on a property.

This is the core method used to register an observer for a property.

Once you call this method, any time the key's value is set, your observer will be notified. Note that the observers are triggered any time the value is set, regardless of whether it has actually changed. Your observer should be prepared to handle that.

There are two common invocation patterns for .addObserver():

Passing two arguments:
- the name of the property to observe (as a string)
- the function to invoke (an actual function)
Passing three arguments:
- the name of the property to observe (as a string)
- the target object (will be used to look up and invoke a function on)
- the name of the function to invoke on the target object (as a string).

app/components/my-component.js

import Component from '@ember/component';

export default Component.extend({
  init() {
    this._super(...arguments);

    // the following are equivalent:

    // using three arguments
    this.addObserver('foo', this, 'fooDidChange');

    // using two arguments
    this.addObserver('foo', (...args) => {
      this.fooDidChange(...args);
    });
  },

  fooDidChange() {
    // your custom logic code
  }
});

Observer Methods

Observer methods have the following signature:

app/components/my-component.js

import Component from '@ember/component';

export default Component.extend({
  init() {
    this._super(...arguments);
    this.addObserver('foo', this, 'fooDidChange');
  },

  fooDidChange(sender, key, value, rev) {
    // your code
  }
});

The sender is the object that changed. The key is the property that changes. The value property is currently reserved and unused. The rev is the last property revision of the object when it changed, which you can use to detect if the key value has really changed or not.

Usually you will not need the value or revision parameters at the end. In this case, it is common to write observer methods that take only a sender and key value as parameters or, if you aren't interested in any of these values, to write an observer that has no parameters at all.

Type Parameters

Target

Target

Parameters

key

keyof JSONAPIAdapter

The key to observe

target

Target

The target object to invoke

method

ObserverMethod<Target, JSONAPIAdapter>

The method to invoke

Returns

this

Method

addObserver

Inherited from

RESTAdapter.addObserver

Call Signature

addObserver(key, method): this;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:338

Parameters

key

keyof JSONAPIAdapter

method

ObserverMethod<JSONAPIAdapter, JSONAPIAdapter>

Returns

this

Inherited from

RESTAdapter.addObserver

buildQuery()

buildQuery(snapshot): QueryState;

Defined in: warp-drive-packages/legacy/src/adapter/json-api.ts:276

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

RESTAdapter.buildQuery

buildURL()

Call Signature

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

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

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/src/adapter/-private/build-url-mixin.ts:25

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/src/adapter/-private/build-url-mixin.ts:32

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/src/adapter/-private/build-url-mixin.ts:40

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/src/adapter/-private/build-url-mixin.ts:48

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/src/adapter/-private/build-url-mixin.ts:55

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/src/adapter/-private/build-url-mixin.ts:62

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/src/adapter/-private/build-url-mixin.ts:69

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/src/adapter/-private/build-url-mixin.ts:76

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/src/adapter/-private/build-url-mixin.ts:83

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/src/adapter/-private/build-url-mixin.ts:90

Parameters

this

MixtBuildURLMixin

modelName

string

id

string

snapshot

Snapshot

Returns

string

Inherited from

cacheFor()

cacheFor<K>(key): unknown;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:413

Returns the cached value of a computed property, if it exists. This allows you to inspect the value of a computed property without accidentally invoking it if it is intended to be generated lazily.

Type Parameters

K

K extends keyof JSONAPIAdapter

Parameters

key

K

Returns

unknown

The cached value of the computed property, if any

Method

cacheFor

Inherited from

RESTAdapter.cacheFor

createRecord()

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

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

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

RESTAdapter.createRecord

promise

Inherited from

decrementProperty()

decrementProperty(keyName, decrement?): number;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:387

Set the value of a property to the current value minus some amount.

javascript

player.decrementProperty('lives');
orc.decrementProperty('health', 5);

Parameters

keyName

keyof JSONAPIAdapter

The name of the property to decrement

decrement?

number

The amount to decrement by. Defaults to 1

Returns

number

The new property value

Method

decrementProperty

Inherited from

RESTAdapter.decrementProperty

deleteRecord()

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

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

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

RESTAdapter.deleteRecord

promise

Inherited from

destroy()

destroy(): this;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/core.d.ts:300

Destroys an object by setting the isDestroyed flag and removing its metadata, which effectively destroys observers and bindings.

If you try to set a property on a destroyed object, an exception will be raised.

Note that destruction is scheduled for the end of the run loop and does not happen immediately. It will set an isDestroying flag immediately.

Returns

this

receiver

Method

destroy

Inherited from

RESTAdapter.destroy

findAll()

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

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

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

Inherited from

RESTAdapter.findAll

findBelongsTo()

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

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

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

any

meta object describing the relationship

Returns

RESTAdapter.findBelongsTo

promise

Inherited from

findHasMany()

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

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

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

RESTAdapter.findHasMany

promise

Inherited from

findMany()

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

Defined in: warp-drive-packages/legacy/src/adapter/json-api.ts:246

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

Overrides

RESTAdapter.findMany

findRecord()

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

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

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

RESTAdapter.findRecord

promise

Since

1.13.0

Inherited from

get()

Call Signature

get<K>(key): JSONAPIAdapter[K];

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:121

Retrieves the value of a property from the object.

This method is usually similar to using object[keyName] or object.keyName, however it supports both computed properties and the unknownProperty handler.

Because get unifies the syntax for accessing all these kinds of properties, it can make many refactorings easier, such as replacing a simple property with a computed property, or vice versa.

Computed Properties

Computed properties are methods defined with the property modifier declared at the end, such as:

javascript

import { computed } from '@ember/object';

fullName: computed('firstName', 'lastName', function() {
  return this.get('firstName') + ' ' + this.get('lastName');
})

When you call get on a computed property, the function will be called and the return value will be returned instead of the function itself.

Unknown Properties

Likewise, if you try to call get on a property whose value is undefined, the unknownProperty() method will be called on the object. If this method returns any value other than undefined, it will be returned instead. This allows you to implement "virtual" properties that are not defined upfront.

Type Parameters

K

K extends keyof JSONAPIAdapter

Parameters

key

K

Returns

JSONAPIAdapter[K]

The property value or undefined.

Method

get

Inherited from

RESTAdapter.get

Call Signature

get(key): unknown;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:122

Parameters

key

string

Returns

unknown

Inherited from

RESTAdapter.get

getProperties()

Call Signature

getProperties<L>(list): { [Key in keyof JSONAPIAdapter]: JSONAPIAdapter[Key] };

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:144

To get the values of multiple properties at once, call getProperties with a list of strings or an array:

javascript

record.getProperties('firstName', 'lastName', 'zipCode');
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

is equivalent to:

javascript

record.getProperties(['firstName', 'lastName', 'zipCode']);
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

Type Parameters

L

L extends keyof JSONAPIAdapter[]

Parameters

list

L

of keys to get

Returns

{ [Key in keyof JSONAPIAdapter]: JSONAPIAdapter[Key] }

Method

getProperties

Inherited from

Call Signature

getProperties<L>(...list): { [Key in keyof JSONAPIAdapter]: JSONAPIAdapter[Key] };

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:149

Type Parameters

L

L extends keyof JSONAPIAdapter[]

Parameters

list

...L

Returns

{ [Key in keyof JSONAPIAdapter]: JSONAPIAdapter[Key] }

Inherited from

Call Signature

getProperties<L>(list): { [Key in string]: unknown };

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:154

Type Parameters

L

L extends string[]

Parameters

list

L

Returns

{ [Key in string]: unknown }

Inherited from

Call Signature

getProperties<L>(...list): { [Key in string]: unknown };

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:159

Type Parameters

L

L extends string[]

Parameters

list

...L

Returns

{ [Key in string]: unknown }

Inherited from

groupRecordsForFindMany()

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

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

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

RESTAdapter.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): Payload | typeof _AdapterError;

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

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

Payload | typeof _AdapterError

response

Since

1.13.0

Inherited from

RESTAdapter.handleResponse

incrementProperty()

incrementProperty(keyName, increment?): number;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:372

Set the value of a property to the current value plus some amount.

javascript

person.incrementProperty('age');
team.incrementProperty('score', 2);

Parameters

keyName

keyof JSONAPIAdapter

The name of the property to increment

increment?

number

The amount to increment by. Defaults to 1

Returns

number

The new property value

Method

incrementProperty

Inherited from

RESTAdapter.incrementProperty

init()

init(_properties): void;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/core.d.ts:114

An overridable method called when objects are instantiated. By default, does nothing unless it is overridden during class definition.

Example:

javascript

import EmberObject from '@ember/object';

const Person = EmberObject.extend({
  init() {
    alert(`Name is ${this.get('name')}`);
  }
});

let steve = Person.create({
  name: 'Steve'
});

// alerts 'Name is Steve'.

NOTE: If you do override init for a framework class like Component from @ember/component, be sure to call this._super(...arguments) in your init declaration! If you don't, Ember may not have an opportunity to do important setup work, and you'll see strange behavior in your application.

Parameters

_properties

undefined | object

Returns

void

Method

init

Inherited from

RESTAdapter.init

isInvalid()

isInvalid(
   status, 
   _headers, 
   _payload): boolean;

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

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

RESTAdapter.isInvalid

isSuccess()

isSuccess(
   status, 
   _headers, 
   _payload): boolean;

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

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

RESTAdapter.isSuccess

notifyPropertyChange()

notifyPropertyChange(keyName): this;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:249

Convenience method to call propertyWillChange and propertyDidChange in succession.

Notify the observer system that a property has just changed.

Sometimes you need to change a value directly or indirectly without actually calling get() or set() on it. In this case, you can use this method instead. Calling this method will notify all observers that the property has potentially changed value.

Parameters

keyName

string

The property key to be notified about.

Returns

this

Method

notifyPropertyChange

Inherited from

RESTAdapter.notifyPropertyChange

pathForType()

pathForType(modelName): string;

Defined in: warp-drive-packages/legacy/src/adapter/json-api.ts:251

Parameters

modelName

string

Returns

string

Overrides

RESTAdapter.pathForType

query()

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

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

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

Inherited from

RESTAdapter.query

queryRecord()

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

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

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

RESTAdapter.queryRecord

promise

Since

1.13.0

Inherited from

removeObserver()

Call Signature

removeObserver<Target>(
   key, 
   target, 
   method): this;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:352

Remove an observer you have previously registered on this object. Pass the same key, target, and method you passed to addObserver() and your target will no longer receive notifications.

Type Parameters

Target

Target

Parameters

key

keyof JSONAPIAdapter

The key to observe

target

Target

The target object to invoke

method

ObserverMethod<Target, JSONAPIAdapter>

The method to invoke

Returns

this

Method

removeObserver

Inherited from

RESTAdapter.removeObserver

Call Signature

removeObserver(key, method): this;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:357

Parameters

key

keyof JSONAPIAdapter

method

ObserverMethod<JSONAPIAdapter, JSONAPIAdapter>

Returns

this

Inherited from

RESTAdapter.removeObserver

reopen()

reopen(...args): this;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/core.d.ts:81

Parameters

args

...( | Record<string, unknown> | Mixin)[]

Returns

this

Inherited from

RESTAdapter.reopen

serialize()

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

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

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>

serialized snapshot

Inherited from

RESTAdapter.serialize

set()

Call Signature

set<K, T>(key, value): T;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:208

Sets the provided key or path to the value.

javascript

record.set("key", value);

This method is generally very similar to calling object["key"] = value or object.key = value, except that it provides support for computed properties, the setUnknownProperty() method and property observers.

Computed Properties

If you try to set a value on a key that has a computed property handler defined (see the get() method for an example), then set() will call that method, passing both the value and key instead of simply changing the value itself. This is useful for those times when you need to implement a property that is composed of one or more member properties.

Unknown Properties

If you try to set a value on a key that is undefined in the target object, then the setUnknownProperty() handler will be called instead. This gives you an opportunity to implement complex "virtual" properties that are not predefined on the object. If setUnknownProperty() returns undefined, then set() will simply set the value on the object.

Property Observers

In addition to changing the property, set() will also register a property change with the object. Unless you have placed this call inside of a beginPropertyChanges() and endPropertyChanges(), any "local" observers (i.e. observer methods declared on the same object), will be called immediately. Any "remote" observers (i.e. observer methods declared on another object) will be placed in a queue and called at a later time in a coalesced manner.

Type Parameters

K

K extends keyof JSONAPIAdapter

T

T extends | undefined | null | string | number | boolean | Record<string, unknown> | unknown[] | default | string[] | Owner | (this, id, modelName, snapshot) => string | (this, modelName, snapshots) => string | (this, query, modelName) => string | (this, query, modelName) => string | (this, ids, modelName, snapshots) => string | (this, id, modelName, snapshot) => string | (this, id, modelName, snapshot) => string | (this, modelName, snapshot) => string | (this, id, modelName, snapshot) => string | (this, id, modelName, snapshot) => string | (this, modelName, id?) => string | (this, path?, parentURL?) => string | { (this, modelName, id, snapshot, requestType): string; (this, modelName, id, snapshot, requestType): string; (this, modelName, id, snapshot, requestType, query): string; (this, modelName, id, snapshot, requestType, query): string; (this, modelName, id, snapshot, requestType): string; (this, modelName, id, snapshot, requestType): string; (this, modelName, id, snapshot, requestType): string; (this, modelName, id, snapshot, requestType): string; (this, modelName, id, snapshot, requestType): string; (this, modelName, id, snapshot, requestType): string; (this, modelName, id, snapshot): string; } | (store, snapshot) => boolean | (store, snapshotRecordArray) => boolean | (store, snapshot) => boolean | (store, snapshotRecordArray) => boolean | () => string | { } | () => void | FastBoot | (store, type, id, snapshot) => Promise<AdapterPayload> | (store, type, sinceToken, snapshotRecordArray) => Promise<AdapterPayload> | (store, type, query) => Promise<AdapterPayload> | (store, type, query, adapterOptions) => Promise<AdapterPayload> | (store, type, snapshot) => Promise<AdapterPayload> | (store, schema, snapshot) => Promise<AdapterPayload> | (store, snapshots) => Snapshot<unknown>[][] | (obj) => Record<string, unknown> | (status, _headers, _payload) => boolean | (status, _headers, _payload) => boolean | { } | { } | (options) => Promise<Response> | { } | (url) => string | (store, snapshot) => string | (store, type, ids, snapshots) => Promise<AdapterPayload> | (store, schema, snapshot) => Promise<AdapterPayload> | { } | (snapshot) => QueryState | (modelName) => string | (snapshot, options) => Record<string, unknown> | (store, snapshot, url, relationship) => Promise<AdapterPayload> | (store, snapshot, url, relationship) => Promise<AdapterPayload> | (status, headers, payload, requestData) => Payload | typeof _AdapterError | { } | (options) => void | { } | (...args) => this | (_properties) => void | () => this | { <K> (key): JSONAPIAdapter[K]; (key): unknown; } | { <L> (list): { [Key in keyof JSONAPIAdapter]: JSONAPIAdapter[Key] }; <L> (...list): { [Key in keyof JSONAPIAdapter]: JSONAPIAdapter[Key] }; <L> (list): { [Key in string]: unknown }; <L> (...list): { [Key in string]: unknown }; } | { <K, T> (key, value): T; <T> (key, value): T; } | { <K, P> (hash): P; <T> (hash): T; } | (keyName) => this | { <Target> (key, target, method): this; (key, method): this; } | { <Target> (key, target, method): this; (key, method): this; } | (keyName, increment?) => number | (keyName, decrement?) => number | (keyName) => boolean | <K>(key) => unknown

Parameters

key

K

value

T

The value to set or null.

Returns

T

The passed value

Method

set

Inherited from

RESTAdapter.set

Call Signature

set<T>(key, value): T;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:209

Type Parameters

T

T

Parameters

key

string

value

T

Returns

T

Inherited from

RESTAdapter.set

setProperties()

Call Signature

setProperties<K, P>(hash): P;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:224

Sets a list of properties at once. These properties are set inside a single beginPropertyChanges and endPropertyChanges batch, so observers will be buffered.

javascript

record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });

Type Parameters

K

K extends keyof JSONAPIAdapter

P

P extends { [Key in keyof JSONAPIAdapter]: JSONAPIAdapter[Key] }

Parameters

hash

P

the hash of keys and values to set

Returns

P

The passed in hash

Method

setProperties

Inherited from

RESTAdapter.setProperties

Call Signature

setProperties<T>(hash): T;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:232

Type Parameters

T

T extends Record<string, unknown>

Parameters

hash

T

Returns

T

Inherited from

RESTAdapter.setProperties

shouldBackgroundReloadAll()

shouldBackgroundReloadAll(store, snapshotRecordArray): boolean;

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

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

RESTAdapter.shouldBackgroundReloadAll

snapshotRecordArray

SnapshotRecordArray

Returns

boolean

Since

1.13.0

Inherited from

shouldBackgroundReloadRecord()

shouldBackgroundReloadRecord(store, snapshot): boolean;

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

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

RESTAdapter.shouldBackgroundReloadRecord

snapshot

Snapshot

Returns

boolean

Since

1.13.0

Inherited from

shouldReloadAll()

shouldReloadAll(store, snapshotRecordArray): boolean;

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

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

RESTAdapter.shouldReloadAll

snapshotRecordArray

SnapshotRecordArray

Returns

boolean

Since

1.13.0

Inherited from

shouldReloadRecord()

shouldReloadRecord(store, snapshot): boolean;

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

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

RESTAdapter.shouldReloadRecord

snapshot

Snapshot

Returns

boolean

Since

1.13.0

Inherited from

sortQueryParams()

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

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

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

RESTAdapter.sortQueryParams

toggleProperty()

toggleProperty(keyName): boolean;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/observable.d.ts:401

Set the value of a boolean property to the opposite of its current value.

javascript

starship.toggleProperty('warpDriveEngaged');

Parameters

keyName

keyof JSONAPIAdapter

The name of the property to toggle

Returns

boolean

The new property value

Method

toggleProperty

Inherited from

RESTAdapter.toggleProperty

toString()

toString(): string;

Defined in: node_modules/.pnpm/ember-source@6.3.0/node_modules/ember-source/types/stable/@ember/object/core.d.ts:347

Returns a string representation which attempts to provide more information than Javascript's toString typically does, in a generic way for all Ember objects.

javascript

import EmberObject from '@ember/object';

const Person = EmberObject.extend();
person = Person.create();
person.toString(); //=> "<Person:ember1024>"

If the object's class is not defined on an Ember namespace, it will indicate it is a subclass of the registered superclass:

javascript

const Student = Person.extend();
let student = Student.create();
student.toString(); //=> "<(subclass of Person):ember1025>"

If the method toStringExtension is defined, its return value will be included in the output.

javascript

const Teacher = Person.extend({
  toStringExtension() {
    return this.get('fullName');
  }
});
teacher = Teacher.create();
teacher.toString(); //=> "<Teacher:ember1026:Tom Dale>"

Returns

string

string representation

Method

toString

Inherited from

RESTAdapter.toString

updateRecord()

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

Defined in: warp-drive-packages/legacy/src/adapter/json-api.ts:256

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