Convert an hash of errors into an array with errors in JSON-API format.
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n | \n import DS from 'ember-data';\n\nconst { errorsHashToArray } = DS;\n\nlet errors = {\n base: 'Invalid attributes on saving this record',\n name: 'Must be present',\n age: ['Must be present', 'Must be a number']\n};\nlet errorsArray = errorsHashToArray(errors);\n// [\n// {\n// title: "Invalid Document",\n// detail: "Invalid attributes on saving this record",\n// source: { pointer: "/data" }\n// },\n// {\n// title: "Invalid Attribute",\n// detail: "Must be present",\n// source: { pointer: "/data/attributes/name" }\n// },\n// {\n// title: "Invalid Attribute",\n// detail: "Must be present",\n// source: { pointer: "/data/attributes/age" }\n// },\n// {\n// title: "Invalid Attribute",\n// detail: "Must be a number",\n// source: { pointer: "/data/attributes/age" }\n// }\n// ] | \n
Convert an array of errors in JSON-API format into an object.
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n | \n import DS from 'ember-data';\n\nconst { errorsArrayToHash } = DS;\n\nlet errorsArray = [\n {\n title: 'Invalid Attribute',\n detail: 'Must be present',\n source: { pointer: '/data/attributes/name' }\n },\n {\n title: 'Invalid Attribute',\n detail: 'Must be present',\n source: { pointer: '/data/attributes/age' }\n },\n {\n title: 'Invalid Attribute',\n detail: 'Must be a number',\n source: { pointer: '/data/attributes/age' }\n }\n];\n\nlet errors = errorsArrayToHash(errorsArray);\n// {\n// "name": ["Must be present"],\n// "age": ["Must be present", "must be a number"]\n// } | \n
attr defines an attribute on a Model.\nBy default, attributes are passed through as-is, however you can specify an\noptional type to have the value automatically transformed.\nEmber Data ships with four basic transform types: string, number,\nboolean and date. You can define your own transforms by subclassing\nTransform.
Note that you cannot use attr to define an attribute of id.
attr takes an optional hash as a second parameter, currently\nsupported options are:
defaultValue: Pass a string or a function to be called to set the attribute\nto a default value if and only if the key is absent from the payload response.Example
\n| app/models/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr } from '-data/model';\n\nexport default class UserModel extends Model {\n ('string') username;\n ('string') email;\n ('boolean', { defaultValue: false }) verified;\n} | \n
Default value can also be a function. This is useful it you want to return\na new object for each attribute.
\n| app/models/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import Model, { attr } from '-data/model';\n\nexport default class UserModel extends Model {\n ('string') username;\n ('string') email;\n\n ({\n defaultValue() {\n return {};\n }\n })\n settings;\n} | \n
The options hash is passed as second argument to a transforms'\nserialize and deserialize method. This allows to configure a\ntransformation and adapt the corresponding value, based on the config:
| app/models/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr } from '-data/model';\n\nexport default class PostModel extends Model {\n ('text', {\n uppercase: true\n })\n text;\n} | \n
| app/transforms/text.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Transform from '@ember-data/serializer/transform';\n\nexport default Transform.extend({\n serialize(value, options) {\n if (options.uppercase) {\n return value.toUpperCase();\n }\n\n return value;\n },\n\n deserialize(value) {\n return value;\n }\n}) | \n
belongsTo is used to define One-To-One and One-To-Many\nrelationships on a Model.
belongsTo takes an optional hash as a second parameter, currently\nsupported options are:
async: A boolean value used to explicitly declare this to be an async relationship. The default is true.inverse: A string used to identify the inverse property on a\nrelated model in a One-To-Many relationship. See Explicit Inversespolymorphic A boolean value to mark the relationship as polymorphicTo declare a one-to-one relationship between two models, use\nbelongsTo:
| app/models/user.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class UserModel extends Model {\n ('profile') profile;\n} | \n
| app/models/profile.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class ProfileModel extends Model {\n ('user') user;\n} | \n
To declare a one-to-many relationship between two models, use\nbelongsTo in combination with hasMany, like this:
| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ('comment') comments;\n} | \n
| app/models/comment.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n ('post') post;\n} | \n
You can avoid passing a string as the first parameter. In that case Ember Data\nwill infer the type from the key name.
\n| app/models/comment.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n post;\n} | \n
will lookup for a Post type.
\nEmber Data resolves sync relationships with the related resources\navailable in its local store, hence it is expected these resources\nto be loaded before or along-side the primary resource.
\n| app/models/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n ('post', {\n async: false\n })\n post;\n} | \n
In contrast to async relationship, accessing a sync relationship\nwill always return the record (Model instance) for the existing\nlocal resource, or null. But it will error on access when\na related resource is known to exist and it has not been loaded.
\n1\n | \n let post = comment.get('post'); | \n
hasMany is used to define One-To-Many and Many-To-Many\nrelationships on a Model.
hasMany takes an optional hash as a second parameter, currently\nsupported options are:
async: A boolean value used to explicitly declare this to be an async relationship. The default is true.inverse: A string used to identify the inverse property on a related model.polymorphic A boolean value to mark the relationship as polymorphicTo declare a one-to-many relationship between two models, use\nbelongsTo in combination with hasMany, like this:
| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ('comment') comments;\n} | \n
| app/models/comment.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n ('post') post;\n} | \n
To declare a many-to-many relationship between two models, use\nhasMany:
| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ('tag') tags;\n} | \n
| app/models/tag.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class TagModel extends Model {\n ('post') posts;\n} | \n
You can avoid passing a string as the first parameter. In that case Ember Data\nwill infer the type from the singularized key name.
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n tags;\n} | \n
will lookup for a Tag type.
\nEmber Data will do its best to discover which relationships map to\none another. In the one-to-many code above, for example, Ember Data\ncan figure out that changing the comments relationship should update\nthe post relationship on the inverse because post is the only\nrelationship to that model.
However, sometimes you may have multiple belongsTo/hasMany for the\nsame type. You can specify which property on the related model is\nthe inverse using hasMany's inverse option:
| app/models/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n ('post') onePost;\n ('post') twoPost\n ('post') redPost;\n ('post') bluePost;\n} | \n
| app/models/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import Model from '-data/model';\nimport { hasMany } from '-decorators/data';\n\nexport default class PostModel extends Model {\n ('comment', {\n inverse: 'redPost'\n })\n comments;\n} | \n
You can also specify an inverse on a belongsTo, which works how\nyou'd expect.
Ember Data resolves sync relationships with the related resources\navailable in its local store, hence it is expected these resources\nto be loaded before or along-side the primary resource.
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ('comment', {\n async: false\n })\n comments;\n} | \n
In contrast to async relationship, accessing a sync relationship\nwill always return a ManyArray instance\ncontaining the existing local resources. But it will error on access\nwhen any of the known related resources have not been loaded.
\n1\n2\n3\n | \n post.get('comments').forEach((comment) => {\n\n}); | \n
If you are using links with sync relationships, you have to use\nref.reload to fetch the resources.
Retrieves the unique referentially-stable RecordIdentifier assigned to the given\nrecord instance.
\n", + "itemtype": "method", + "name": "recordIdentifierFor", + "access": "public", + "tagname": "", + "static": 1, + "params": [ + { + "name": "record", + "description": "a record instance previously obstained from the store.", + "type": "Object" + } + ], + "return": { + "description": "" + }, + "class": "@ember-data/store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/normalize-model-name.ts", + "line": 10, + "description": "This method normalizes a modelName into the format Ember Data uses\ninternally by dasherizing it.
\n", + "itemtype": "method", + "name": "normalizeModelName", + "static": 1, + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelName", + "description": "", + "type": "String" + } + ], + "return": { + "description": "normalizedModelName", + "type": "String" + }, + "class": "@ember-data/store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/ts-interfaces/identifier.ts", + "line": 111, + "description": "Configures how unique identifier lid strings are generated by @ember-data/store.
\nThis configuration MUST occur prior to the store instance being created.
\nTakes a method which can expect to receive various data as its first argument\nand the name of a bucket as its second argument. Currently the second\nargument will always be record data should conform to a json-api\nResource interface, but will be the normalized json data for a single\nresource that has been given to the store.
The method must return a unique (to at-least the given bucket) string identifier\nfor the given data as a string to be used as the lid of an Identifier token.
This method will only be called by either getOrCreateRecordIdentifier or\ncreateIdentifierForNewRecord when an identifier for the supplied data\nis not already known via lid or type + id combo and one needs to be\ngenerated or retrieved from a proprietary cache.
data will be the same data argument provided to getOrCreateRecordIdentifier\nand in the createIdentifierForNewRecord case will be an object with\nonly type as a key.
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import { setIdentifierGenerationMethod } form '@ember-data/store';\n\nexport function initialize(applicationInstance) {\n // note how `count` here is now scoped to the application instance\n // for our generation method by being inside the closure provided\n // by the initialize function\n let count = 0;\n\n setIdentifierGenerationMethod((resource, bucket) => {\n return resource.lid || `my-key-${count++}`;\n });\n}\n\nexport default {\n name: 'configure-ember-data-identifiers',\n initialize\n}; | \n
Configure a callback for when the identifier cache encounters new resource\ndata for an existing resource.
\nThis configuration MUST occur prior to the store instance being created.
\n1\n | \n import { setIdentifierUpdateMethod } from '@ember-data/store'; | \n
Takes a method which can expect to receive an existing Identifier alongside\nsome new data to consider as a second argument. This is an opportunity\nfor secondary lookup tables and caches associated with the identifier\nto be amended.
This method is called everytime updateRecordIdentifier is called and\n with the same arguments. It provides the opportunity to update secondary\n lookup tables for existing identifiers.
It will always be called after an identifier created with createIdentifierForNewRecord\n has been committed, or after an update to the record a RecordIdentifier\n is assigned to has been committed. Committed here meaning that the server\n has acknowledged the update (for instance after a call to .save())
If id has not previously existed, it will be assigned to the Identifier\n prior to this UpdateMethod being called; however, calls to the parent method\n updateRecordIdentifier that attempt to change the id or calling update\n without providing an id when one is missing will throw an error.
Configure a callback for when the identifier cache is going to release an identifier.
\nThis configuration MUST occur prior to the store instance being created.
\n1\n | \n import { setIdentifierForgetMethod } from '@ember-data/store'; | \n
Takes method which can expect to receive an existing Identifier that should be eliminated\nfrom any secondary lookup tables or caches that the user has populated for it.
Configure a callback for when the identifier cache is being torn down.
\nThis configuration MUST occur prior to the store instance being created.
\n1\n | \n import { setIdentifierResetMethod } from '@ember-data/store'; | \n
Takes a method which can expect to be called when the parent application is destroyed.
\nIf you have properly used a WeakMap to encapsulate the state of your customization\nto the application instance, you may not need to implement the resetMethod.
An adapter is an object that receives requests from a store and\ntranslates them into the appropriate action to take against your\npersistence layer. The persistence layer is usually an HTTP API but\nmay be anything, such as the browser's local storage. Typically the\nadapter is not invoked directly instead its functionality is accessed\nthrough the store.
Create a new subclass of Adapter in the app/adapters folder:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import Adapter from '@ember-data/adapter';\n\nexport default Adapter.extend({\n // ...your code here\n}); | \n
Model-specific adapters can be created by putting your adapter\nclass in an app/adapters/ + model-name + .js file of the application.
| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n | \n import Adapter from '@ember-data/adapter';\n\nexport default Adapter.extend({\n // ...Post-specific adapter code goes here\n}); | \n
Adapter is an abstract base class that you should override in your\napplication to customize it for your backend. The minimum set of methods\nthat you should implement is:
findRecord()createRecord()updateRecord()deleteRecord()findAll()query()To improve the network performance of your application, you can optimize\nyour adapter by overriding these lower-level methods:
\nfindMany()For an example of the implementation, see RESTAdapter, the\nincluded REST adapter.
The findRecord() method is invoked when the store is asked for a record that\nhas not previously been loaded. In response to findRecord() being called, you\nshould query your persistence layer for a record with the given ID. The findRecord\nmethod should return a promise that will resolve to a JavaScript object that will be\nnormalized by the serializer.
Here is an example of the findRecord implementation:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findRecord(store, type, id, snapshot) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}/${id}`).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
The findAll() method is used to retrieve all records for a given type.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findAll(store, type) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
This method is called when you call query on the store.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n query(store, type, query) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`, query).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
The queryRecord() method is invoked when the store is asked for a single\nrecord through a query object.
In response to queryRecord() being called, you should always fetch fresh\ndata. Once found, you can asynchronously call the store's push() method\nto push the record into the store.
Here is an example queryRecord implementation:
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter, { BuildURLMixin } from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter.extend(BuildURLMixin) {\n queryRecord(store, type, query) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`, query).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
If the globally unique IDs for your records should be generated on the client,\nimplement the generateIdForRecord() method. This method will be invoked\neach time you create a new record, and the value returned from it will be\nassigned to the record's primaryKey.
Most traditional REST-like HTTP APIs will not use this method. Instead, the ID\nof the record will be set by the server, and your adapter will update the store\nwith the new ID when it calls didCreateRecord(). Only implement this method if\nyou intend to generate record IDs on the client-side.
The generateIdForRecord() method will be invoked with the requesting store as\nthe first parameter and the newly created record as the second parameter:
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Adapter from '-data/adapter';\nimport { v4 } from 'uuid';\n\nexport default class ApplicationAdapter extends Adapter {\n generateIdForRecord(store, type, inputProperties) {\n return v4();\n }\n} | \n
Proxies to the serializer's serialize method.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import Adapter from '-data/adapter';\n\nexport default class ApplicationAdapter extends Adapter {\n createRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let url = `/${type.modelName}`;\n\n // ...\n }\n} | \n
Implement this method in a subclass to handle the creation of\nnew records.
\nSerializes the record and sends it to the server.
\nExample
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n createRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n\n return new RSVP.Promise(function (resolve, reject) {\n $.ajax({\n type: 'POST',\n url: `/${type.modelName}`,\n dataType: 'json',\n data: data\n }).then(function (data) {\n run(null, resolve, data);\n }, function (jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Implement this method in a subclass to handle the updating of\na record.
\nSerializes the record update and sends it to the server.
\nThe updateRecord method is expected to return a promise that will\nresolve with the serialized record. This allows the backend to\ninform the Ember Data store the current state of this record after\nthe update. If it is not possible to return a serialized record\nthe updateRecord promise can also resolve with undefined and the\nEmber Data store will assume all of the updates were successfully\napplied on the backend.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n updateRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let id = snapshot.id;\n\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'PUT',\n url: `/${type.modelName}/${id}`,\n dataType: 'json',\n data: data\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Implement this method in a subclass to handle the deletion of\na record.
\nSends a delete request for the record to the server.
\nExample
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n deleteRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let id = snapshot.id;\n\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'DELETE',\n url: `/${type.modelName}/${id}`,\n dataType: 'json',\n data: data\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
The store will call findMany instead of multiple findRecord\nrequests to find multiple records at once if coalesceFindRequests\nis true.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findMany(store, type, ids, snapshots) {\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'GET',\n url: `/${type.modelName}/`,\n dataType: 'json',\n data: { filter: { id: ids.join(',') } }\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Organize records into groups, each of which is to be passed to separate\ncalls to findMany.
For example, if your API has nested URLs that depend on the parent, you will\nwant to group records by their parent.
\nThe default implementation returns the records as a single group.
\n", + "itemtype": "method", + "name": "groupRecordsForFindMany", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "snapshots", + "description": "", + "type": "Array" + } + ], + "return": { + "description": "an array of arrays of records, each of which is to be\n loaded separately by `findMany`.", + "type": "Array" + }, + "class": "Adapter", + "module": "@ember-data/adapter" + }, + { + "file": "../adapter/addon/index.ts", + "line": 703, + "description": "This method is used by the store to determine if the store should\nreload a record from the adapter when a record is requested by\nstore.findRecord.
If this method returns true, the store will re-fetch a record from\nthe adapter. If this method returns false, the store will resolve\nimmediately using the cached record.
For example, if you are building an events ticketing system, in which users\ncan only reserve tickets for 20 minutes at a time, and want to ensure that\nin each route you have data that is no more than 20 minutes old you could\nwrite:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n shouldReloadRecord(store, ticketSnapshot) {\n let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt');\n let timeDiff = moment().diff(lastAccessedAt, 'minutes');\n\n if (timeDiff > 20) {\n return true;\n } else {\n return false;\n }\n} | \n
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\ncase the cached version is more than 20 minutes old, findRecord will not\nresolve until you fetched the latest version.
By default this hook returns false, as most UIs should not block user\ninteractions while waiting on data update.
Note that, with default settings, shouldBackgroundReloadRecord will always\nre-fetch the records in the background even if shouldReloadRecord returns\nfalse. You can override shouldBackgroundReloadRecord if this does not\nsuit your use case.
This method is used by the store to determine if the store should\nreload all records from the adapter when records are requested by\nstore.findAll.
If this method returns true, the store will re-fetch all records from\nthe adapter. If this method returns false, the store will resolve\nimmediately using the cached records.
For example, if you are building an events ticketing system, in which users\ncan only reserve tickets for 20 minutes at a time, and want to ensure that\nin each route you have data that is no more than 20 minutes old you could\nwrite:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n shouldReloadAll(store, snapshotArray) {\n let snapshots = snapshotArray.snapshots();\n\n return snapshots.any((ticketSnapshot) => {\n let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt');\n let timeDiff = moment().diff(lastAccessedAt, 'minutes');\n\n if (timeDiff > 20) {\n return true;\n } else {\n return false;\n }\n });\n} | \n
This method would ensure that whenever you do store.findAll('ticket') you\nwill always get a list of tickets that are no more than 20 minutes old. In\ncase a cached version is more than 20 minutes old, findAll will not\nresolve until you fetched the latest versions.
By default, this method returns true if the passed snapshotRecordArray\nis empty (meaning that there are no records locally available yet),\notherwise, it returns false.
Note that, with default settings, shouldBackgroundReloadAll will always\nre-fetch all the records in the background even if shouldReloadAll returns\nfalse. You can override shouldBackgroundReloadAll if this does not suit\nyour use case.
This method is used by the store to determine if the store should\nreload a record after the store.findRecord method resolves a\ncached record.
This method is only checked by the store when the store is\nreturning a cached record.
\nIf this method returns true the store will re-fetch a record from\nthe adapter.
For example, if you do not want to fetch complex data over a mobile\nconnection, or if the network is down, you can implement\nshouldBackgroundReloadRecord as follows:
1\n2\n3\n4\n5\n | \n shouldBackgroundReloadRecord(store, snapshot) {\n let { downlink, effectiveType } = navigator.connection;\n\n return downlink > 0 && effectiveType === '4g';\n} | \n
By default, this hook returns true so the data for the record is updated\nin the background.
This method is used by the store to determine if the store should\nreload a record array after the store.findAll method resolves\nwith a cached record array.
This method is only checked by the store when the store is\nreturning a cached record array.
\nIf this method returns true the store will re-fetch all records\nfrom the adapter.
For example, if you do not want to fetch complex data over a mobile\nconnection, or if the network is down, you can implement\nshouldBackgroundReloadAll as follows:
1\n2\n3\n4\n5\n | \n shouldBackgroundReloadAll(store, snapshotArray) {\n let { downlink, effectiveType } = navigator.connection;\n\n return downlink > 0 && effectiveType === '4g';\n} | \n
By default this method returns true, indicating that a background reload\nshould always be triggered.
If you would like your adapter to use a custom serializer you can\nset the defaultSerializer property to be the name of the custom\nserializer.
Note the defaultSerializer serializer has a lower priority than\na model specific serializer (i.e. PostSerializer) or the\napplication serializer.
| app/adapters/django.js | \n|
1\n2\n3\n4\n5\n | \n import Adapter from '@ember-data/adapter';\n\nexport default Adapter.extend({\n defaultSerializer: 'django'\n}); | \n
By default the store will try to coalesce all fetchRecord calls within the same runloop\ninto as few requests as possible by calling groupRecordsForFindMany and passing it into a findMany call.\nYou can opt out of this behaviour by either not implementing the findMany hook or by setting\ncoalesceFindRequests to false.
A AdapterError is used by an adapter to signal that an error occurred\nduring a request to an external API. It indicates a generic error, and\nsubclasses are used to indicate specific error states. The following\nsubclasses are provided:
InvalidErrorTimeoutErrorAbortErrorUnauthorizedErrorForbiddenErrorNotFoundErrorConflictErrorServerErrorTo create a custom error to signal a specific error state in communicating\nwith an external API, extend the AdapterError. For example, if the\nexternal API exclusively used HTTP 503 Service Unavailable to indicate\nit was closed for maintenance:
| error.js | \n|
1\n2\n3\n | \n import AdapterError from '@ember-data/adapter/error';\n\nexport default AdapterError.extend({ message: "Down for maintenance." }); | \n
This error would then be returned by an adapter's handleResponse method:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\nimport MaintenanceError from './maintenance-error';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n handleResponse(status) {\n if (503 === status) {\n return new MaintenanceError();\n }\n\n return this._super(...arguments);\n }\n} | \n
And can then be detected in an application and used to send the user to an\nunder-maintenance route:
| app/routes/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Route from '/routing/route';\nimport MaintenanceError from '../adapters/maintenance-error';\n\nexport default class ApplicationRoute extends Route {\n actions: {\n error(error, transition) {\n if (error instanceof MaintenanceError) {\n this.transitionTo('under-maintenance');\n return;\n }\n\n // ...other error handling logic\n }\n }\n} | \n
@mainName @ember-data/adapter/error\n @tag main
\n", + "_main": true, + "access": "public", + "tagname": "", + "methods": [], + "events": [], + "properties": [] + }, + "relationships": { + "parent-class": { + "data": null + }, + "descendants": { + "data": [ + { + "type": "class", + "id": "ember-data-3.28.13-InvalidError" + }, + { + "type": "class", + "id": "ember-data-3.28.13-TimeoutError" + }, + { + "type": "class", + "id": "ember-data-3.28.13-AbortError" + }, + { + "type": "class", + "id": "ember-data-3.28.13-UnauthorizedError" + }, + { + "type": "class", + "id": "ember-data-3.28.13-ForbiddenError" + }, + { + "type": "class", + "id": "ember-data-3.28.13-NotFoundError" + }, + { + "type": "class", + "id": "ember-data-3.28.13-ConflictError" + }, + { + "type": "class", + "id": "ember-data-3.28.13-ServerError" + } + ] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/adapter/error", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-AdapterPopulatedRecordArray-306cc2f9c0.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-AdapterPopulatedRecordArray-306cc2f9c0.json new file mode 100644 index 000000000..085638885 --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-AdapterPopulatedRecordArray-306cc2f9c0.json @@ -0,0 +1,209 @@ +{ + "data": { + "id": "ember-data-3.28.13-AdapterPopulatedRecordArray", + "type": "class", + "attributes": { + "name": "AdapterPopulatedRecordArray", + "shortname": "AdapterPopulatedRecordArray", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/store", + "namespace": "", + "file": "../store/addon/-private/system/record-arrays/adapter-populated-record-array.js", + "line": 15, + "description": "Represents an ordered list of records whose order and membership is\ndetermined by the adapter. For example, a query sent to the adapter\nmay trigger a search on the server, whose results would be loaded\ninto an instance of the AdapterPopulatedRecordArray.
This class should not be imported and instantiated by consuming applications.
\nIf you want to update the array and get the latest records from the\nadapter, you can invoke update():
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n | \n // GET /users?isAdmin=true\nstore.query('user', { isAdmin: true }).then(function(admins) {\n\n admins.then(function() {\n console.log(admins.get("length")); // 42\n });\n\n // somewhere later in the app code, when new admins have been created\n // in the meantime\n //\n // GET /users?isAdmin=true\n admins.update().then(function() {\n admins.get('isUpdating'); // false\n console.log(admins.get("length")); // 123\n });\n\n admins.get('isUpdating'); // true\n} | \n
Retrieves an object from the content by index.
\n", + "itemtype": "method", + "name": "objectAtContent", + "access": "private", + "tagname": "", + "params": [ + { + "name": "index", + "description": "", + "type": "Number" + } + ], + "return": { + "description": "record", + "type": "Model" + }, + "class": "AdapterPopulatedRecordArray", + "module": "@ember-data/store", + "inherited": true, + "inheritedFrom": "RecordArray" + }, + { + "file": "../store/addon/-private/system/record-arrays/record-array.js", + "line": 131, + "description": "Used to get the latest version of all of the records in this array\nfrom the adapter.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n | \n let people = store.peekAll('person');\npeople.get('isUpdating'); // false\n\npeople.update().then(function() {\n people.get('isUpdating'); // false\n});\n\npeople.get('isUpdating'); // true | \n
Saves all of the records in the RecordArray.
Example
\n1\n2\n3\n4\n5\n | \n let messages = store.peekAll('message');\nmessages.forEach(function(message) {\n message.set('hasBeenSeen', true);\n});\nmessages.save(); | \n
The array of client ids backing the record array. When a\nrecord is requested from the record array, the record\nfor the client id at the same index is materialized, if\nnecessary, by the store.
\n", + "itemtype": "property", + "name": "content", + "access": "private", + "tagname": "", + "type": "Ember.Array", + "class": "AdapterPopulatedRecordArray", + "module": "@ember-data/store", + "inherited": true, + "inheritedFrom": "RecordArray" + }, + { + "file": "../store/addon/-private/system/record-arrays/record-array.js", + "line": 54, + "description": "The flag to signal a RecordArray is finished loading data.
Example
\n1\n2\n | \n let people = store.peekAll('person');\npeople.get('isLoaded'); // true | \n
The flag to signal a RecordArray is currently loading data.
Example
\n1\n2\n3\n4\n | \n let people = store.peekAll('person');\npeople.get('isUpdating'); // false\npeople.update();\npeople.get('isUpdating'); // true | \n
The store that created this record array.
\n", + "itemtype": "property", + "name": "store", + "access": "private", + "tagname": "", + "type": "Store", + "class": "AdapterPopulatedRecordArray", + "module": "@ember-data/store", + "inherited": true, + "inheritedFrom": "RecordArray" + }, + { + "file": "../store/addon/-private/system/record-arrays/record-array.js", + "line": 104, + "description": "The modelClass represented by this record array.
\n", + "itemtype": "property", + "name": "type", + "access": "public", + "tagname": "", + "type": "{subclass of Model}", + "class": "AdapterPopulatedRecordArray", + "module": "@ember-data/store", + "inherited": true, + "inheritedFrom": "RecordArray" + } + ] + }, + "relationships": { + "parent-class": { + "data": { + "id": "ember-data-3.28.13-RecordArray", + "type": "class" + } + }, + "descendants": { + "data": [] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/store", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-BelongsToReference-c27337a2f0.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-BelongsToReference-c27337a2f0.json new file mode 100644 index 000000000..56fb79ab4 --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-BelongsToReference-c27337a2f0.json @@ -0,0 +1,197 @@ +{ + "data": { + "id": "ember-data-3.28.13-BelongsToReference", + "type": "class", + "attributes": { + "name": "BelongsToReference", + "shortname": "BelongsToReference", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/store", + "namespace": "", + "file": "../store/addon/-private/system/references/belongs-to.ts", + "line": 26, + "description": "A BelongsToReference is a low-level API that allows users and\naddon authors to perform meta-operations on a belongs-to\nrelationship.
The id of the record that this reference refers to. Together, the\ntype() and id() methods form a composite key for the identity\nmap. This can be used to access the id of an async relationship\nwithout triggering a fetch that would normally happen if you\nattempted to use record.get('relationship.id').
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n | \n // models/blog.js\nimport Model, { belongsTo } from '-data/model';\n\nexport default class BlogModel extends Model {\n ({ async: true }) user;\n}\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n data: { type: 'user', id: 1 }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\n// get the identifier of the reference\nif (userRef.remoteType() === "id") {\n let id = userRef.id();\n } | \n
push can be used to update the data in the relationship and Ember\nData will treat the new data as the canonical value of this\nrelationship on the backend.
Example
\n| app/models/blog.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n | \n import Model, { belongsTo } from '@ember-data/model';\n\nexport default class BlogModel extends Model {\n @belongsTo({ async: true }) user;\n }\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n data: { type: 'user', id: 1 }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\n// provide data for reference\nuserRef.push({\n data: {\n type: 'user',\n id: 1,\n attributes: {\n username: "@user"\n }\n }\n }).then(function(user) {\n userRef.value() === user;\n }); | \n
value() synchronously returns the current value of the belongs-to\nrelationship. Unlike record.get('relationshipName'), calling\nvalue() on a reference does not trigger a fetch if the async\nrelationship is not yet loaded. If the relationship is not loaded\nit will always return null.
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n34\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\n\nexport default class BlogModel extends Model {\n @belongsTo({ async: true }) user;\n}\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n data: { type: 'user', id: 1 }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\nuserRef.value(); // null\n\n// provide data for reference\nuserRef.push({\n data: {\n type: 'user',\n id: 1,\n attributes: {\n username: "@user"\n }\n }\n }).then(function(user) {\n userRef.value(); // user\n }); | \n
Loads a record in a belongs-to relationship if it is not already\nloaded. If the relationship is already loaded this method does not\ntrigger a new load.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n // models/blog.js\nimport Model, { belongsTo } from '-data/model';\n\nexport default class BlogModel extends Model {\n ({ async: true }) user;\n}\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n data: { type: 'user', id: 1 }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\nuserRef.value(); // null\n\nuserRef.load().then(function(user) {\n userRef.value() === user\n }); | \n
You may also pass in an options object whose properties will be\nfed forward. This enables you to pass adapterOptions into the\nrequest given to the adapter via the reference.
Example
\n1\n2\n3\n | \n userRef.load({ adapterOptions: { isPrivate: true } }).then(function(user) {\n userRef.value() === user;\n}); | \n
| app/adapters/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Adapter from '-data/adapter';\n\nexport default class UserAdapter extends Adapter {\n findRecord(store, type, id, snapshot) {\n // In the adapter you will have access to adapterOptions.\n let adapterOptions = snapshot.adapterOptions;\n }\n}); | \n
Triggers a reload of the value in this relationship. If the\nremoteType is "link" Ember Data will use the relationship link to\nreload the relationship. Otherwise it will reload the record by its\nid.
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n | \n // models/blog.js\nimport Model, { belongsTo } from '-data/model';\n\nexport default class BlogModel extends Model {\n ({ async: true }) user;\n}\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n data: { type: 'user', id: 1 }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\nuserRef.reload().then(function(user) {\n userRef.value() === user\n }); | \n
You may also pass in an options object whose properties will be\nfed forward. This enables you to pass adapterOptions into the\nrequest given to the adapter via the reference. A full example\ncan be found in the load method.
Example
\n1\n | \n userRef.reload({ adapterOptions: { isPrivate: true } }) | \n
This returns a string that represents how the reference will be\nlooked up when it is loaded. If the relationship has a link it will\nuse the "link" otherwise it defaults to "id".
\nExample
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '@ember-data/model';\n\nexport default Model.extend({\n comments: hasMany({ async: true })\n}); | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\n// get the identifier of the reference\nif (commentsRef.remoteType() === "ids") {\n let ids = commentsRef.ids();\n} else if (commentsRef.remoteType() === "link") {\n let link = commentsRef.link();\n} | \n
The link Ember Data will use to fetch or reload this belongs-to\nrelationship. By default it uses only the "related" resource linkage.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\nexport default Model.extend({\n user: belongsTo({ async: true })\n });\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n links: {\n related: '/articles/1/author'\n }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\n// get the identifier of the reference\nif (userRef.remoteType() === "link") {\n let link = userRef.link();\n } | \n
The meta data for the belongs-to relationship.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\nexport default Model.extend({\n user: belongsTo({ async: true })\n });\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n links: {\n related: {\n href: '/articles/1/author'\n },\n meta: {\n lastUpdated: 1458014400000\n }\n }\n }\n }\n }\n });\n\nlet userRef = blog.belongsTo('user');\n\nuserRef.meta() // { lastUpdated: 1458014400000 } | \n
The BooleanTransform class is used to serialize and deserialize\nboolean attributes on Ember Data record objects. This transform is\nused when boolean is passed as the type parameter to the\nattr function.
Usage
\n| app/models/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr } from '-data/model';\n\nexport default class UserModel extends Model {\n ('boolean') isAdmin;\n ('string') name;\n ('string') email;\n} | \n
By default, the boolean transform only allows for values of true or\nfalse. You can opt into allowing null values for\nboolean attributes via attr('boolean', { allowNull: true })
| app/models/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr } from '-data/model';\n\nexport default class UserModel extends Model {\n ('string') email;\n ('string') username;\n ('boolean', { allowNull: true }) wantsWeeklyEmail;\n} | \n
When given a deserialized value from a record attribute this\nmethod must return the serialized value.
\nExample
\n1\n2\n3\n4\n5\n | \n import { isEmpty } from '@ember/utils';\n\nserialize(deserialized, options) {\n return isEmpty(deserialized) ? null : Number(deserialized);\n} | \n
When given a serialized value from a JSON object this method must\nreturn the deserialized value for the record attribute.
\nExample
\n1\n2\n3\n | \n deserialize(serialized, options) {\n return empty(serialized) ? null : Number(serialized);\n} | \n
To use URL building, include the mixin when extending an adapter, and call buildURL where needed.\nThe default behaviour is designed for RESTAdapter.
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Adapter, { BuildURLMixin } from '-data/adapter';\n\nexport default class ApplicationAdapter extends Adapter.extend(BuildURLMixin) {\n findRecord(store, type, id, snapshot) {\n var url = this.buildURL(type.modelName, id, snapshot, 'findRecord');\n return this.ajax(url, 'GET');\n }\n} | \n
The host and namespace attributes will be used if defined, and are optional.
Builds a URL for a given type and optional ID.
\nBy default, it pluralizes the type's name (for example, 'post'\nbecomes 'posts' and 'person' becomes 'people'). To override the\npluralization see pathForType.
\nIf an ID is specified, it adds the ID to the path generated\nfor the type, separated by a /.
When called by RESTAdapter.findMany() the id and snapshot parameters\nwill be arrays of ids and snapshots.
Builds a URL for a store.findRecord(type, id) call.
Example:
\n| app/adapters/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindRecord(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id, snapshot);\n return `${baseUrl}/users/${snapshot.adapterOptions.user_id}/playlists/${id}`;\n }\n} | \n
Builds a URL for a store.findAll(type) call.
Example:
\n| app/adapters/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindAll(modelName, snapshot) {\n let baseUrl = this.buildURL(modelName);\n return `${baseUrl}/data/comments.json`;\n }\n} | \n
Builds a URL for a store.query(type, query) call.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n host = 'https://api.github.com';\n urlForQuery (query, modelName) {\n switch(modelName) {\n case 'repo':\n return `https://api.github.com/orgs/${query.orgId}/repos`;\n default:\n return super.urlForQuery(...arguments);\n }\n }\n} | \n
Builds a URL for a store.queryRecord(type, query) call.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForQueryRecord({ slug }, modelName) {\n let baseUrl = this.buildURL();\n return `${baseUrl}/${encodeURIComponent(slug)}`;\n }\n} | \n
Builds a URL for coalescing multiple store.findRecord(type, id)\nrecords into 1 request when the adapter's coalesceFindRequests\nproperty is true.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForFindMany(ids, modelName) {\n let baseUrl = this.buildURL();\n return `${baseUrl}/coalesce`;\n }\n} | \n
Builds a URL for fetching an async hasMany relationship when a URL\nis not provided by the server.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindHasMany(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id);\n return `${baseUrl}/relationships`;\n }\n} | \n
Builds a URL for fetching an async belongsTo relationship when a url\nis not provided by the server.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindBelongsTo(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id);\n return `${baseUrl}/relationships`;\n }\n} | \n
Builds a URL for a record.save() call when the record was created\nlocally using store.createRecord().
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForCreateRecord(modelName, snapshot) {\n return super.urlForCreateRecord(...arguments) + '/new';\n }\n} | \n
Builds a URL for a record.save() call when the record has been updated locally.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForUpdateRecord(id, modelName, snapshot) {\n return `/${id}/feed?access_token=${snapshot.adapterOptions.token}`;\n }\n} | \n
Builds a URL for a record.save() call when the record has been deleted locally.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForDeleteRecord(id, modelName, snapshot) {\n return super.urlForDeleteRecord(...arguments) + '/destroy';\n }\n} | \n
Determines the pathname for a given type.
\nBy default, it pluralizes the type's name (for example,\n'post' becomes 'posts' and 'person' becomes 'people').
\nFor example, if you have an object LineItem with an\nendpoint of /line_items/.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { decamelize } from '/string';\nimport { pluralize } from 'ember-inflector';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n pathForType(modelName) {\n var decamelized = decamelize(modelName);\n return pluralize(decamelized);\n }\n} | \n
The DateTransform class is used to serialize and deserialize\ndate attributes on Ember Data record objects. This transform is used\nwhen date is passed as the type parameter to the\nattr function. It uses the ISO 8601\nstandard.
| app/models/score.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class ScoreModel extends Model {\n ('number') value;\n ('player') player;\n ('date') date;\n } | \n
When given a deserialized value from a record attribute this\nmethod must return the serialized value.
\nExample
\n1\n2\n3\n4\n5\n | \n import { isEmpty } from '@ember/utils';\n\nserialize(deserialized, options) {\n return isEmpty(deserialized) ? null : Number(deserialized);\n} | \n
When given a serialized value from a JSON object this method must\nreturn the deserialized value for the record attribute.
\nExample
\n1\n2\n3\n | \n deserialize(serialized, options) {\n return empty(serialized) ? null : Number(serialized);\n} | \n
EmbeddedRecordsMixin supports serializing embedded records.
To set up embedded records, include the mixin when extending a serializer,\nthen define and configure embedded (model) relationships.
\nNote that embedded records will serialize with the serializer for their model instead of the serializer in which they are defined.
\nNote also that this mixin does not work with JSONAPISerializer because the JSON:API specification does not describe how to format embedded resources.
\nBelow is an example of a per-type serializer (post type).
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTSerializer, { EmbeddedRecordsMixin } from '-data/serializer/rest';\n\nexport default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {\n attrs = {\n author: { embedded: 'always' },\n comments: { serialize: 'ids' }\n }\n} | \n
Note that this use of { embedded: 'always' } is unrelated to\nthe { embedded: 'always' } that is defined as an option on attr as part of\ndefining a model while working with the ActiveModelSerializer. Nevertheless,\nusing { embedded: 'always' } as an option to attr is not a valid way to set up\nembedded records.
The attrs option for a resource { embedded: 'always' } is shorthand for:
1\n2\n3\n4\n | \n {\n serialize: 'records',\n deserialize: 'records'\n} | \n
A resource's attrs option may be set to use ids, records or false for the\nserialize and deserialize settings.
The attrs property can be set on the ApplicationSerializer or a per-type\nserializer.
In the case where embedded JSON is expected while extracting a payload (reading)\nthe setting is deserialize: 'records', there is no need to use ids when\nextracting as that is the default behaviour without this mixin if you are using\nthe vanilla EmbeddedRecordsMixin. Likewise, to embed JSON in the payload while\nserializing serialize: 'records' is the setting to use. There is an option of\nnot embedding JSON in the serialized payload by using serialize: 'ids'. If you\ndo not want the relationship sent at all, you can use serialize: false.
If you do not overwrite attrs for a specific relationship, the EmbeddedRecordsMixin\nwill behave in the following way:
BelongsTo: { serialize: 'id', deserialize: 'id' }\nHasMany: { serialize: false, deserialize: 'ids' }
Embedded records must have a model defined to be extracted and serialized. Note that\nwhen defining any relationships on your model such as belongsTo and hasMany, you\nshould not both specify async: true and also indicate through the serializer's\nattrs attribute that the related model should be embedded for deserialization.\nIf a model is declared embedded for deserialization (embedded: 'always' or deserialize: 'records'),\nthen do not use async: true.
To successfully extract and serialize embedded records the model relationships\nmust be set up correctly. See the\ndefining relationships\nsection of the Defining Models guide page.
\nRecords without an id property are not considered embedded records, model\ninstances must have an id property to be used with Ember Data.
When customizing a serializer it is important to grok what the customizations\nare. Please read the docs for the methods this mixin provides, in case you need\nto modify it to fit your specific needs.
\nFor example, review the docs for each method of this mixin:
\n\n", + "access": "public", + "tagname": "", + "methods": [ + { + "file": "../serializer/addon/-private/embedded-records-mixin.js", + "line": 107, + "description": "Normalize the record and recursively normalize/extract all the embedded records\nwhile pushing them into the store as they are encountered
\nA payload with an attr configured for embedded records needs to be extracted:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n {\n "post": {\n "id": "1"\n "title": "Rails is omakase",\n "comments": [{\n "id": "1",\n "body": "Rails is unagi"\n }, {\n "id": "2",\n "body": "Omakase O_o"\n }]\n }\n} | \n
Serialize belongsTo relationship when it is configured as an embedded object.
This example of an author model belongs to a post model:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import Model, { attr, belongsTo } from '@ember-data/model';\n\nPost = Model.extend({\n title: attr('string'),\n body: attr('string'),\n author: belongsTo('author')\n});\n\nAuthor = Model.extend({\n name: attr('string'),\n post: belongsTo('post')\n}); | \n
Use a custom (type) serializer for the post model to configure embedded author
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTSerializer, { EmbeddedRecordsMixin } from '-data/serializer/rest';\n\nexport default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {\n attrs = {\n author: { embedded: 'always' }\n }\n} | \n
A payload with an attribute configured for embedded records can serialize\nthe records together under the root attribute's payload:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n {\n "post": {\n "id": "1"\n "title": "Rails is omakase",\n "author": {\n "id": "2"\n "name": "dhh"\n }\n }\n} | \n
Serializes hasMany relationships when it is configured as embedded objects.
This example of a post model has many comments:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import Model, { attr, belongsTo, hasMany } from '@ember-data/model';\n\nPost = Model.extend({\n title: attr('string'),\n body: attr('string'),\n comments: hasMany('comment')\n});\n\nComment = Model.extend({\n body: attr('string'),\n post: belongsTo('post')\n}); | \n
Use a custom (type) serializer for the post model to configure embedded comments
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTSerializer, { EmbeddedRecordsMixin } from '-data/serializer/rest';\n\nexport default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {\n attrs = {\n comments: { embedded: 'always' }\n }\n} | \n
A payload with an attribute configured for embedded records can serialize\nthe records together under the root attribute's payload:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n {\n "post": {\n "id": "1"\n "title": "Rails is omakase",\n "body": "I want this for my ORM, I want that for my template language..."\n "comments": [{\n "id": "1",\n "body": "Rails is unagi"\n }, {\n "id": "2",\n "body": "Omakase O_o"\n }]\n }\n} | \n
The attrs options object can use more specific instruction for extracting and\nserializing. When serializing, an option to embed ids, ids-and-types or records can be set.\nWhen extracting the only option is records.
So { embedded: 'always' } is shorthand for:\n{ serialize: 'records', deserialize: 'records' }
To embed the ids for a related object (using a hasMany relationship):
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTSerializer, { EmbeddedRecordsMixin } from '-data/serializer/rest';\n\nexport default class PostSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {\n attrs = {\n comments: { serialize: 'ids', deserialize: 'records' }\n }\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n | \n {\n "post": {\n "id": "1"\n "title": "Rails is omakase",\n "body": "I want this for my ORM, I want that for my template language..."\n "comments": ["1", "2"]\n }\n} | \n
To embed the relationship as a collection of objects with id and type keys, set\nids-and-types for the related object.
This is particularly useful for polymorphic relationships where records don't share\nthe same table and the id is not enough information.
For example having a user that has many pets:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n | \n User = Model.extend({\n name: attr('string'),\n pets: hasMany('pet', { polymorphic: true })\n});\n\nPet = Model.extend({\n name: attr('string'),\n});\n\nCat = Pet.extend({\n // ...\n});\n\nParrot = Pet.extend({\n // ...\n}); | \n
| app/serializers/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTSerializer, { EmbeddedRecordsMixin } from '-data/serializer/rest';\n\nexport default class UserSerializer extends RESTSerializer.extend(EmbeddedRecordsMixin) {\n attrs = {\n pets: { serialize: 'ids-and-types', deserialize: 'records' }\n }\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n {\n "user": {\n "id": "1"\n "name": "Bertin Osborne",\n "pets": [\n { "id": "1", "type": "Cat" },\n { "id": "1", "type": "Parrot"}\n ]\n }\n} | \n
When serializing an embedded record, modify the property (in the JSON payload)\nthat refers to the parent record (foreign key for the relationship).
Serializing a belongsTo relationship removes the property that refers to the\nparent record
Serializing a hasMany relationship does not remove the property that refers to\nthe parent record.
Holds validation errors for a given record, organized by attribute names.
\nThis class is not directly instantiable.
\nEvery Model has an errors property that is an instance of\nErrors. This can be used to display validation error\nmessages returned from the server when a record.save() rejects.
For Example, if you had a User model that looked like this:
| app/models/user.js | \n|
1\n2\n3\n4\n5\n6\n | \n import Model, { attr } from '-data/model';\n\nexport default class UserModel extends Model {\n ('string') username;\n ('string') email;\n} | \n
And you attempted to save a record that did not validate on the backend:
\n1\n2\n3\n4\n5\n | \n let user = store.createRecord('user', {\n username: 'tomster',\n email: 'invalidEmail'\n});\nuser.save(); | \n
Your backend would be expected to return an error response that described\nthe problem, so that error messages can be generated on the app.
\nAPI responses will be translated into instances of Errors differently,\ndepending on the specific combination of adapter and serializer used. You\nmay want to check the documentation or the source code of the libraries\nthat you are using, to know how they expect errors to be communicated.
Errors can be displayed to the user by accessing their property name\nto get an array of all the error objects for that property. Each\nerror object is a JavaScript object with two keys:
\nmessage A string containing the error message from the backendattribute The name of the property associated with this error message1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n <label>Username: <Input @value={{@model.username}} /> </label>\n{{#each @model.errors.username as |error|}}\n <div class="error">\n {{error.message}}\n </div>\n{{/each}}\n\n<label>Email: <Input @value={{@model.email}} /> </label>\n{{#each @model.errors.email as |error|}}\n <div class="error">\n {{error.message}}\n </div>\n{{/each}} | \n
You can also access the special messages property on the error\nobject to get an array of all the error strings.
1\n2\n3\n4\n5\n | \n {{#each @model.errors.messages as |message|}}\n <div class="error">\n {{message}}\n </div>\n{{/each}} | \n
Register with target handler
\n", + "itemtype": "method", + "name": "_registerHandlers", + "access": "private", + "tagname": "", + "class": "Errors", + "module": "@ember-data/store" + }, + { + "file": "../model/addon/-private/errors.js", + "line": 113, + "description": "Returns errors for a given attribute
\n1\n2\n3\n4\n5\n6\n7\n8\n | \n let user = store.createRecord('user', {\n username: 'tomster',\n email: 'invalidEmail'\n});\nuser.save().catch(function(){\n user.get('errors').errorsFor('email'); // returns:\n // [{attribute: "email", message: "Doesn't look like a valid email."}]\n}); | \n
Manually adds errors to the record. This will trigger the becameInvalid event/ lifecycle method on\n the record and transition the record into an invalid state.
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n let errors = get(user, 'errors');\n\n // add multiple errors\n errors.add('password', [\n 'Must be at least 12 characters',\n 'Must contain at least one symbol',\n 'Cannot contain your name'\n ]);\n\n errors.errorsFor('password');\n // =>\n // [\n // { attribute: 'password', message: 'Must be at least 12 characters' },\n // { attribute: 'password', message: 'Must contain at least one symbol' },\n // { attribute: 'password', message: 'Cannot contain your name' },\n // ]\n\n // add a single error\n errors.add('username', 'This field is required');\n\n errors.errorsFor('username');\n // =>\n // [\n // { attribute: 'username', message: 'This field is required' },\n // ] | \n
Adds error messages to a given attribute without sending event.
\n", + "itemtype": "method", + "name": "_add", + "access": "private", + "tagname": "", + "class": "Errors", + "module": "@ember-data/store" + }, + { + "file": "../model/addon/-private/errors.js", + "line": 276, + "itemtype": "method", + "name": "_findOrCreateMessages", + "access": "private", + "tagname": "", + "class": "Errors", + "module": "@ember-data/store" + }, + { + "file": "../model/addon/-private/errors.js", + "line": 301, + "description": "Manually removes all errors for a given member from the record.\n This will transition the record into a valid state, and\n triggers the becameValid event and lifecycle method.
Example:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n let errors = get('user', errors);\n errors.add('phone', ['error-1', 'error-2']);\n\n errors.errorsFor('phone');\n // =>\n // [\n // { attribute: 'phone', message: 'error-1' },\n // { attribute: 'phone', message: 'error-2' },\n // ]\n\n errors.remove('phone');\n\n errors.errorsFor('phone');\n // => undefined | \n
Removes all error messages from the given attribute without sending event.
\n", + "itemtype": "method", + "name": "_remove", + "access": "private", + "tagname": "", + "class": "Errors", + "module": "@ember-data/store" + }, + { + "file": "../model/addon/-private/errors.js", + "line": 374, + "description": "Manually clears all errors for the record.\n This will transition the record into a valid state, and\n will trigger the becameValid event and lifecycle method.
Example:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n | \n let errors = get('user', errors);\nerrors.add('username', ['error-a']);\nerrors.add('phone', ['error-1', 'error-2']);\n\nerrors.errorsFor('username');\n// =>\n// [\n// { attribute: 'username', message: 'error-a' },\n// ]\n\nerrors.errorsFor('phone');\n// =>\n// [\n// { attribute: 'phone', message: 'error-1' },\n// { attribute: 'phone', message: 'error-2' },\n// ]\n\nerrors.clear();\n\nerrors.errorsFor('username');\n// => undefined\n\nerrors.errorsFor('phone');\n// => undefined\n\nerrors.get('messages')\n// => [] | \n
Removes all error messages.\nto the record.
\n", + "itemtype": "method", + "name": "_clear", + "access": "private", + "tagname": "", + "class": "Errors", + "module": "@ember-data/store" + }, + { + "file": "../model/addon/-private/errors.js", + "line": 454, + "description": "Checks if there are error messages for the given attribute.
\n| app/controllers/user/edit.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import Controller from '/controller';\nimport { action } from '/object';\n\nexport default class UserEditController extends Controller {\n \n save(user) {\n if (user.get('errors').has('email')) {\n return alert('Please update your email before attempting to save.');\n }\n user.save();\n }\n} | \n
An array containing all of the error messages for this\nrecord. This is useful for displaying all errors to the user.
\n1\n2\n3\n4\n5\n | \n {{#each @model.errors.messages as |message|}}\n <div class="error">\n {{message}}\n </div>\n{{/each}} | \n
Total number of errors.
\n", + "itemtype": "property", + "name": "length", + "type": "{Number}", + "access": "public", + "tagname": "", + "readonly": "", + "class": "Errors", + "module": "@ember-data/store" + }, + { + "file": "../model/addon/-private/errors.js", + "line": 199, + "description": "true if we have no errors.
A HasManyReference is a low-level API that allows users and addon\nauthors to perform meta-operations on a has-many relationship.
This returns a string that represents how the reference will be\nlooked up when it is loaded. If the relationship has a link it will\nuse the "link" otherwise it defaults to "id".
\nExample
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ({ async: true }) comments;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\n// get the identifier of the reference\nif (commentsRef.remoteType() === "ids") {\n let ids = commentsRef.ids();\n} else if (commentsRef.remoteType() === "link") {\n let link = commentsRef.link();\n} | \n
ids() returns an array of the record IDs in this relationship.
Example
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ({ async: true }) comments;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\ncommentsRef.ids(); // ['1'] | \n
push can be used to update the data in the relationship and Ember\nData will treat the new data as the canonical value of this\nrelationship on the backend.
Example
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ({ async: true }) comments;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\ncommentsRef.ids(); // ['1']\n\ncommentsRef.push([\n[{ type: 'comment', id: 2 }],\n[{ type: 'comment', id: 3 }],\n])\n\ncommentsRef.ids(); // ['2', '3'] | \n
value() synchronously returns the current value of the has-many\nrelationship. Unlike record.get('relationshipName'), calling\nvalue() on a reference does not trigger a fetch if the async\nrelationship is not yet loaded. If the relationship is not loaded\nit will always return null.
Example
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ({ async: true }) comments;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\npost.get('comments').then(function(comments) {\n commentsRef.value() === comments\n}) | \n
Loads the relationship if it is not already loaded. If the\nrelationship is already loaded this method does not trigger a new\nload. This causes a request to the specified\nrelationship link or reloads all items currently in the relationship.
\nExample
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ({ async: true }) comments;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\ncommentsRef.load().then(function(comments) {\n //...\n}); | \n
You may also pass in an options object whose properties will be\nfed forward. This enables you to pass adapterOptions into the\nrequest given to the adapter via the reference.
Example
\n1\n2\n3\n4\n | \n commentsRef.load({ adapterOptions: { isPrivate: true } })\n .then(function(comments) {\n //...\n }); | \n
| app/adapters/comment.js | \n|
1\n2\n3\n4\n5\n6\n | \n export default ApplicationAdapter.extend({\n findMany(store, type, id, snapshots) {\n // In the adapter you will have access to adapterOptions.\n let adapterOptions = snapshots[0].adapterOptions;\n }\n}); | \n
Reloads this has-many relationship. This causes a request to the specified\nrelationship link or reloads all items currently in the relationship.
\nExample
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ({ async: true }) comments;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\ncommentsRef.reload().then(function(comments) {\n //...\n}); | \n
You may also pass in an options object whose properties will be\nfed forward. This enables you to pass adapterOptions into the\nrequest given to the adapter via the reference. A full example\ncan be found in the load method.
Example
\n1\n | \n commentsRef.reload({ adapterOptions: { isPrivate: true } }) | \n
This returns a string that represents how the reference will be\nlooked up when it is loaded. If the relationship has a link it will\nuse the "link" otherwise it defaults to "id".
\nExample
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '@ember-data/model';\n\nexport default Model.extend({\n comments: hasMany({ async: true })\n}); | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\n// get the identifier of the reference\nif (commentsRef.remoteType() === "ids") {\n let ids = commentsRef.ids();\n} else if (commentsRef.remoteType() === "link") {\n let link = commentsRef.link();\n} | \n
The link Ember Data will use to fetch or reload this belongs-to\nrelationship. By default it uses only the "related" resource linkage.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\nexport default Model.extend({\n user: belongsTo({ async: true })\n });\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n links: {\n related: '/articles/1/author'\n }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\n// get the identifier of the reference\nif (userRef.remoteType() === "link") {\n let link = userRef.link();\n } | \n
The meta data for the belongs-to relationship.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\nexport default Model.extend({\n user: belongsTo({ async: true })\n });\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n links: {\n related: {\n href: '/articles/1/author'\n },\n meta: {\n lastUpdated: 1458014400000\n }\n }\n }\n }\n }\n });\n\nlet userRef = blog.belongsTo('user');\n\nuserRef.meta() // { lastUpdated: 1458014400000 } | \n
Each instance of {Store} receives a unique instance of a IdentifierCache.
\nThis cache is responsible for assigning or retrieving the unique identify\nfor arbitrary resource data encountered by the store. Data representing\na unique resource or record should always be represented by the same\nidentifier.
\nIt can be configured by consuming applications.
\n", + "access": "public", + "tagname": "", + "methods": [ + { + "file": "../store/addon/-private/identifiers/cache.ts", + "line": 140, + "description": "Internal hook to allow management of merge conflicts with identifiers.
\nwe allow late binding of this private internal merge so that internalModelFactory\ncan insert itself here to handle elimination of duplicates
allows us to peek without generating when needed\nuseful for the "create" case when we need to see if\nwe are accidentally overwritting something
\n", + "itemtype": "method", + "name": "peekRecordIdentifier", + "params": [ + { + "name": "resource", + "description": "" + } + ], + "return": { + "description": "", + "type": "StableRecordIdentifier | undefined" + }, + "access": "private", + "tagname": "", + "class": "IdentifierCache", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/identifiers/cache.ts", + "line": 292, + "description": "Returns the Identifier for the given Resource, creates one if it does not yet exist.
\nSpecifically this means that we:
\nid type and lid combo against known identifierslid that is stable (repeated calls with the same\nid + type or lid will return the same lid value)Returns a new Identifier for the supplied data. Call this method to generate\nan identifier when a new resource is being created local to the client and\npotentially does not have an id.
Delegates generation to the user supplied GenerateMethod if one has been provided\nwith the signature generateMethod({ type }, 'record').
Provides the opportunity to update secondary lookup tables for existing identifiers\nCalled after an identifier created with createIdentifierForNewRecord has been\ncommitted.
Assigned id to an Identifier if id has not previously existed; however,\nattempting to change the id or calling update without providing an id when\none is missing will throw an error.
id (if id was previously null)lid and type MUST NOT be altered post creation If a merge occurs, it is possible the returned identifier does not match the originally\n provided identifier. In this case the abandoned identifier will go through the usual\n forgetRecordIdentifier codepaths.
Provides the opportunity to eliminate an identifier from secondary lookup tables\nas well as eliminates it from ember-data's own lookup tables and book keeping.
\nUseful when a record has been deleted and the deletion has been persisted and\nwe do not care about the record anymore. Especially useful when an id of a\ndeleted record might be reused later for a new record.
A InvalidError is used by an adapter to signal the external API\nwas unable to process a request because the content was not\nsemantically correct or meaningful per the API. Usually, this means a\nrecord failed some form of server-side validation. When a promise\nfrom an adapter is rejected with a InvalidError the record will\ntransition to the invalid state and the errors will be set to the\nerrors property on the record.
For Ember Data to correctly map errors to their corresponding\nproperties on the model, Ember Data expects each error to be\na valid JSON-API error object with a source/pointer that matches\nthe property name. For example, if you had a Post model that\nlooked like this.
| app/models/post.js | \n|
1\n2\n3\n4\n5\n6\n | \n import Model, { attr } from '-data/model';\n\nexport default class PostModel extends Model {\n ('string') title;\n ('string') content;\n} | \n
To show an error from the server related to the title and\ncontent properties your adapter could return a promise that\nrejects with a InvalidError object that looks like this:
| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n | \n import RSVP from 'RSVP';\nimport RESTAdapter from '@ember-data/adapter/rest';\nimport { InvalidError } from '@ember-data/adapter/error';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n updateRecord() {\n // Fictional adapter that always rejects\n return RSVP.reject(new InvalidError([\n {\n detail: 'Must be unique',\n source: { pointer: '/data/attributes/title' }\n },\n {\n detail: 'Must not be blank',\n source: { pointer: '/data/attributes/content'}\n }\n ]));\n }\n} | \n
Your backend may use different property names for your records the\nstore will attempt to extract and normalize the errors using the\nserializer's extractErrors method before the errors get added to\nthe model. As a result, it is safe for the InvalidError to\nwrap the error payload unaltered.
The JSONAPIAdapter is the default adapter used by Ember Data. It\nis responsible for transforming the store's requests into HTTP\nrequests that follow the JSON API\nformat.
The JSONAPIAdapter uses JSON API conventions for building the URL\nfor a record and selecting the HTTP verb to use with a request. The\nactions you can take on a record map onto the following URLs in the\nJSON API adapter:
\n| \n Action\n | \n\n HTTP Verb\n | \n\n URL\n | \n
|---|---|---|
| \n `store.findRecord('post', 123)`\n | \n\n GET\n | \n\n /posts/123\n | \n
| \n `store.findAll('post')`\n | \n\n GET\n | \n\n /posts\n | \n
| \n Update `postRecord.save()`\n | \n\n PATCH\n | \n\n /posts/123\n | \n
| \n Create `store.createRecord('post').save()`\n | \n\n POST\n | \n\n /posts\n | \n
| \n Delete `postRecord.destroyRecord()`\n | \n\n DELETE\n | \n\n /posts/123\n | \n
The JSONAPIAdapter will consider a success any response with a\nstatus code of the 2xx family ("Success"), as well as 304 ("Not\nModified"). Any other status code will be considered a failure.
\nOn success, the request promise will be resolved with the full\nresponse payload.
\nFailed responses with status code 422 ("Unprocessable Entity") will\nbe considered "invalid". The response will be discarded, except for\nthe errors key. The request promise will be rejected with a\nInvalidError. This error object will encapsulate the saved\nerrors value.
Any other status codes will be treated as an adapter error. The\nrequest promise will be rejected, similarly to the invalid case,\nbut with an instance of AdapterError instead.
Endpoint paths can be prefixed with a namespace by setting the\nnamespace property on the adapter:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n namespace = 'api/1';\n} | \n
Requests for the person model would now target /api/1/people/1.
An adapter can target other hosts by setting the host property.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n host = 'https://api.example.com';\n} | \n
Requests for the person model would now target\nhttps://api.example.com/people/1.
By default, the RESTAdapter will send the query params sorted alphabetically to the\nserver.
\nFor example:
\n1\n | \n store.query('posts', { sort: 'price', category: 'pets' }); | \n
will generate a requests like this /posts?category=pets&sort=price, even if the\nparameters were specified in a different order.
That way the generated URL will be deterministic and that simplifies caching mechanisms\nin the backend.
\nSetting sortQueryParams to a falsey value will respect the original order.
In case you want to sort the query parameters with a different criteria, set\nsortQueryParams to your custom sort function.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n sortQueryParams(params) {\n let sortedKeys = Object.keys(params).sort().reverse();\n let len = sortedKeys.length, newParams = {};\n\n for (let i = 0; i < len; i++) {\n newParams[sortedKeys[i]] = params[sortedKeys[i]];\n }\n\n return newParams;\n }\n} | \n
Called by the store in order to fetch the JSON for a given\ntype and ID.
\nThe findRecord method makes an Ajax request to a URL computed by\nbuildURL, 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.
Called by the store in order to fetch a JSON array for all\nof the records for a given type.
\nThe findAll method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a\npromise for the resulting payload.
Called by the store in order to fetch a JSON array for\nthe records that match a particular query.
\nThe query method makes an Ajax (HTTP GET) request to a URL\ncomputed by buildURL, and returns a promise for the resulting\npayload.
The query argument is a simple JavaScript object that will be passed directly\nto the server as parameters.
Called by the store in order to fetch a JSON object for\nthe record that matches a particular query.
\nThe queryRecord method makes an Ajax (HTTP GET) request to a URL\ncomputed by buildURL, and returns a promise for the resulting\npayload.
The query argument is a simple JavaScript object that will be passed directly\nto the server as parameters.
Called by the store in order to fetch several records together if coalesceFindRequests is true
For example, if the original payload looks like:
\n1\n2\n3\n4\n5\n | \n {\n "id": 1,\n "title": "Rails is omakase",\n "comments": [ 1, 2, 3 ]\n} | \n
The IDs will be passed as a URL-encoded Array of IDs, in this form:
\n1\n | \n ids[]=1&ids[]=2&ids[]=3 | \n
Many servers, such as Rails and PHP, will automatically convert this URL-encoded array\ninto an Array for you on the server-side. If you want to encode the\nIDs, differently, just override this (one-line) method.
\nThe findMany method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a\npromise for the resulting payload.
Called by the store in order to fetch a JSON array for\nthe unloaded records in a has-many relationship that were originally\nspecified as a URL (inside of links).
For example, if your original payload looks like this:
\n1\n2\n3\n4\n5\n6\n7\n | \n {\n "post": {\n "id": 1,\n "title": "Rails is omakase",\n "links": { "comments": "/posts/1/comments" }\n }\n} | \n
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.
Called by the store in order to fetch the JSON for the unloaded record in a\nbelongs-to relationship that was originally specified as a URL (inside of\nlinks).
For example, if your original payload looks like this:
\n1\n2\n3\n4\n5\n6\n7\n | \n {\n "person": {\n "id": 1,\n "name": "Tom Dale",\n "links": { "group": "/people/1/group" }\n }\n} | \n
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.
Called by the store when a newly created record is\nsaved via the save method on a model record instance.
The createRecord method serializes the record and makes an Ajax (HTTP POST) request\nto a URL computed by buildURL.
See serialize for information on how to customize the serialized form\nof a record.
Called by the store when an existing record is saved\nvia the save method on a model record instance.
The updateRecord method serializes the record and makes an Ajax (HTTP PUT) request\nto a URL computed by buildURL.
See serialize for information on how to customize the serialized form\nof a record.
Called by the store when a record is deleted.
\nThe deleteRecord method makes an Ajax (HTTP DELETE) request to a URL computed by buildURL.
Organize records into groups, each of which is to be passed to separate\ncalls to findMany.
This implementation groups together records that have the same base URL but\ndiffering ids. For example /comments/1 and /comments/2 will be grouped together\nbecause 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\nbut not those where there is more than 1 query param such as /comments?id=2&name=David\nCurrently only the query param of id is supported. If you need to support others, please\noverride this or the _stripIDFromURL method.
It does not group records that have differing base urls, such as for example: /posts/1/comments/2\nand /posts/2/comments/3
Takes an ajax response, and returns the json payload or an error.
\nBy default this hook just returns the json payload passed to it.\nYou might want to override it in two cases:
\nYour API might return useful results in the response headers.\nResponse headers are passed in as the second argument.
\nYour API might return errors as successful responses with status code\n200 and an Errors text or object. You can return a InvalidError or a\nAdapterError (or a sub class) from this hook and it will automatically\nreject the promise and put your record into the invalid or error state.
Returning a InvalidError from this method will cause the\nrecord to transition into the invalid state and make the\nerrors object available on the record. When returning an\nInvalidError the store will attempt to normalize the error data\nreturned from the server using the serializer's extractErrors\nmethod.
Default handleResponse implementation uses this hook to decide if the\nresponse is a success.
Default handleResponse implementation uses this hook to decide if the\nresponse is an invalid error.
Takes a URL, an HTTP method and a hash of data, and makes an\nHTTP request.
\nWhen the server responds with a payload, Ember Data will call into extractSingle\nor extractArray (depending on whether the original query was for one record or\nmany records).
By default, ajax method has the following behavior:
dataType to "json""GET", it sets the Content-Type to be\napplication/json; charset=utf-8"GET", it stringifies the data passed in. The\ndata is the serialized record in the case of a save.Generates a detailed ("friendly") error message, with plenty\nof information for debugging (good luck!)
\n", + "itemtype": "method", + "name": "generatedDetailedMessage", + "access": "private", + "tagname": "", + "params": [ + { + "name": "status", + "description": "", + "type": "Number" + }, + { + "name": "headers", + "description": "", + "type": "Object" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "requestData", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "detailed error message", + "type": "String" + }, + "class": "JSONAPIAdapter", + "module": "@ember-data/adapter/rest", + "inherited": true, + "inheritedFrom": "RESTAdapter" + }, + { + "file": "../adapter/addon/rest.ts", + "line": 1304, + "description": "Used by findAll and findRecord to build the query's data hash\nsupplied to the ajax method.
The findRecord() method is invoked when the store is asked for a record that\nhas not previously been loaded. In response to findRecord() being called, you\nshould query your persistence layer for a record with the given ID. The findRecord\nmethod should return a promise that will resolve to a JavaScript object that will be\nnormalized by the serializer.
Here is an example of the findRecord implementation:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findRecord(store, type, id, snapshot) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}/${id}`).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
The findAll() method is used to retrieve all records for a given type.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findAll(store, type) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
This method is called when you call query on the store.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n query(store, type, query) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`, query).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
The queryRecord() method is invoked when the store is asked for a single\nrecord through a query object.
In response to queryRecord() being called, you should always fetch fresh\ndata. Once found, you can asynchronously call the store's push() method\nto push the record into the store.
Here is an example queryRecord implementation:
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter, { BuildURLMixin } from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter.extend(BuildURLMixin) {\n queryRecord(store, type, query) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`, query).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
If the globally unique IDs for your records should be generated on the client,\nimplement the generateIdForRecord() method. This method will be invoked\neach time you create a new record, and the value returned from it will be\nassigned to the record's primaryKey.
Most traditional REST-like HTTP APIs will not use this method. Instead, the ID\nof the record will be set by the server, and your adapter will update the store\nwith the new ID when it calls didCreateRecord(). Only implement this method if\nyou intend to generate record IDs on the client-side.
The generateIdForRecord() method will be invoked with the requesting store as\nthe first parameter and the newly created record as the second parameter:
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Adapter from '-data/adapter';\nimport { v4 } from 'uuid';\n\nexport default class ApplicationAdapter extends Adapter {\n generateIdForRecord(store, type, inputProperties) {\n return v4();\n }\n} | \n
Proxies to the serializer's serialize method.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import Adapter from '-data/adapter';\n\nexport default class ApplicationAdapter extends Adapter {\n createRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let url = `/${type.modelName}`;\n\n // ...\n }\n} | \n
Implement this method in a subclass to handle the creation of\nnew records.
\nSerializes the record and sends it to the server.
\nExample
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n createRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n\n return new RSVP.Promise(function (resolve, reject) {\n $.ajax({\n type: 'POST',\n url: `/${type.modelName}`,\n dataType: 'json',\n data: data\n }).then(function (data) {\n run(null, resolve, data);\n }, function (jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Implement this method in a subclass to handle the updating of\na record.
\nSerializes the record update and sends it to the server.
\nThe updateRecord method is expected to return a promise that will\nresolve with the serialized record. This allows the backend to\ninform the Ember Data store the current state of this record after\nthe update. If it is not possible to return a serialized record\nthe updateRecord promise can also resolve with undefined and the\nEmber Data store will assume all of the updates were successfully\napplied on the backend.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n updateRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let id = snapshot.id;\n\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'PUT',\n url: `/${type.modelName}/${id}`,\n dataType: 'json',\n data: data\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Implement this method in a subclass to handle the deletion of\na record.
\nSends a delete request for the record to the server.
\nExample
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n deleteRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let id = snapshot.id;\n\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'DELETE',\n url: `/${type.modelName}/${id}`,\n dataType: 'json',\n data: data\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
The store will call findMany instead of multiple findRecord\nrequests to find multiple records at once if coalesceFindRequests\nis true.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findMany(store, type, ids, snapshots) {\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'GET',\n url: `/${type.modelName}/`,\n dataType: 'json',\n data: { filter: { id: ids.join(',') } }\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Organize records into groups, each of which is to be passed to separate\ncalls to findMany.
For example, if your API has nested URLs that depend on the parent, you will\nwant to group records by their parent.
\nThe default implementation returns the records as a single group.
\n", + "itemtype": "method", + "name": "groupRecordsForFindMany", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "snapshots", + "description": "", + "type": "Array" + } + ], + "return": { + "description": "an array of arrays of records, each of which is to be\n loaded separately by `findMany`.", + "type": "Array" + }, + "class": "JSONAPIAdapter", + "module": "@ember-data/adapter", + "inherited": true, + "inheritedFrom": "Adapter" + }, + { + "file": "../adapter/addon/index.ts", + "line": 703, + "description": "This method is used by the store to determine if the store should\nreload a record from the adapter when a record is requested by\nstore.findRecord.
If this method returns true, the store will re-fetch a record from\nthe adapter. If this method returns false, the store will resolve\nimmediately using the cached record.
For example, if you are building an events ticketing system, in which users\ncan only reserve tickets for 20 minutes at a time, and want to ensure that\nin each route you have data that is no more than 20 minutes old you could\nwrite:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n shouldReloadRecord(store, ticketSnapshot) {\n let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt');\n let timeDiff = moment().diff(lastAccessedAt, 'minutes');\n\n if (timeDiff > 20) {\n return true;\n } else {\n return false;\n }\n} | \n
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\ncase the cached version is more than 20 minutes old, findRecord will not\nresolve until you fetched the latest version.
By default this hook returns false, as most UIs should not block user\ninteractions while waiting on data update.
Note that, with default settings, shouldBackgroundReloadRecord will always\nre-fetch the records in the background even if shouldReloadRecord returns\nfalse. You can override shouldBackgroundReloadRecord if this does not\nsuit your use case.
This method is used by the store to determine if the store should\nreload all records from the adapter when records are requested by\nstore.findAll.
If this method returns true, the store will re-fetch all records from\nthe adapter. If this method returns false, the store will resolve\nimmediately using the cached records.
For example, if you are building an events ticketing system, in which users\ncan only reserve tickets for 20 minutes at a time, and want to ensure that\nin each route you have data that is no more than 20 minutes old you could\nwrite:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n shouldReloadAll(store, snapshotArray) {\n let snapshots = snapshotArray.snapshots();\n\n return snapshots.any((ticketSnapshot) => {\n let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt');\n let timeDiff = moment().diff(lastAccessedAt, 'minutes');\n\n if (timeDiff > 20) {\n return true;\n } else {\n return false;\n }\n });\n} | \n
This method would ensure that whenever you do store.findAll('ticket') you\nwill always get a list of tickets that are no more than 20 minutes old. In\ncase a cached version is more than 20 minutes old, findAll will not\nresolve until you fetched the latest versions.
By default, this method returns true if the passed snapshotRecordArray\nis empty (meaning that there are no records locally available yet),\notherwise, it returns false.
Note that, with default settings, shouldBackgroundReloadAll will always\nre-fetch all the records in the background even if shouldReloadAll returns\nfalse. You can override shouldBackgroundReloadAll if this does not suit\nyour use case.
This method is used by the store to determine if the store should\nreload a record after the store.findRecord method resolves a\ncached record.
This method is only checked by the store when the store is\nreturning a cached record.
\nIf this method returns true the store will re-fetch a record from\nthe adapter.
For example, if you do not want to fetch complex data over a mobile\nconnection, or if the network is down, you can implement\nshouldBackgroundReloadRecord as follows:
1\n2\n3\n4\n5\n | \n shouldBackgroundReloadRecord(store, snapshot) {\n let { downlink, effectiveType } = navigator.connection;\n\n return downlink > 0 && effectiveType === '4g';\n} | \n
By default, this hook returns true so the data for the record is updated\nin the background.
This method is used by the store to determine if the store should\nreload a record array after the store.findAll method resolves\nwith a cached record array.
This method is only checked by the store when the store is\nreturning a cached record array.
\nIf this method returns true the store will re-fetch all records\nfrom the adapter.
For example, if you do not want to fetch complex data over a mobile\nconnection, or if the network is down, you can implement\nshouldBackgroundReloadAll as follows:
1\n2\n3\n4\n5\n | \n shouldBackgroundReloadAll(store, snapshotArray) {\n let { downlink, effectiveType } = navigator.connection;\n\n return downlink > 0 && effectiveType === '4g';\n} | \n
By default this method returns true, indicating that a background reload\nshould always be triggered.
Builds a URL for a given type and optional ID.
\nBy default, it pluralizes the type's name (for example, 'post'\nbecomes 'posts' and 'person' becomes 'people'). To override the\npluralization see pathForType.
\nIf an ID is specified, it adds the ID to the path generated\nfor the type, separated by a /.
When called by RESTAdapter.findMany() the id and snapshot parameters\nwill be arrays of ids and snapshots.
Builds a URL for a store.findRecord(type, id) call.
Example:
\n| app/adapters/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindRecord(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id, snapshot);\n return `${baseUrl}/users/${snapshot.adapterOptions.user_id}/playlists/${id}`;\n }\n} | \n
Builds a URL for a store.findAll(type) call.
Example:
\n| app/adapters/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindAll(modelName, snapshot) {\n let baseUrl = this.buildURL(modelName);\n return `${baseUrl}/data/comments.json`;\n }\n} | \n
Builds a URL for a store.query(type, query) call.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n host = 'https://api.github.com';\n urlForQuery (query, modelName) {\n switch(modelName) {\n case 'repo':\n return `https://api.github.com/orgs/${query.orgId}/repos`;\n default:\n return super.urlForQuery(...arguments);\n }\n }\n} | \n
Builds a URL for a store.queryRecord(type, query) call.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForQueryRecord({ slug }, modelName) {\n let baseUrl = this.buildURL();\n return `${baseUrl}/${encodeURIComponent(slug)}`;\n }\n} | \n
Builds a URL for coalescing multiple store.findRecord(type, id)\nrecords into 1 request when the adapter's coalesceFindRequests\nproperty is true.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForFindMany(ids, modelName) {\n let baseUrl = this.buildURL();\n return `${baseUrl}/coalesce`;\n }\n} | \n
Builds a URL for fetching an async hasMany relationship when a URL\nis not provided by the server.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindHasMany(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id);\n return `${baseUrl}/relationships`;\n }\n} | \n
Builds a URL for fetching an async belongsTo relationship when a url\nis not provided by the server.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindBelongsTo(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id);\n return `${baseUrl}/relationships`;\n }\n} | \n
Builds a URL for a record.save() call when the record was created\nlocally using store.createRecord().
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForCreateRecord(modelName, snapshot) {\n return super.urlForCreateRecord(...arguments) + '/new';\n }\n} | \n
Builds a URL for a record.save() call when the record has been updated locally.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForUpdateRecord(id, modelName, snapshot) {\n return `/${id}/feed?access_token=${snapshot.adapterOptions.token}`;\n }\n} | \n
Builds a URL for a record.save() call when the record has been deleted locally.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForDeleteRecord(id, modelName, snapshot) {\n return super.urlForDeleteRecord(...arguments) + '/destroy';\n }\n} | \n
Determines the pathname for a given type.
\nBy default, it pluralizes the type's name (for example,\n'post' becomes 'posts' and 'person' becomes 'people').
\nFor example, if you have an object LineItem with an\nendpoint of /line_items/.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { decamelize } from '/string';\nimport { pluralize } from 'ember-inflector';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n pathForType(modelName) {\n var decamelized = decamelize(modelName);\n return pluralize(decamelized);\n }\n} | \n
By default the JSONAPIAdapter will send each find request coming from a store.find\nor from accessing a relationship separately to the server. If your server supports passing\nids as a query string, you can set coalesceFindRequests to true to coalesce all find requests\nwithin a single runloop.
For example, if you have an initial payload of:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n {\n data: {\n id: 1,\n type: 'post',\n relationship: {\n comments: {\n data: [\n { id: 1, type: 'comment' },\n { id: 2, type: 'comment' }\n ]\n }\n }\n }\n} | \n
By default calling post.get('comments') will trigger the following requests(assuming the\ncomments haven't been loaded before):
1\n2\n | \n GET /comments/1\nGET /comments/2 | \n
If you set coalesceFindRequests to true it will instead trigger the following request:
1\n | \n GET /comments?filter[id]=1,2 | \n
Setting coalesceFindRequests to true also works for store.find requests and belongsTo\nrelationships accessed within the same runloop. If you set coalesceFindRequests: true
1\n2\n | \n store.findRecord('comment', 1);\nstore.findRecord('comment', 2); | \n
will also send a request to: GET /comments?filter[id]=1,2
Note: Requests coalescing rely on URL building strategy. So if you override buildURL in your app\ngroupRecordsForFindMany more likely should be overridden as well in order for coalescing to work.
If jQuery or nAjax are installed, this property\n allows fetch to still be used instead when true.
By default the RESTAdapter will send each find request coming from a store.find\nor from accessing a relationship separately to the server. If your server supports passing\nids as a query string, you can set coalesceFindRequests to true to coalesce all find requests\nwithin a single runloop.
For example, if you have an initial payload of:
\n1\n2\n3\n4\n5\n6\n | \n {\n post: {\n id: 1,\n comments: [1, 2]\n }\n} | \n
By default calling post.get('comments') will trigger the following requests(assuming the\ncomments haven't been loaded before):
1\n2\n | \n GET /comments/1\nGET /comments/2 | \n
If you set coalesceFindRequests to true it will instead trigger the following request:
1\n | \n GET /comments?ids[]=1&ids[]=2 | \n
Setting coalesceFindRequests to true also works for store.find requests and belongsTo\nrelationships accessed within the same runloop. If you set coalesceFindRequests: true
1\n2\n | \n store.findRecord('comment', 1);\nstore.findRecord('comment', 2); | \n
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\ngroupRecordsForFindMany more likely should be overridden as well in order for coalescing to work.
Endpoint paths can be prefixed with a namespace by setting the namespace\nproperty on the adapter:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n namespace = 'api/1';\n} | \n
Requests for the Post model would now target /api/1/post/.
An adapter can target other hosts by setting the host property.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n host = 'https://api.example.com';\n} | \n
Requests for the Post model would now target https://api.example.com/post/.
Some APIs require HTTP headers, e.g. to provide an API\nkey. Arbitrary headers can be set as key/value pairs on the\nRESTAdapter's headers object and Ember Data will send them\nalong with each ajax request. For dynamic headers see headers\ncustomization.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { computed } from '/object';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n headers: computed(function() {\n return {\n 'API_KEY': 'secret key',\n 'ANOTHER_HEADER': 'Some header value'\n };\n })\n} | \n
If you would like your adapter to use a custom serializer you can\nset the defaultSerializer property to be the name of the custom\nserializer.
Note the defaultSerializer serializer has a lower priority than\na model specific serializer (i.e. PostSerializer) or the\napplication serializer.
| app/adapters/django.js | \n|
1\n2\n3\n4\n5\n | \n import Adapter from '@ember-data/adapter';\n\nexport default Adapter.extend({\n defaultSerializer: 'django'\n}); | \n
By default the store will try to coalesce all fetchRecord calls within the same runloop\ninto as few requests as possible by calling groupRecordsForFindMany and passing it into a findMany call.\nYou can opt out of this behaviour by either not implementing the findMany hook or by setting\ncoalesceFindRequests to false.
Ember Data 2.0 Serializer:
\nIn Ember Data a Serializer is used to serialize and deserialize\nrecords when they are transferred in and out of an external source.\nThis process involves normalizing property names, transforming\nattribute values and serializing relationships.
\nJSONAPISerializer supports the http://jsonapi.org/ spec and is the\nserializer recommended by Ember Data.
This serializer normalizes a JSON API payload that looks like:
\n| app/models/player.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class Player extends Model {\n ('string') name;\n ('string') skill;\n ('number') gamesPlayed;\n ('club') club;\n} | \n
| app/models/club.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr, hasMany } from '-data/model';\n\nexport default class Club extends Model {\n ('string') name;\n ('string') location;\n ('player') players;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n34\n35\n36\n37\n38\n39\n40\n41\n | \n {\n "data": [\n {\n "attributes": {\n "name": "Benfica",\n "location": "Portugal"\n },\n "id": "1",\n "relationships": {\n "players": {\n "data": [\n {\n "id": "3",\n "type": "players"\n }\n ]\n }\n },\n "type": "clubs"\n }\n ],\n "included": [\n {\n "attributes": {\n "name": "Eusebio Silva Ferreira",\n "skill": "Rocket shot",\n "games-played": 431\n },\n "id": "3",\n "relationships": {\n "club": {\n "data": {\n "id": "1",\n "type": "clubs"\n }\n }\n },\n "type": "players"\n }\n ]\n } | \n
to the format that the Ember Data store expects.
\nSince a JSON API Document can have meta defined in multiple locations you can\nuse the specific serializer hooks if you need to customize the meta.
\nOne scenario would be to camelCase the meta keys of your payload. The example\nbelow shows how this could be done using normalizeArrayResponse and\nextractRelationship.
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n | \n import JSONAPISerializer from '@ember-data/serializer/json-api';\n\nexport default class ApplicationSerializer extends JSONAPISerializer {\n normalizeArrayResponse(store, primaryModelClass, payload, id, requestType) {\n let normalizedDocument = super.normalizeArrayResponse(...arguments);\n\n // Customize document meta\n normalizedDocument.meta = camelCaseKeys(normalizedDocument.meta);\n\n return normalizedDocument;\n }\n\n extractRelationship(relationshipHash) {\n let normalizedRelationship = super.extractRelationship(...arguments);\n\n // Customize relationship meta\n normalizedRelationship.meta = camelCaseKeys(normalizedRelationship.meta);\n\n return normalizedRelationship;\n }\n} | \n
@mainName @ember-data/serializer/json-api\n @tag main
\n", + "_main": true, + "since": "1.13.0", + "access": "public", + "tagname": "", + "extends": "JSONSerializer", + "methods": [ + { + "file": "../serializer/addon/json-api.js", + "line": 135, + "itemtype": "method", + "name": "_normalizeDocumentHelper", + "params": [ + { + "name": "documentHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "access": "private", + "tagname": "", + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json-api" + }, + { + "file": "../serializer/addon/json-api.js", + "line": 172, + "itemtype": "method", + "name": "_normalizeRelationshipDataHelper", + "params": [ + { + "name": "relationshipDataHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "access": "private", + "tagname": "", + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json-api" + }, + { + "file": "../serializer/addon/json-api.js", + "line": 184, + "itemtype": "method", + "name": "_normalizeResourceHelper", + "params": [ + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "access": "private", + "tagname": "", + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json-api" + }, + { + "file": "../serializer/addon/json-api.js", + "line": 213, + "description": "Normalize some data and push it into the store.
\n", + "itemtype": "method", + "name": "pushPayload", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "payload", + "description": "", + "type": "Object" + } + ], + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json-api" + }, + { + "file": "../serializer/addon/json-api.js", + "line": 226, + "itemtype": "method", + "name": "_normalizeResponse", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + }, + { + "name": "isSingle", + "description": "", + "type": "Boolean" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "access": "private", + "tagname": "", + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json-api" + }, + { + "file": "../serializer/addon/json-api.js", + "line": 279, + "description": "Returns a relationship formatted as a JSON-API "relationship object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\n", + "itemtype": "method", + "name": "extractRelationship", + "access": "public", + "tagname": "", + "params": [ + { + "name": "relationshipHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json-api" + }, + { + "file": "../serializer/addon/json-api.js", + "line": 308, + "description": "Returns the resource's relationships formatted as a JSON-API "relationships object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\n", + "itemtype": "method", + "name": "extractRelationships", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json-api" + }, + { + "file": "../serializer/addon/json-api.js", + "line": 346, + "itemtype": "method", + "name": "_extractType", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Model" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "String" + }, + "access": "private", + "tagname": "", + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json-api" + }, + { + "file": "../serializer/addon/json-api.js", + "line": 357, + "description": "Dasherizes and singularizes the model name in the payload to match\nthe format Ember Data uses internally for the model name.
\nFor example the key posts would be converted to post and the\nkey studentAssesments would be converted to student-assesment.
Converts the model name to a pluralized version of the model name.
\nFor example post would be converted to posts and\nstudent-assesment would be converted to student-assesments.
keyForAttribute can be used to define rules for how to convert an\nattribute name in your model to a key in your JSON.\nBy default JSONAPISerializer follows the format used on the examples of\nhttp://jsonapi.org/format and uses dashes as the word separator in the JSON\nattribute keys.
This behaviour can be easily customized by extending this method.
\nExample
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPISerializer from '-data/serializer/json-api';\nimport { dasherize } from '/string';\n\nexport default class ApplicationSerializer extends JSONAPISerializer {\n keyForAttribute(attr, method) {\n return dasherize(attr).toUpperCase();\n }\n} | \n
keyForRelationship can be used to define a custom key when\nserializing and deserializing relationship properties.\nBy default JSONAPISerializer follows the format used on the examples of\nhttp://jsonapi.org/format and uses dashes as word separators in\nrelationship properties.
This behaviour can be easily customized by extending this method.
\nExample
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPISerializer from '-data/serializer/json-api';\nimport { underscore } from '/string';\n\nexport default class ApplicationSerializer extends JSONAPISerializer {\n keyForRelationship(key, relationship, method) {\n return underscore(key);\n }\n} | \n
Called when a record is saved in order to convert the\nrecord into JSON.
\nFor example, consider this model:
\n| app/models/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n title;\n body;\n\n ('user', { async: false, inverse: null })\n author;\n} | \n
The default serialization would create a JSON-API resource object like:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n {\n "data": {\n "type": "comments",\n "attributes": {\n "title": "Rails is unagi",\n "body": "Rails? Omakase? O_O",\n },\n "relationships": {\n "author": {\n "data": {\n "id": "12",\n "type": "users"\n }\n }\n }\n }\n} | \n
By default, attributes are passed through as-is, unless\nyou specified an attribute type (attr('date')). If\nyou specify a transform, the JavaScript value will be\nserialized when inserted into the attributes hash.
Belongs-to relationships are converted into JSON-API\nresource identifier objects.
\nserialize takes an options hash with a single option:\nincludeId. If this option is true, serialize will,\nby default include the ID in the JSON object it builds.
The JSONAPIAdapter passes in includeId: true when serializing a record\nfor createRecord or updateRecord.
Your server may expect data in a different format than the\nbuilt-in serialization format.
\nIn that case, you can implement serialize yourself and\nreturn data formatted to match your API's expectations, or override\nthe invoked adapter method and do the serialization in the adapter directly\nby using the provided snapshot.
If your API's format differs greatly from the JSON:API spec, you should\nconsider authoring your own adapter and serializer instead of extending\nthis class.
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import JSONAPISerializer from '@ember-data/serializer/json-api';\n\nexport default class PostSerializer extends JSONAPISerializer {\n serialize(snapshot, options) {\n let json = {\n POST_TTL: snapshot.attr('title'),\n POST_BDY: snapshot.attr('body'),\n POST_CMS: snapshot.hasMany('comments', { ids: true })\n };\n\n if (options.includeId) {\n json.POST_ID_ = snapshot.id;\n }\n\n return json;\n }\n} | \n
If you want to define a serializer for your entire\napplication, you'll probably want to use eachAttribute\nand eachRelationship on the record.
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n | \n import JSONAPISerializer from '@ember-data/serializer/json-api';\nimport { singularize } from 'ember-inflector';\nimport { underscore } from '@ember/string';\n\nexport default class ApplicationSerializer extends JSONAPISerializer {\n serialize(snapshot, options) {\n let json = {};\n\n snapshot.eachAttribute((name) => {\n json[serverAttributeName(name)] = snapshot.attr(name);\n });\n\n snapshot.eachRelationship((name, relationship) => {\n if (relationship.kind === 'hasMany') {\n json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });\n }\n });\n\n if (options.includeId) {\n json.ID_ = snapshot.id;\n }\n\n return json;\n }\n}\n\nfunction serverAttributeName(attribute) {\n return underscore(attribute).toUpperCase();\n}\n\nfunction serverHasManyName(name) {\n return serverAttributeName(singularize(name)) + '_IDS';\n} | \n
This serializer will generate JSON that looks like this:
\n1\n2\n3\n4\n5\n | \n {\n "TITLE": "Rails is omakase",\n "BODY": "Yep. Omakase.",\n "COMMENT_IDS": [ "1", "2", "3" ]\n} | \n
If you just want to do some small tweaks on the default JSON:API formatted response,\nyou can call super.serialize first and make the tweaks\non the returned object.
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONAPISerializer from '-data/serializer/json-api';\n\nexport default class PostSerializer extends JSONAPISerializer {\n serialize(snapshot, options) {\n let json = super.serialize(...arguments);\n\n json.data.attributes.subject = json.data.attributes.title;\n delete json.data.attributes.title;\n\n return json;\n }\n} | \n
Given a subclass of Model and a JSON object this method will\niterate through each attribute of the Model and invoke the\nTransform#deserialize method on the matching property of the\nJSON object. This method is typically called after the\nserializer's normalize method.
The normalizeResponse method is used to normalize a payload from the\nserver to a JSON-API Document.
http://jsonapi.org/format/#document-structure
\nThis method delegates to a more specific normalize method based on\nthe requestType.
To override this method with a custom one, make sure to call\nreturn this._super(store, primaryModelClass, payload, id, requestType) with your\npre-processed data.
Here's an example of using normalizeResponse manually:
1\n2\n3\n4\n5\n6\n7\n8\n | \n socket.on('message', function(message) {\n let data = message.data;\n let modelClass = store.modelFor(data.modelName);\n let serializer = store.serializerFor(data.modelName);\n let normalized = serializer.normalizeSingleResponse(store, modelClass, data, data.id);\n\n store.push(normalized);\n}); | \n
Called by the default normalizeResponse implementation when the\ntype of request is findRecord
Called by the default normalizeResponse implementation when the\ntype of request is queryRecord
Called by the default normalizeResponse implementation when the\ntype of request is findAll
Called by the default normalizeResponse implementation when the\ntype of request is findBelongsTo
Called by the default normalizeResponse implementation when the\ntype of request is findHasMany
Called by the default normalizeResponse implementation when the\ntype of request is findMany
Called by the default normalizeResponse implementation when the\ntype of request is query
Called by the default normalizeResponse implementation when the\ntype of request is createRecord
Called by the default normalizeResponse implementation when the\ntype of request is deleteRecord
Called by the default normalizeResponse implementation when the\ntype of request is updateRecord
normalizeUpdateRecordResponse, normalizeCreateRecordResponse and\nnormalizeDeleteRecordResponse delegate to this method by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeSaveResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 470, + "description": "normalizeQueryResponse and normalizeFindRecordResponse delegate to this\nmethod by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeSingleResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 488, + "description": "normalizeQueryResponse, normalizeFindManyResponse, and normalizeFindHasManyResponse delegate\nto this method by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeArrayResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 506, + "itemtype": "method", + "name": "_normalizeResponse", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + }, + { + "name": "isSingle", + "description": "", + "type": "Boolean" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "access": "private", + "tagname": "", + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 555, + "description": "Normalizes a part of the JSON payload returned by\nthe server. You should override this method, munge the hash\nand call super if you have generic normalization to do.
\nIt takes the type of the record that is being normalized\n(as a Model class), the property where the hash was\noriginally found, and the hash to normalize.
\nYou can use this method, for example, to normalize underscored keys to camelized\nor other general-purpose normalizations.
\nExample
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n | \n import JSONSerializer from '@ember-data/serializer/json';\nimport { underscore } from '@ember/string';\nimport { get } from '@ember/object';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n normalize(typeClass, hash) {\n let fields = get(typeClass, 'fields');\n\n fields.forEach(function(type, field) {\n let payloadField = underscore(field);\n if (field === payloadField) { return; }\n\n hash[field] = hash[payloadField];\n delete hash[payloadField];\n });\n\n return this._super.apply(this, arguments);\n }\n} | \n
Returns the resource's ID.
\n", + "itemtype": "method", + "name": "extractId", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "String" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 634, + "description": "Returns the resource's attributes formatted as a JSON-API "attributes object".
\nhttp://jsonapi.org/format/#document-resource-object-attributes
\n", + "itemtype": "method", + "name": "extractAttributes", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 659, + "description": "Returns a relationship formatted as a JSON-API "relationship object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\n", + "itemtype": "method", + "name": "extractRelationship", + "access": "public", + "tagname": "", + "params": [ + { + "name": "relationshipModelName", + "description": "", + "type": "Object" + }, + { + "name": "relationshipHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 694, + "description": "Returns a polymorphic relationship formatted as a JSON-API "relationship object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\nrelationshipOptions is a hash which contains more information about the\npolymorphic relationship which should be extracted:
resourceHash complete hash of the resource the relationship should be\nextracted fromrelationshipKey key under which the value for the relationship is\nextracted from the resourceHashrelationshipMeta meta information about the relationshipReturns the resource's relationships formatted as a JSON-API "relationships object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\n", + "itemtype": "method", + "name": "extractRelationships", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 790, + "description": "Dasherizes the model name in the payload
\n", + "itemtype": "method", + "name": "modelNameFromPayloadKey", + "access": "public", + "tagname": "", + "params": [ + { + "name": "key", + "description": "", + "type": "String" + } + ], + "return": { + "description": "the model's modelName", + "type": "String" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 802, + "itemtype": "method", + "name": "normalizeRelationships", + "access": "private", + "tagname": "", + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 825, + "itemtype": "method", + "name": "normalizeUsingDeclaredMapping", + "access": "private", + "tagname": "", + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 858, + "description": "Looks up the property key that was set by the custom attr mapping\npassed to the serializer.
Check attrs.key.serialize property to inform if the key\ncan be serialized
When attrs.key.serialize is set to true then\nit takes priority over the other checks and the related\nattribute/relationship will be serialized
\n", + "itemtype": "method", + "name": "_mustSerialize", + "access": "private", + "tagname": "", + "params": [ + { + "name": "key", + "description": "", + "type": "String" + } + ], + "return": { + "description": "true if the key must be serialized", + "type": "Boolean" + }, + "class": "JSONAPISerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 928, + "description": "Check if the given hasMany relationship should be serialized
\nBy default only many-to-many and many-to-none relationships are serialized.\nThis could be configured per relationship by Serializer's attrs object.
Called when a record is saved in order to convert the\nrecord into JSON.
\nBy default, it creates a JSON object with a key for\neach attribute and belongsTo relationship.
\nFor example, consider this model:
\n| app/models/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n title;\n body;\n\n ('user') author;\n} | \n
The default serialization would create a JSON object like:
\n1\n2\n3\n4\n5\n | \n {\n "title": "Rails is unagi",\n "body": "Rails? Omakase? O_O",\n "author": 12\n} | \n
By default, attributes are passed through as-is, unless\nyou specified an attribute type (attr('date')). If\nyou specify a transform, the JavaScript value will be\nserialized when inserted into the JSON hash.
By default, belongs-to relationships are converted into\nIDs when inserted into the JSON hash.
\nserialize takes an options hash with a single option:\nincludeId. If this option is true, serialize will,\nby default include the ID in the JSON object it builds.
The adapter passes in includeId: true when serializing\na record for createRecord, but not for updateRecord.
Your server may expect a different JSON format than the\nbuilt-in serialization format.
\nIn that case, you can implement serialize yourself and\nreturn a JSON hash of your choosing.
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import JSONSerializer from '@ember-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = {\n POST_TTL: snapshot.attr('title'),\n POST_BDY: snapshot.attr('body'),\n POST_CMS: snapshot.hasMany('comments', { ids: true })\n };\n\n if (options.includeId) {\n json.POST_ID_ = snapshot.id;\n }\n\n return json;\n }\n} | \n
If you want to define a serializer for your entire\napplication, you'll probably want to use eachAttribute\nand eachRelationship on the record.
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n | \n import JSONSerializer from '@ember-data/serializer/json';\nimport { singularize } from 'ember-inflector';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = {};\n\n snapshot.eachAttribute((name) => {\n json[serverAttributeName(name)] = snapshot.attr(name);\n });\n\n snapshot.eachRelationship((name, relationship) => {\n if (relationship.kind === 'hasMany') {\n json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });\n }\n });\n\n if (options.includeId) {\n json.ID_ = snapshot.id;\n }\n\n return json;\n }\n}\n\nfunction serverAttributeName(attribute) {\n return attribute.underscore().toUpperCase();\n}\n\nfunction serverHasManyName(name) {\n return serverAttributeName(singularize(name)) + "_IDS";\n} | \n
This serializer will generate JSON that looks like this:
\n1\n2\n3\n4\n5\n | \n {\n "TITLE": "Rails is omakase",\n "BODY": "Yep. Omakase.",\n "COMMENT_IDS": [ "1", "2", "3" ]\n} | \n
If you just want to do some small tweaks on the default JSON,\nyou can call super.serialize first and make the tweaks on\nthe returned JSON.
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = super.serialize(...arguments);\n\n json.subject = json.title;\n delete json.title;\n\n return json;\n }\n} | \n
You can use this method to customize how a serialized record is added to the complete\nJSON hash to be sent to the server. By default the JSON Serializer does not namespace\nthe payload and just sends the raw serialized JSON object.\nIf your server expects namespaced keys, you should consider using the RESTSerializer.\nOtherwise you can override this method to customize how the record is added to the hash.\nThe hash property should be modified by reference.
\nFor example, your server may expect underscored root objects.
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import RESTSerializer from '-data/serializer/rest';\nimport { decamelize } from '/string';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n serializeIntoHash(data, type, snapshot, options) {\n let root = decamelize(type.modelName);\n data[root] = this.serialize(snapshot, options);\n }\n} | \n
serializeAttribute can be used to customize how attr\nproperties are serialized
For example if you wanted to ensure all your attributes were always\nserialized as properties on an attributes object you could\nwrite:
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n serializeAttribute(snapshot, json, key, attributes) {\n json.attributes = json.attributes || {};\n this._super(snapshot, json.attributes, key, attributes);\n }\n} | \n
serializeBelongsTo can be used to customize how belongsTo\nproperties are serialized.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import JSONSerializer from '-data/serializer/json';\nimport { isNone } from '/utils';\n\nexport default class PostSerializer extends JSONSerializer {\n serializeBelongsTo(snapshot, json, relationship) {\n let key = relationship.key;\n let belongsTo = snapshot.belongsTo(key);\n\n key = this.keyForRelationship ? this.keyForRelationship(key, "belongsTo", "serialize") : key;\n\n json[key] = isNone(belongsTo) ? belongsTo : belongsTo.record.toJSON();\n }\n} | \n
serializeHasMany can be used to customize how hasMany\nproperties are serialized.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serializeHasMany(snapshot, json, relationship) {\n let key = relationship.key;\n if (key === 'comments') {\n return;\n } else {\n this._super(...arguments);\n }\n }\n} | \n
You can use this method to customize how polymorphic objects are\nserialized. Objects are considered to be polymorphic if\n{ polymorphic: true } is pass as the second argument to the\nbelongsTo function.
Example
\n| app/serializers/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import JSONSerializer from '-data/serializer/json';\nimport { isNone } from '/utils';\n\nexport default class CommentSerializer extends JSONSerializer {\n serializePolymorphicType(snapshot, json, relationship) {\n let key = relationship.key;\n let belongsTo = snapshot.belongsTo(key);\n\n key = this.keyForAttribute ? this.keyForAttribute(key, 'serialize') : key;\n\n if (isNone(belongsTo)) {\n json[key + '_type'] = null;\n } else {\n json[key + '_type'] = belongsTo.modelName;\n }\n }\n} | \n
extractMeta is used to deserialize any meta information in the\nadapter payload. By default Ember Data expects meta information to\nbe located on the meta property of the payload object.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n extractMeta(store, typeClass, payload) {\n if (payload && payload.hasOwnProperty('_pagination')) {\n let meta = payload._pagination;\n delete payload._pagination;\n return meta;\n }\n }\n} | \n
extractErrors is used to extract model errors when a call\nto Model#save fails with an InvalidError. By default\nEmber Data expects error information to be located on the errors\nproperty of the payload object.
This serializer expects this errors object to be an Array similar\nto the following, compliant with the https://jsonapi.org/format/#errors specification:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n {\n "errors": [\n {\n "detail": "This username is already taken!",\n "source": {\n "pointer": "data/attributes/username"\n }\n }, {\n "detail": "Doesn't look like a valid email.",\n "source": {\n "pointer": "data/attributes/email"\n }\n }\n ]\n} | \n
The key detail provides a textual description of the problem.\nAlternatively, the key title can be used for the same purpose.
The nested keys source.pointer detail which specific element\nof the request data was invalid.
Note that JSON-API also allows for object-level errors to be placed\nin an object with pointer data, signifying that the problem\ncannot be traced to a specific attribute:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n {\n "errors": [\n {\n "detail": "Some generic non property error message",\n "source": {\n "pointer": "data"\n }\n }\n ]\n} | \n
When turn into a Errors object, you can read these errors\nthrough the property base:
1\n2\n3\n4\n5\n | \n {{#each @model.errors.base as |error|}}\n <div class="error">\n {{error.message}}\n </div>\n{{/each}} | \n
Example of alternative implementation, overriding the default\nbehavior to deal with a different format of errors:
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n extractErrors(store, typeClass, payload, id) {\n if (payload && typeof payload === 'object' && payload._problems) {\n payload = payload._problems;\n this.normalizeErrors(typeClass, payload);\n }\n return payload;\n }\n} | \n
keyForAttribute can be used to define rules for how to convert an\nattribute name in your model to a key in your JSON.
Example
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\nimport { underscore } from '/string';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n keyForAttribute(attr, method) {\n return underscore(attr).toUpperCase();\n }\n} | \n
keyForRelationship can be used to define a custom key when\nserializing and deserializing relationship properties. By default\nJSONSerializer does not provide an implementation of this method.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\nimport { underscore } from '/string';\n\nexport default class PostSerializer extends JSONSerializer {\n keyForRelationship(key, relationship, method) {\n return `rel_${underscore(key)}`;\n }\n} | \n
keyForLink can be used to define a custom key when deserializing link\nproperties.
The normalizeResponse method is used to normalize a payload from the\nserver to a JSON-API Document.
http://jsonapi.org/format/#document-structure
\nExample:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n Serializer.extend({\n normalizeResponse(store, primaryModelClass, payload, id, requestType) {\n if (requestType === 'findRecord') {\n return this.normalize(primaryModelClass, payload);\n } else {\n return payload.reduce(function(documentHash, item) {\n let { data, included } = this.normalize(primaryModelClass, item);\n documentHash.included.push(...included);\n documentHash.data.push(data);\n return documentHash;\n }, { data: [], included: [] })\n }\n }\n}); | \n
The serialize method is used when a record is saved in order to convert\nthe record into the form that your external data source expects.
serialize takes an optional options hash with a single option:
includeId: If this is true, serialize should include the ID\nin the serialized object it builds.Example:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n | \n Serializer.extend({\n serialize(snapshot, options) {\n let json = {\n id: snapshot.id\n };\n\n snapshot.eachAttribute((key, attribute) => {\n json[key] = snapshot.attr(key);\n });\n\n snapshot.eachRelationship((key, relationship) => {\n if (relationship.kind === 'belongsTo') {\n json[key] = snapshot.belongsTo(key, { id: true });\n } else if (relationship.kind === 'hasMany') {\n json[key] = snapshot.hasMany(key, { ids: true });\n }\n });\n\n return json;\n },\n}); | \n
The normalize method is used to convert a payload received from your\nexternal data source into the normalized form store.push() expects. You\nshould override this method, munge the hash and return the normalized\npayload.
Example:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n Serializer.extend({\n normalize(modelClass, resourceHash) {\n let data = {\n id: resourceHash.id,\n type: modelClass.modelName,\n attributes: resourceHash\n };\n return { data: data };\n }\n}) | \n
The primaryKey is used when serializing and deserializing\ndata. Ember Data always uses the id property to store the id of\nthe record. The external source may not always follow this\nconvention. In these cases it is useful to override the\nprimaryKey property to match the primaryKey of your external\nstore.
Example
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n primaryKey = '_id'\n} | \n
The attrs object can be used to declare a simple mapping between\nproperty names on Model records and payload keys in the\nserialized JSON object representing the record. An object with the\nproperty key can also be used to designate the attribute's key on\nthe response payload.
Example
\n| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr } from '-data/model';\n\nexport default class PersonModel extends Model {\n ('string') firstName;\n ('string') lastName;\n ('string') occupation;\n ('boolean') admin;\n} | \n
| app/serializers/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PersonSerializer extends JSONSerializer {\n attrs = {\n admin: 'is_admin',\n occupation: { key: 'career' }\n }\n} | \n
You can also remove attributes and relationships by setting the serialize\nkey to false in your mapping object.
Example
\n| app/serializers/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n attrs = {\n admin: { serialize: false },\n occupation: { key: 'career' }\n }\n} | \n
When serialized:
\n1\n2\n3\n4\n5\n | \n {\n "firstName": "Harry",\n "lastName": "Houdini",\n "career": "magician"\n} | \n
Note that the admin is now not included in the payload.
Setting serialize to true enforces serialization for hasMany\nrelationships even if it's neither a many-to-many nor many-to-none\nrelationship.
The store property is the application's store that contains\nall records. It can be used to look up serializers for other model\ntypes that may be nested inside the payload response.
Example:
\n1\n2\n3\n4\n5\n6\n7\n | \n Serializer.extend({\n extractRelationship(relationshipModelName, relationshipHash) {\n let modelClass = this.store.modelFor(relationshipModelName);\n let relationshipSerializer = this.store.serializerFor(relationshipModelName);\n return relationshipSerializer.normalize(modelClass, relationshipHash);\n }\n}); | \n
Ember Data 2.0 Serializer:
\nIn Ember Data a Serializer is used to serialize and deserialize\nrecords when they are transferred in and out of an external source.\nThis process involves normalizing property names, transforming\nattribute values and serializing relationships.
\nBy default, Ember Data uses and recommends the JSONAPISerializer.
JSONSerializer is useful for simpler or legacy backends that may\nnot support the http://jsonapi.org/ spec.
For example, given the following User model and JSON payload:
| app/models/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, belongsTo, hasMany } from '-data/model';\n\nexport default class UserModel extends Model {\n ('user') friends;\n ('location') house;\n\n ('string') name;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n | \n {\n id: 1,\n name: 'Sebastian',\n friends: [3, 4],\n links: {\n house: '/houses/lefkada'\n }\n} | \n
JSONSerializer will normalize the JSON payload to the JSON API format that the\nEmber Data store expects.
You can customize how JSONSerializer processes its payload by passing options in\nthe attrs hash or by subclassing the JSONSerializer and overriding hooks:
normalize hook.JSONSerializer normalizes the whole server response, use the\nnormalizeResponse hook.JSONSerializer normalizes a specific response from the server,\nuse one of the many specific normalizeResponse hooks.JSONSerializer normalizes your id, attributes or relationships,\nuse the extractId, extractAttributes and extractRelationships hooks.The JSONSerializer normalization process follows these steps:
normalizeResponsenormalizeCreateRecordResponsenormalizeResponse for a specific operation is called.normalizeSingleResponse|normalizeArrayResponsecreateRecord we expect a single record back, while for methods like findAll we expect multiple records back.normalizenormalizeArrayResponse iterates and calls normalize for each of its records while normalizeSingle\ncalls it once. This is the method you most likely want to subclass.extractId | extractAttributes | extractRelationshipsnormalize delegates to these methods to\nturn the record payload into the JSON API format.\n @mainName @ember-data/serializer/json\n @tag mainGiven a subclass of Model and a JSON object this method will\niterate through each attribute of the Model and invoke the\nTransform#deserialize method on the matching property of the\nJSON object. This method is typically called after the\nserializer's normalize method.
The normalizeResponse method is used to normalize a payload from the\nserver to a JSON-API Document.
http://jsonapi.org/format/#document-structure
\nThis method delegates to a more specific normalize method based on\nthe requestType.
To override this method with a custom one, make sure to call\nreturn this._super(store, primaryModelClass, payload, id, requestType) with your\npre-processed data.
Here's an example of using normalizeResponse manually:
1\n2\n3\n4\n5\n6\n7\n8\n | \n socket.on('message', function(message) {\n let data = message.data;\n let modelClass = store.modelFor(data.modelName);\n let serializer = store.serializerFor(data.modelName);\n let normalized = serializer.normalizeSingleResponse(store, modelClass, data, data.id);\n\n store.push(normalized);\n}); | \n
Called by the default normalizeResponse implementation when the\ntype of request is findRecord
Called by the default normalizeResponse implementation when the\ntype of request is queryRecord
Called by the default normalizeResponse implementation when the\ntype of request is findAll
Called by the default normalizeResponse implementation when the\ntype of request is findBelongsTo
Called by the default normalizeResponse implementation when the\ntype of request is findHasMany
Called by the default normalizeResponse implementation when the\ntype of request is findMany
Called by the default normalizeResponse implementation when the\ntype of request is query
Called by the default normalizeResponse implementation when the\ntype of request is createRecord
Called by the default normalizeResponse implementation when the\ntype of request is deleteRecord
Called by the default normalizeResponse implementation when the\ntype of request is updateRecord
normalizeUpdateRecordResponse, normalizeCreateRecordResponse and\nnormalizeDeleteRecordResponse delegate to this method by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeSaveResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 470, + "description": "normalizeQueryResponse and normalizeFindRecordResponse delegate to this\nmethod by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeSingleResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 488, + "description": "normalizeQueryResponse, normalizeFindManyResponse, and normalizeFindHasManyResponse delegate\nto this method by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeArrayResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 506, + "itemtype": "method", + "name": "_normalizeResponse", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + }, + { + "name": "isSingle", + "description": "", + "type": "Boolean" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "access": "private", + "tagname": "", + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 555, + "description": "Normalizes a part of the JSON payload returned by\nthe server. You should override this method, munge the hash\nand call super if you have generic normalization to do.
\nIt takes the type of the record that is being normalized\n(as a Model class), the property where the hash was\noriginally found, and the hash to normalize.
\nYou can use this method, for example, to normalize underscored keys to camelized\nor other general-purpose normalizations.
\nExample
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n | \n import JSONSerializer from '@ember-data/serializer/json';\nimport { underscore } from '@ember/string';\nimport { get } from '@ember/object';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n normalize(typeClass, hash) {\n let fields = get(typeClass, 'fields');\n\n fields.forEach(function(type, field) {\n let payloadField = underscore(field);\n if (field === payloadField) { return; }\n\n hash[field] = hash[payloadField];\n delete hash[payloadField];\n });\n\n return this._super.apply(this, arguments);\n }\n} | \n
Returns the resource's ID.
\n", + "itemtype": "method", + "name": "extractId", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "String" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 634, + "description": "Returns the resource's attributes formatted as a JSON-API "attributes object".
\nhttp://jsonapi.org/format/#document-resource-object-attributes
\n", + "itemtype": "method", + "name": "extractAttributes", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 659, + "description": "Returns a relationship formatted as a JSON-API "relationship object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\n", + "itemtype": "method", + "name": "extractRelationship", + "access": "public", + "tagname": "", + "params": [ + { + "name": "relationshipModelName", + "description": "", + "type": "Object" + }, + { + "name": "relationshipHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 694, + "description": "Returns a polymorphic relationship formatted as a JSON-API "relationship object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\nrelationshipOptions is a hash which contains more information about the\npolymorphic relationship which should be extracted:
resourceHash complete hash of the resource the relationship should be\nextracted fromrelationshipKey key under which the value for the relationship is\nextracted from the resourceHashrelationshipMeta meta information about the relationshipReturns the resource's relationships formatted as a JSON-API "relationships object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\n", + "itemtype": "method", + "name": "extractRelationships", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 790, + "description": "Dasherizes the model name in the payload
\n", + "itemtype": "method", + "name": "modelNameFromPayloadKey", + "access": "public", + "tagname": "", + "params": [ + { + "name": "key", + "description": "", + "type": "String" + } + ], + "return": { + "description": "the model's modelName", + "type": "String" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 802, + "itemtype": "method", + "name": "normalizeRelationships", + "access": "private", + "tagname": "", + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 825, + "itemtype": "method", + "name": "normalizeUsingDeclaredMapping", + "access": "private", + "tagname": "", + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 858, + "description": "Looks up the property key that was set by the custom attr mapping\npassed to the serializer.
Check attrs.key.serialize property to inform if the key\ncan be serialized
When attrs.key.serialize is set to true then\nit takes priority over the other checks and the related\nattribute/relationship will be serialized
\n", + "itemtype": "method", + "name": "_mustSerialize", + "access": "private", + "tagname": "", + "params": [ + { + "name": "key", + "description": "", + "type": "String" + } + ], + "return": { + "description": "true if the key must be serialized", + "type": "Boolean" + }, + "class": "JSONSerializer", + "module": "@ember-data/serializer/json" + }, + { + "file": "../serializer/addon/json.js", + "line": 928, + "description": "Check if the given hasMany relationship should be serialized
\nBy default only many-to-many and many-to-none relationships are serialized.\nThis could be configured per relationship by Serializer's attrs object.
Called when a record is saved in order to convert the\nrecord into JSON.
\nBy default, it creates a JSON object with a key for\neach attribute and belongsTo relationship.
\nFor example, consider this model:
\n| app/models/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n title;\n body;\n\n ('user') author;\n} | \n
The default serialization would create a JSON object like:
\n1\n2\n3\n4\n5\n | \n {\n "title": "Rails is unagi",\n "body": "Rails? Omakase? O_O",\n "author": 12\n} | \n
By default, attributes are passed through as-is, unless\nyou specified an attribute type (attr('date')). If\nyou specify a transform, the JavaScript value will be\nserialized when inserted into the JSON hash.
By default, belongs-to relationships are converted into\nIDs when inserted into the JSON hash.
\nserialize takes an options hash with a single option:\nincludeId. If this option is true, serialize will,\nby default include the ID in the JSON object it builds.
The adapter passes in includeId: true when serializing\na record for createRecord, but not for updateRecord.
Your server may expect a different JSON format than the\nbuilt-in serialization format.
\nIn that case, you can implement serialize yourself and\nreturn a JSON hash of your choosing.
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import JSONSerializer from '@ember-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = {\n POST_TTL: snapshot.attr('title'),\n POST_BDY: snapshot.attr('body'),\n POST_CMS: snapshot.hasMany('comments', { ids: true })\n };\n\n if (options.includeId) {\n json.POST_ID_ = snapshot.id;\n }\n\n return json;\n }\n} | \n
If you want to define a serializer for your entire\napplication, you'll probably want to use eachAttribute\nand eachRelationship on the record.
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n | \n import JSONSerializer from '@ember-data/serializer/json';\nimport { singularize } from 'ember-inflector';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = {};\n\n snapshot.eachAttribute((name) => {\n json[serverAttributeName(name)] = snapshot.attr(name);\n });\n\n snapshot.eachRelationship((name, relationship) => {\n if (relationship.kind === 'hasMany') {\n json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });\n }\n });\n\n if (options.includeId) {\n json.ID_ = snapshot.id;\n }\n\n return json;\n }\n}\n\nfunction serverAttributeName(attribute) {\n return attribute.underscore().toUpperCase();\n}\n\nfunction serverHasManyName(name) {\n return serverAttributeName(singularize(name)) + "_IDS";\n} | \n
This serializer will generate JSON that looks like this:
\n1\n2\n3\n4\n5\n | \n {\n "TITLE": "Rails is omakase",\n "BODY": "Yep. Omakase.",\n "COMMENT_IDS": [ "1", "2", "3" ]\n} | \n
If you just want to do some small tweaks on the default JSON,\nyou can call super.serialize first and make the tweaks on\nthe returned JSON.
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = super.serialize(...arguments);\n\n json.subject = json.title;\n delete json.title;\n\n return json;\n }\n} | \n
You can use this method to customize how a serialized record is added to the complete\nJSON hash to be sent to the server. By default the JSON Serializer does not namespace\nthe payload and just sends the raw serialized JSON object.\nIf your server expects namespaced keys, you should consider using the RESTSerializer.\nOtherwise you can override this method to customize how the record is added to the hash.\nThe hash property should be modified by reference.
\nFor example, your server may expect underscored root objects.
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import RESTSerializer from '-data/serializer/rest';\nimport { decamelize } from '/string';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n serializeIntoHash(data, type, snapshot, options) {\n let root = decamelize(type.modelName);\n data[root] = this.serialize(snapshot, options);\n }\n} | \n
serializeAttribute can be used to customize how attr\nproperties are serialized
For example if you wanted to ensure all your attributes were always\nserialized as properties on an attributes object you could\nwrite:
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n serializeAttribute(snapshot, json, key, attributes) {\n json.attributes = json.attributes || {};\n this._super(snapshot, json.attributes, key, attributes);\n }\n} | \n
serializeBelongsTo can be used to customize how belongsTo\nproperties are serialized.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import JSONSerializer from '-data/serializer/json';\nimport { isNone } from '/utils';\n\nexport default class PostSerializer extends JSONSerializer {\n serializeBelongsTo(snapshot, json, relationship) {\n let key = relationship.key;\n let belongsTo = snapshot.belongsTo(key);\n\n key = this.keyForRelationship ? this.keyForRelationship(key, "belongsTo", "serialize") : key;\n\n json[key] = isNone(belongsTo) ? belongsTo : belongsTo.record.toJSON();\n }\n} | \n
serializeHasMany can be used to customize how hasMany\nproperties are serialized.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serializeHasMany(snapshot, json, relationship) {\n let key = relationship.key;\n if (key === 'comments') {\n return;\n } else {\n this._super(...arguments);\n }\n }\n} | \n
You can use this method to customize how polymorphic objects are\nserialized. Objects are considered to be polymorphic if\n{ polymorphic: true } is pass as the second argument to the\nbelongsTo function.
Example
\n| app/serializers/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import JSONSerializer from '-data/serializer/json';\nimport { isNone } from '/utils';\n\nexport default class CommentSerializer extends JSONSerializer {\n serializePolymorphicType(snapshot, json, relationship) {\n let key = relationship.key;\n let belongsTo = snapshot.belongsTo(key);\n\n key = this.keyForAttribute ? this.keyForAttribute(key, 'serialize') : key;\n\n if (isNone(belongsTo)) {\n json[key + '_type'] = null;\n } else {\n json[key + '_type'] = belongsTo.modelName;\n }\n }\n} | \n
extractMeta is used to deserialize any meta information in the\nadapter payload. By default Ember Data expects meta information to\nbe located on the meta property of the payload object.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n extractMeta(store, typeClass, payload) {\n if (payload && payload.hasOwnProperty('_pagination')) {\n let meta = payload._pagination;\n delete payload._pagination;\n return meta;\n }\n }\n} | \n
extractErrors is used to extract model errors when a call\nto Model#save fails with an InvalidError. By default\nEmber Data expects error information to be located on the errors\nproperty of the payload object.
This serializer expects this errors object to be an Array similar\nto the following, compliant with the https://jsonapi.org/format/#errors specification:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n {\n "errors": [\n {\n "detail": "This username is already taken!",\n "source": {\n "pointer": "data/attributes/username"\n }\n }, {\n "detail": "Doesn't look like a valid email.",\n "source": {\n "pointer": "data/attributes/email"\n }\n }\n ]\n} | \n
The key detail provides a textual description of the problem.\nAlternatively, the key title can be used for the same purpose.
The nested keys source.pointer detail which specific element\nof the request data was invalid.
Note that JSON-API also allows for object-level errors to be placed\nin an object with pointer data, signifying that the problem\ncannot be traced to a specific attribute:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n {\n "errors": [\n {\n "detail": "Some generic non property error message",\n "source": {\n "pointer": "data"\n }\n }\n ]\n} | \n
When turn into a Errors object, you can read these errors\nthrough the property base:
1\n2\n3\n4\n5\n | \n {{#each @model.errors.base as |error|}}\n <div class="error">\n {{error.message}}\n </div>\n{{/each}} | \n
Example of alternative implementation, overriding the default\nbehavior to deal with a different format of errors:
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n extractErrors(store, typeClass, payload, id) {\n if (payload && typeof payload === 'object' && payload._problems) {\n payload = payload._problems;\n this.normalizeErrors(typeClass, payload);\n }\n return payload;\n }\n} | \n
keyForAttribute can be used to define rules for how to convert an\nattribute name in your model to a key in your JSON.
Example
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\nimport { underscore } from '/string';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n keyForAttribute(attr, method) {\n return underscore(attr).toUpperCase();\n }\n} | \n
keyForRelationship can be used to define a custom key when\nserializing and deserializing relationship properties. By default\nJSONSerializer does not provide an implementation of this method.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\nimport { underscore } from '/string';\n\nexport default class PostSerializer extends JSONSerializer {\n keyForRelationship(key, relationship, method) {\n return `rel_${underscore(key)}`;\n }\n} | \n
keyForLink can be used to define a custom key when deserializing link\nproperties.
The normalizeResponse method is used to normalize a payload from the\nserver to a JSON-API Document.
http://jsonapi.org/format/#document-structure
\nExample:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n Serializer.extend({\n normalizeResponse(store, primaryModelClass, payload, id, requestType) {\n if (requestType === 'findRecord') {\n return this.normalize(primaryModelClass, payload);\n } else {\n return payload.reduce(function(documentHash, item) {\n let { data, included } = this.normalize(primaryModelClass, item);\n documentHash.included.push(...included);\n documentHash.data.push(data);\n return documentHash;\n }, { data: [], included: [] })\n }\n }\n}); | \n
The serialize method is used when a record is saved in order to convert\nthe record into the form that your external data source expects.
serialize takes an optional options hash with a single option:
includeId: If this is true, serialize should include the ID\nin the serialized object it builds.Example:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n | \n Serializer.extend({\n serialize(snapshot, options) {\n let json = {\n id: snapshot.id\n };\n\n snapshot.eachAttribute((key, attribute) => {\n json[key] = snapshot.attr(key);\n });\n\n snapshot.eachRelationship((key, relationship) => {\n if (relationship.kind === 'belongsTo') {\n json[key] = snapshot.belongsTo(key, { id: true });\n } else if (relationship.kind === 'hasMany') {\n json[key] = snapshot.hasMany(key, { ids: true });\n }\n });\n\n return json;\n },\n}); | \n
The normalize method is used to convert a payload received from your\nexternal data source into the normalized form store.push() expects. You\nshould override this method, munge the hash and return the normalized\npayload.
Example:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n Serializer.extend({\n normalize(modelClass, resourceHash) {\n let data = {\n id: resourceHash.id,\n type: modelClass.modelName,\n attributes: resourceHash\n };\n return { data: data };\n }\n}) | \n
The primaryKey is used when serializing and deserializing\ndata. Ember Data always uses the id property to store the id of\nthe record. The external source may not always follow this\nconvention. In these cases it is useful to override the\nprimaryKey property to match the primaryKey of your external\nstore.
Example
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n primaryKey = '_id'\n} | \n
The attrs object can be used to declare a simple mapping between\nproperty names on Model records and payload keys in the\nserialized JSON object representing the record. An object with the\nproperty key can also be used to designate the attribute's key on\nthe response payload.
Example
\n| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr } from '-data/model';\n\nexport default class PersonModel extends Model {\n ('string') firstName;\n ('string') lastName;\n ('string') occupation;\n ('boolean') admin;\n} | \n
| app/serializers/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PersonSerializer extends JSONSerializer {\n attrs = {\n admin: 'is_admin',\n occupation: { key: 'career' }\n }\n} | \n
You can also remove attributes and relationships by setting the serialize\nkey to false in your mapping object.
Example
\n| app/serializers/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n attrs = {\n admin: { serialize: false },\n occupation: { key: 'career' }\n }\n} | \n
When serialized:
\n1\n2\n3\n4\n5\n | \n {\n "firstName": "Harry",\n "lastName": "Houdini",\n "career": "magician"\n} | \n
Note that the admin is now not included in the payload.
Setting serialize to true enforces serialization for hasMany\nrelationships even if it's neither a many-to-many nor many-to-none\nrelationship.
The store property is the application's store that contains\nall records. It can be used to look up serializers for other model\ntypes that may be nested inside the payload response.
Example:
\n1\n2\n3\n4\n5\n6\n7\n | \n Serializer.extend({\n extractRelationship(relationshipModelName, relationshipHash) {\n let modelClass = this.store.modelFor(relationshipModelName);\n let relationshipSerializer = this.store.serializerFor(relationshipModelName);\n return relationshipSerializer.normalize(modelClass, relationshipHash);\n }\n}); | \n
A ManyArray is a MutableArray that represents the contents of a has-many\nrelationship.
The ManyArray is instantiated lazily the first time the relationship is\nrequested.
This class is not intended to be directly instantiated by consuming applications.
\nOften, the relationships in Ember Data applications will have\nan inverse. For example, imagine the following models are\ndefined:
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ('comment') comments;\n} | \n
| app/models/comment.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n ('post') post;\n} | \n
If you created a new instance of Post and added\na Comment record to its comments has-many\nrelationship, you would expect the comment's post\nproperty to be set to the post that contained\nthe has-many.
We call the record to which a relationship belongs-to the\nrelationship's owner.
\n", + "access": "public", + "tagname": "", + "extends": "EmberObject", + "uses": [ + "DeprecatedEvented", + "Ember.MutableArray" + ], + "methods": [ + { + "file": "../model/addon/-private/system/many-array.js", + "line": 304, + "description": "Reloads all of the records in the manyArray. If the manyArray\nholds a relationship that was originally fetched using a links url\nEmber Data will revisit the original links url to repopulate the\nrelationship.
\nIf the manyArray holds the result of a store.query() reload will\nre-run the original query.
Example
\n1\n2\n3\n4\n5\n | \n let user = store.peekRecord('user', '1')\nawait login(user);\n\nlet permissions = await user.permissions;\nawait permissions.reload(); | \n
Saves all of the records in the ManyArray.
Example
\n1\n2\n3\n4\n5\n6\n | \n let inbox = await store.findRecord('inbox', '1');\nlet messages = await inbox.messages;\nmessages.forEach((message) => {\n message.isRead = true;\n});\nmessages.save(); | \n
Create a child record within the owner
\n", + "itemtype": "method", + "name": "createRecord", + "access": "public", + "tagname": "", + "params": [ + { + "name": "hash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "record", + "type": "Model" + }, + "class": "ManyArray", + "module": "@ember-data/store" + } + ], + "events": [], + "properties": [ + { + "file": "../model/addon/-private/system/many-array.js", + "line": 67, + "description": "The loading state of this array
\n", + "itemtype": "property", + "name": "isLoaded", + "type": "Boolean", + "access": "public", + "tagname": "", + "class": "ManyArray", + "module": "@ember-data/store" + }, + { + "file": "../model/addon/-private/system/many-array.js", + "line": 77, + "description": "Metadata associated with the request for async hasMany relationships.
\nExample
\nGiven that the server returns the following JSON payload when fetching a\nhasMany relationship:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n {\n "comments": [{\n "id": 1,\n "comment": "This is the first comment",\n }, {\n// ...\n }],\n\n "meta": {\n "page": 1,\n "total": 5\n }\n} | \n
You can then access the meta data via the meta property:
1\n2\n3\n4\n5\n | \n let comments = await post.comments;\nlet meta = comments.meta;\n\n// meta.page => 1\n// meta.total => 5 | \n
Retrieve the links for this relationship
\n", + "itemtype": "property", + "name": "links", + "type": "Object | null", + "access": "public", + "tagname": "", + "class": "ManyArray", + "module": "@ember-data/store" + }, + { + "file": "../model/addon/-private/system/many-array.js", + "line": 124, + "description": "true if the relationship is polymorphic, false otherwise.
The relationship which manages this array.
\n", + "itemtype": "property", + "name": "relationship", + "type": "ManyRelationship", + "access": "private", + "tagname": "", + "class": "ManyArray", + "module": "@ember-data/store" + } + ] + }, + "relationships": { + "parent-class": { + "data": { + "id": "EmberObject", + "type": "missing" + } + }, + "descendants": { + "data": [] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/store", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-MinimumAdapterInterface-e647b24afc.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-MinimumAdapterInterface-e647b24afc.json new file mode 100644 index 000000000..e18fd0123 --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-MinimumAdapterInterface-e647b24afc.json @@ -0,0 +1,600 @@ +{ + "data": { + "id": "ember-data-3.28.13-MinimumAdapterInterface", + "type": "class", + "attributes": { + "name": "MinimumAdapterInterface", + "shortname": "MinimumAdapterInterface", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/adapter", + "namespace": "", + "file": "../store/addon/-private/ts-interfaces/minimum-adapter-interface.ts", + "line": 19, + "description": "The following documentation describes the methods an\nadapter should implement with descriptions around when an\napplication might expect these methods to be called.
\nMethods that are not required are marked as optional.
\n", + "access": "public", + "tagname": "", + "methods": [ + { + "file": "../store/addon/-private/ts-interfaces/minimum-adapter-interface.ts", + "line": 30, + "description": "adapter.findRecord takes a request for a resource of a given type and id combination\nand should return a Promise which fulfills with data for a single resource matching that\ntype and id.
The response will be fed to the associated serializer's normalizeResponse method with the\nrequestType set to findRecord, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing data for the record.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
adapter.findRecord is called whenever the store needs to load, reload, or backgroundReload\nthe resource data for a given type and id.
adapter.findAll takes a request for resources of a given type and should return\n a Promise which fulfills with a collection of resource data matching that type.
The response will be fed to the associated serializer's normalizeResponse method\n with the requestType set to findAll, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing records for type. Existing records for the type will not be removed.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
adapter.findAll is called whenever store.findAll is asked to reload or backgroundReload.\nThe records in the response are merged with the contents of the store. Existing records for\nthe type will not be removed.
See also shouldReloadAll and shouldBackgroundReloadAll
adapter.query takes a request for resources of a given type and should return\n a Promise which fulfills with a collection of resource data matching that type.
The response will be fed to the associated serializer's normalizeResponse method\n with the requestType set to query, which should return a JSON:API document.
As with findAll, the final result after normalization to JSON:API will be added to\nstore via store.push where it will merge with any existing records for type.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
adapter.query is called whenever store.query is called or a previous query result is\nasked to reload.
Existing records for the type will not be removed. The key difference is in the result\nreturned by the store. For findAll the result is all known records of the type,\nwhile for query it will only be the records returned from adapter.query.
adapter.queryRecord takes a request for resource of a given type and should return\n a Promise which fulfills with data for a single resource matching that type.
The response will be fed to the associated serializer's normalizeResponse method\n with the requestType set to queryRecord, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing data for the returned record.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
adapter.createRecord takes a request to create a resource of a given type and should\nreturn a Promise which fulfills with data for the newly created resource.
The response will be fed to the associated serializer's normalizeResponse method\n with the requestType set to createRecord, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing data for the record.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
If the adapter rejects or throws an error the record will enter an error state and the attributes\nthat had attempted to be saved will still be considered dirty.
\nWhen rejecting a createRecord request due to validation issues during save (typically a 422 status code),\nyou may throw an InvalidError.
Throwing an InvalidError makes per-attribute errors available for records to use in the UI as needed.\nRecords can also use this information to mark themselves as being in an invalid state.\nFor more reading see the RecordData Errors RFC
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n let error = new Error(errorMessage);\n\n// these two properties combined\n// alert EmberData to this error being for\n// invalid properties on the record during\n// the request\nerror.isAdapterError = true;\nerror.code = 'InvalidError';\n\n// A JSON:API formatted array of errors\n// See https://jsonapi.org/format/#errors\nerror.errors = [];\n\nthrow error; | \n
adapter.updateRecord takes a request to update a resource of a given type and should\nreturn a Promise which fulfills with the updated data for the resource.
The response will be fed to the associated serializer's normalizeResponse method\n with the requestType set to updateRecord, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing data for the record.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
If the adapter rejects or throws an error the record will enter an error state and the attributes\nthat had attempted to be saved will still be considered dirty.
\nWhen rejecting a createRecord request due to validation issues during save (typically a 422 status code),\nyou may throw an InvalidError.
Throwing an InvalidError makes per-attribute errors available for records to use in the UI as needed.\nRecords can also use this information to mark themselves as being in an invalid state.\nFor more reading see the RecordData Errors RFC
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n let error = new Error(errorMessage);\n\n// these two properties combined\n// alert EmberData to this error being for\n// invalid properties on the record during\n// the request\nerror.isAdapterError = true;\nerror.code = 'InvalidError';\n\n// A JSON:API formatted array of errors\n// See https://jsonapi.org/format/#errors\nerror.errors = [];\n\nthrow error; | \n
adapter.deleteRecord takes a request to delete a resource of a given type and\nshould return a Promise which resolves when that deletion is complete.
Usually the response will be empty, but you may include additional updates in the\nresponse. The response will be fed to the associated serializer's normalizeResponse method\nwith the requestType set to deleteRecord, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing data.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
If the adapter rejects or errors the record will need to be saved again once the reason\nfor the error is addressed in order to persist the deleted state.
\n", + "itemtype": "method", + "name": "deleteRecord", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "The store service that initiated the request being normalized", + "type": "Store" + }, + { + "name": "schema", + "description": "An object with methods for accessing information about\n the type, attributes and relationships of the primary type associated with the request.", + "type": "ModelSchema" + }, + { + "name": "snapshot", + "description": "A Snapshot containing the record's current data", + "type": "Snapshot" + } + ], + "return": { + "description": "" + }, + "class": "MinimumAdapterInterface", + "module": "@ember-data/adapter" + }, + { + "file": "../store/addon/-private/ts-interfaces/minimum-adapter-interface.ts", + "line": 298, + "description": "adapter.findBelongsTo takes a request to fetch a related resource located at a\nrelatedLink and should return a Promise which fulfills with data for a single\n resource.
⚠️ This method is only called if the store previously received relationship information for a resource\ncontaining a related link.
\nIf the cache does not have a link for the relationship then findRecord will be used if a type and id\nfor the related resource is known.
The response will be fed to the associated serializer's normalizeResponse method\n with the requestType set to findBelongsTo, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing data.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
adapter.findHasMany takes a request to fetch a related resource collection located\n at a relatedLink and should return a Promise which fulfills with data for that\n collection.
⚠️ This method is only called if the store previously received relationship information for a resource\ncontaining a related link.
\nIf the cache does not have a link for the relationship but the type and id of\nrelated resources are known then findRecord will be used for each individual related\nresource.
The response will be fed to the associated serializer's normalizeResponse method\n with the requestType set to findHasMany, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing data.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
⚠️ This Method is only called if coalesceFindRequests is true. The array passed to it is determined\nby the adapter's groupRecordsForFindMany method, and will be called once per group returned.
adapter.findMany takes a request to fetch a collection of resources and should return a\nPromise which fulfills with data for that collection.
The response will be fed to the associated serializer's normalizeResponse method\n with the requestType set to findMany, which should return a JSON:API document.
The final result after normalization to JSON:API will be added to store via store.push where\nit will merge with any existing data.
⚠️ If the adapter's response resolves to a false-y value, the associated serializer.normalizeResponse\ncall will NOT be made. In this scenario you may need to do at least a minimum amount of response\nprocessing within the adapter.
See also groupRecordsForFindMany and coalesceFindRequests
This method provides the ability to generate an ID to assign to a new record whenever store.createRecord\nis called if no id was provided.
Alternatively you can pass an id into the call to store.createRecord directly.
1\n2\n | \n let id = generateNewId(type);\nlet newRecord = store.createRecord(type, { id }); | \n
⚠️ This Method is only called if coalesceFindRequests is true.
This method allows for you to split pending requests for records into multiple findMany\nrequests. It receives an array of snapshots where each snapshot represents a unique record\nrequested via store.findRecord during the most recent runloop that was not found in the\ncache or needs to be reloaded. It should return an array of groups.
A group is an array of snapshots meant to be fetched together by a single findMany request.
By default if this method is not implemented EmberData will call findMany once with all\nrequested records as a single group when coalesceFindRequests is true.
See also findMany and coalesceFindRequests
When a record is already available in the store and is requested again via store.findRecord,\nand reload is not specified as an option in the request, this method is called to determine\nwhether the record should be reloaded prior to returning the result.
If reload is specified as an option in the request (true or false) this method will not\nbe called.
1\n | \n store.findRecord('user', '1', { reload: false }) | \n
The default behavior if this method is not implemented and the option is not specified is to\nnot reload, the same as a return of false.
See also the documentation for shouldBackgroundReloadRecord which defaults to true.
When store.findAll(<type>) is called without a reload option, the adapter\nis presented the opportunity to trigger a new request for records of that type.
If reload is specified as an option in the request (true or false) this method will not\nbe called.
1\n | \n store.findAll('user', { reload: false }) | \n
The default behavior if this method is not implemented and the option is not specified is to\nnot reload, the same as a return of false.
Note: the Promise returned by store.findAll resolves to the same RecordArray instance\nreturned by store.peekAll for that type, and will include all records in the store for\nthe given type, including any previously existing records not returned by the reload request.
When a record is already available in the store and is requested again via store.findRecord,\nand the record does not need to be reloaded prior to return, this method provides the ability\nto specify whether a refresh of the data for the reload should be scheduled to occur in the background.
Users may explicitly declare a record should/should not be background reloaded by passing\nbackgroundReload: true or backgroundReload: false as an option to the request respectively.
1\n | \n store.findRecord('user', '1', { backgroundReload: false }) | \n
If the backgroundReload option is not present, this method will be called to determine whether\na backgroundReload should be performed.
The default behavior if this method is not implemented and the option was not specified is to\nbackground reload, the same as a return of true.
When store.findAll(<type>) is called and a reload is not initiated, the adapter\nis presented the opportunity to trigger a new non-blocking (background) request for\nrecords of that type
Users may explicitly declare that this background request should/should not occur by passing\nbackgroundReload: true or backgroundReload: false as an option to the request respectively.
1\n | \n store.findAll('user', { backgroundReload: false }) | \n
The default behavior if this method is not implemented and the option is not specified is to\nperform a reload, the same as a return of true.
In some situations the adapter may need to perform cleanup when destroyed,\nthat cleanup can be done in destroy.
If not implemented, the store does not inform the adapter of destruction.
\n", + "itemtype": "method", + "name": "destroy [OPTIONAL]", + "access": "public", + "tagname": "", + "optional": 1, + "class": "MinimumAdapterInterface", + "module": "@ember-data/adapter" + } + ], + "events": [], + "properties": [ + { + "file": "../store/addon/-private/ts-interfaces/minimum-adapter-interface.ts", + "line": 425, + "description": "If your adapter implements findMany, setting this to true will cause findRecord\nrequests triggered within the same runloop to be coalesced into one or more calls\nto adapter.findMany. The number of calls made and the records contained in each call\ncan be tuned by your adapter's groupRecordsForHasMany method.
Implementing coalescing using this flag and the associated methods does not always offer\nthe right level of correctness, timing control or granularity. If your application would\nbe better suited coalescing across multiple types, coalescing for longer than a single runloop,\nor with a more custom request structure, coalescing within your application adapter may prove\nmore effective.
\n", + "itemtype": "property", + "name": "coalesceFindRequests [OPTIONAL]", + "access": "public", + "tagname": "", + "optional": 1, + "type": "{boolean} true if the requests to find individual records should be coalesced, false otherwise", + "class": "MinimumAdapterInterface", + "module": "@ember-data/adapter" + } + ] + }, + "relationships": { + "parent-class": { + "data": null + }, + "descendants": { + "data": [] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/adapter", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-MinimumSerializerInterface-31366d5385.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-MinimumSerializerInterface-31366d5385.json new file mode 100644 index 000000000..baa41989e --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-MinimumSerializerInterface-31366d5385.json @@ -0,0 +1,211 @@ +{ + "data": { + "id": "ember-data-3.28.13-MinimumSerializerInterface", + "type": "class", + "attributes": { + "name": "MinimumSerializerInterface", + "shortname": "MinimumSerializerInterface", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/serializer", + "namespace": "", + "file": "../store/addon/-private/ts-interfaces/minimum-serializer-interface.ts", + "line": 15, + "description": "The following documentation describes the methods an application\nserializer should implement with descriptions around when an\napplication might expect these methods to be called.
\nMethods that are not required are marked as optional.
\n", + "access": "public", + "tagname": "", + "methods": [ + { + "file": "../store/addon/-private/ts-interfaces/minimum-serializer-interface.ts", + "line": 26, + "description": "This method is responsible for normalizing the value resolved from the promise returned\nby an Adapter request into the format expected by the Store.
The output should be a JSON:API Document\nwith the following additional restrictions:
\ntype should be formatted in the singular dasherized lowercase formmembers (the property names of attributes and relationships) should be formatted\n to match their definition in the corresponding Model definition. Typically this\n will be camelCase.lid is\n a valid optional sibling to id and type in both Resources\n and Resource Identifier ObjectsThis method is responsible for serializing an individual record\nvia a Snapshot into the format expected by the API.
\nThis method is called by snapshot.serialize().
When using Model, this method is called by record.serialize().
When using JSONAPIAdapter or RESTAdapter this method is called\nby updateRecord and createRecord if Serializer.serializeIntoHash\nis not implemented.
This method is intended to normalize data into a JSON:API Document\nwith a data member containing a single Resource.
\ntype should be formatted in the singular, dasherized and lowercase formmembers (the property names of attributes and relationships) should be formatted\n to match their definition in the corresponding Model definition. Typically this\n will be camelCase.lid is\n a valid optional sibling to id and type in both Resources\n and Resource Identifier ObjectsThis method is called by the Store when store.normalize(modelName, payload) is\ncalled. It is recommended to use store.serializerFor(modelName).normalizeResponse\nover store.normalize.
This method may be called when also using the RESTSerializer\nwhen serializer.pushPayload is called by store.pushPayload.\nHowever, it is recommended to use store.push over store.pushPayload after normalizing\nthe payload directly.
Example:
\n1\n2\n3\n4\n5\n6\n7\n | \n function pushPayload(store, modelName, rawPayload) {\n const ModelClass = store.modelFor(modelName);\n const serializer = store.serializerFor(modelName);\n const jsonApiPayload = serializer.normalizeResponse(store, ModelClass, rawPayload, null, 'query');\n\n return store.push(jsonApiPayload);\n} | \n
This method may be called when also using the JSONAPISerializer\nwhen normalizing included records. If mixing serializer usage in this way\nwe recommend implementing this method, but caution that it may lead\nto unexpected mixing of formats.
This method may also be called when normalizing embedded relationships when\nusing the EmbeddedRecordsMixin. If using this mixin in a serializer in\nyour application we recommend implementing this method, but caution that\nit may lead to unexpected mixing of formats.
When using JSONAPIAdapter or RESTAdapter this method is called\nby adapter.updateRecord and adapter.createRecord if serializer.serializeIntoHash\nis implemented. If this method is not implemented, serializer.serialize\nwill be called in this case.
You can use this method to customize the root keys serialized into the payload.\nThe hash property should be modified by reference.
\nFor instance, your API may expect resources to be keyed by underscored type in the payload:
\n1\n2\n3\n4\n5\n6\n | \n {\n _user: {\n type: 'user',\n id: '1'\n }\n} | \n
Which when using these adapters can be achieved by implementing this method similar\nto the following:
\n1\n2\n3\n | \n serializeIntoHash(hash, ModelClass, snapshot, options) {\n hash[`_${snapshot.modelName}`] = this.serialize(snapshot, options).data;\n} | \n
This method allows for normalization of data when store.pushPayload is called\nand should be implemented if you want to use that method.
The method is responsible for pushing new data to the store using store.push\nonce any necessary normalization has occurred, and no data in the store will be\nupdated unless it does so.
The normalized form pushed to the store should be a JSON:API Document\nwith the following additional restrictions:
\ntype should be formatted in the singular, dasherized and lowercase formmembers (the property names of attributes and relationships) should be formatted\n to match their definition in the corresponding Model definition. Typically this\n will be camelCase.lid is\n a valid optional sibling to id and type in both Resources\n and Resource Identifier ObjectsIf you need better control over normalization or want access to the records being added or updated\nin the store, we recommended using store.push over store.pushPayload after normalizing\nthe payload directly. This can even take advantage of an existing serializer for the format\nthe data is in, for example:
1\n2\n3\n4\n5\n6\n7\n | \n function pushPayload(store, modelName, rawPayload) {\n const ModelClass = store.modelFor(modelName);\n const serializer = store.serializerFor(modelName);\n const jsonApiPayload = serializer.normalizeResponse(store, ModelClass, rawPayload, null, 'query');\n\n return store.push(jsonApiPayload);\n} | \n
Base class from which Models can be define.
\n1\n2\n3\n4\n5\n | \n import Model, { attr } from '-data/model';\n\nexport default class User extends Model {\n name;\n} | \n
Create a JSON representation of the record, using the serialization\nstrategy of the store's adapter.
\n serialize takes an optional hash as a parameter, currently\nsupported options are:
includeId: true if the record's ID should be included in the\n JSON representation.Marks the record as deleted but does not save it. You must call\nsave afterwards if you want to persist it. You might use this\nmethod if you want to allow the user to still rollbackAttributes()\nafter a delete was made.
Example
\n| app/controllers/model/delete.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n | \n import Controller from '/controller';\nimport { action } from '/object';\n\nexport default class ModelDeleteController extends Controller {\n \n softDelete() {\n this.model.deleteRecord();\n }\n\n \n confirm() {\n this.model.save();\n }\n\n \n undo() {\n this.model.rollbackAttributes();\n }\n} | \n
Same as deleteRecord, but saves the record immediately.
Example
\n| app/controllers/model/delete.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import Controller from '/controller';\nimport { action } from '/object';\n\nexport default class ModelDeleteController extends Controller {\n \n delete() {\n this.model.destroyRecord().then(function() {\n this.transitionToRoute('model.index');\n });\n }\n} | \n
If you pass an object on the adapterOptions property of the options\nargument it will be passed to your adapter via the snapshot
1\n | \n record.destroyRecord({ adapterOptions: { subscribe: false } }); | \n
| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import MyCustomAdapter from './custom-adapter';\n\nexport default class PostAdapter extends MyCustomAdapter {\n deleteRecord(store, type, snapshot) {\n if (snapshot.adapterOptions.subscribe) {\n // ...\n }\n // ...\n }\n} | \n
Unloads the record from the store. This will not send a delete request\nto your server, it just unloads the record from memory.
\n", + "itemtype": "method", + "name": "unloadRecord", + "access": "public", + "tagname": "", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 850, + "itemtype": "method", + "name": "_notifyProperties", + "access": "private", + "tagname": "", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 867, + "description": "Returns an object, whose keys are changed properties, and value is\nan [oldProp, newProp] array.
\nThe array represents the diff of the canonical state with the local state\nof the model. Note: if the model is created locally, the canonical state is\nempty since the adapter hasn't acknowledged the attributes yet:
\nExample
\n| app/models/mascot.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import Model, { attr } from '-data/model';\n\nexport default class MascotModel extends Model {\n ('string') name;\n ('boolean', {\n defaultValue: false\n })\n isAdmin;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n | \n let mascot = store.createRecord('mascot');\n\nmascot.changedAttributes(); // {}\n\nmascot.set('name', 'Tomster');\nmascot.changedAttributes(); // { name: [undefined, 'Tomster'] }\n\nmascot.set('isAdmin', true);\nmascot.changedAttributes(); // { isAdmin: [undefined, true], name: [undefined, 'Tomster'] }\n\nmascot.save().then(function() {\n mascot.changedAttributes(); // {}\n\n mascot.set('isAdmin', false);\n mascot.changedAttributes(); // { isAdmin: [true, false] }\n}); | \n
If the model hasDirtyAttributes this function will discard any unsaved\nchanges. If the model isNew it will be removed from the store.
Example
\n1\n2\n3\n4\n5\n | \n record.get('name'); // 'Untitled Document'\nrecord.set('name', 'Doc 1');\nrecord.get('name'); // 'Doc 1'\nrecord.rollbackAttributes();\nrecord.get('name'); // 'Untitled Document' | \n
Save the record and persist any changes to the record to an\nexternal source via the adapter.
\nExample
\n1\n2\n3\n4\n5\n6\n | \n record.set('name', 'Tomster');\nrecord.save().then(function() {\n // Success callback\n}, function() {\n // Error callback\n}); | \n
If you pass an object using the adapterOptions property of the options\n argument it will be passed to your adapter via the snapshot.
1\n | \n record.save({ adapterOptions: { subscribe: false } }); | \n
| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import MyCustomAdapter from './custom-adapter';\n\nexport default class PostAdapter extends MyCustomAdapter {\n updateRecord(store, type, snapshot) {\n if (snapshot.adapterOptions.subscribe) {\n // ...\n }\n // ...\n }\n} | \n
Reload the record from the adapter.
\nThis will only work if the record has already finished loading.
\nExample
\n| app/controllers/model/view.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import Controller from '/controller';\nimport { action } from '/object';\n\nexport default class ViewController extends Controller {\n \n reload() {\n this.model.reload().then(function(model) {\n // do something with the reloaded model\n });\n }\n} | \n
Get the reference for the specified belongsTo relationship.
\nExample
\n| app/models/blog.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { belongsTo } from '-data/model';\n\nexport default class BlogModel extends Model {\n ({ async: true }) user;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n34\n35\n36\n37\n38\n39\n40\n41\n42\n | \n let blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n data: { type: 'user', id: 1 }\n }\n }\n }\n});\nlet userRef = blog.belongsTo('user');\n\n// check if the user relationship is loaded\nlet isLoaded = userRef.value() !== null;\n\n// get the record of the reference (null if not yet available)\nlet user = userRef.value();\n\n// get the identifier of the reference\nif (userRef.remoteType() === "id") {\n let id = userRef.id();\n} else if (userRef.remoteType() === "link") {\n let link = userRef.link();\n}\n\n// load user (via store.findRecord or store.findBelongsTo)\nuserRef.load().then(...)\n\n// or trigger a reload\nuserRef.reload().then(...)\n\n// provide data for reference\nuserRef.push({\n type: 'user',\n id: 1,\n attributes: {\n username: "@user"\n }\n}).then(function(user) {\n userRef.value() === user;\n}); | \n
Get the reference for the specified hasMany relationship.
\nExample
\n| app/models/blog.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n34\n35\n36\n37\n38\n39\n40\n41\n42\n43\n44\n45\n | \n import Model, { hasMany } from '@ember-data/model';\n\nexport default class BlogModel extends Model {\n @hasMany({ async: true }) comments;\n}\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n comments: {\n data: [\n { type: 'comment', id: 1 },\n { type: 'comment', id: 2 }\n ]\n }\n }\n }\n});\nlet commentsRef = blog.hasMany('comments');\n\n// check if the comments are loaded already\nlet isLoaded = commentsRef.value() !== null;\n\n// get the records of the reference (null if not yet available)\nlet comments = commentsRef.value();\n\n// get the identifier of the reference\nif (commentsRef.remoteType() === "ids") {\n let ids = commentsRef.ids();\n} else if (commentsRef.remoteType() === "link") {\n let link = commentsRef.link();\n}\n\n// load comments (via store.findMany or store.findHasMany)\ncommentsRef.load().then(...)\n\n// or trigger a reload\ncommentsRef.reload().then(...)\n\n// provide data for reference\ncommentsRef.push([{ type: 'comment', id: 1 }, { type: 'comment', id: 2 }]).then(function(comments) {\n commentsRef.value() === comments;\n}); | \n
Given a callback, iterates over each of the relationships in the model,\ninvoking the callback with the name of each relationship and its relationship\ndescriptor.
\nThe callback method you provide should have the following signature (all\nparameters are optional):
\n1\n | \n function(name, descriptor); | \n
name the name of the current property in the iterationdescriptor the meta object that describes this relationshipThe relationship descriptor argument is an object with the following properties.
\nNote that in addition to a callback, you can also pass an optional target\nobject that will be set as this on the context.
Example
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n | \n import JSONSerializer from '@ember-data/serializer/json';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n serialize(record, options) {\n let json = {};\n\n record.eachRelationship(function(name, descriptor) {\n if (descriptor.kind === 'hasMany') {\n let serializedHasManyName = name.toUpperCase() + '_IDS';\n json[serializedHasManyName] = record.get(name).mapBy('id');\n }\n });\n\n return json;\n }\n } | \n
Create should only ever be called by the store. To create an instance of a\nModel in a dirty state use store.createRecord.
To create instances of Model in a clean state, use store.push
For a given relationship name, returns the model type of the relationship.
\nFor example, if you define a model like this:
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ('comment') comments;\n} | \n
Calling store.modelFor('post').typeForRelationship('comments', store) will return Comment.
Find the relationship which is the inverse of the one asked for.
\nFor example, if you define models like this:
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '-data/model';\n\nexport default class PostModel extends Model {\n ('message') comments;\n } | \n
| app/models/message.js | \n|
1\n2\n3\n4\n5\n6\n | \n import Model from '-data/model';\nimport { belongsTo } from '-decorators/data';\n\nexport default class MessageModel extends Model {\n ('post') owner;\n } | \n
1\n2\n | \n store.modelFor('post').inverseFor('comments', store) // { type: App.Message, name: 'owner', kind: 'belongsTo' }\nstore.modelFor('message').inverseFor('owner', store) // { type: App.Post, name: 'comments', kind: 'hasMany' } | \n
Given a callback, iterates over each of the relationships in the model,\ninvoking the callback with the name of each relationship and its relationship\ndescriptor.
\n", + "itemtype": "method", + "name": "eachRelationship", + "access": "public", + "tagname": "", + "static": 1, + "params": [ + { + "name": "callback", + "description": "the callback to invoke", + "type": "Function" + }, + { + "name": "binding", + "description": "the value to which the callback's `this` should be bound", + "type": "Any" + } + ], + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 1812, + "description": "Given a callback, iterates over each of the types related to a model,\ninvoking the callback with the related type's class. Each type will be\nreturned just once, regardless of how many different relationships it has\nwith a model.
\n", + "itemtype": "method", + "name": "eachRelatedType", + "access": "public", + "tagname": "", + "static": 1, + "params": [ + { + "name": "callback", + "description": "the callback to invoke", + "type": "Function" + }, + { + "name": "binding", + "description": "the value to which the callback's `this` should be bound", + "type": "Any" + } + ], + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 1965, + "description": "Iterates through the attributes of the model, calling the passed function on each\nattribute.
\nThe callback method you provide should have the following signature (all\nparameters are optional):
\n1\n | \n function(name, meta); | \n
name the name of the current property in the iterationmeta the meta object for the attribute property in the iterationNote that in addition to a callback, you can also pass an optional target\nobject that will be set as this on the context.
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n | \n import Model, { attr } from '@ember-data/model';\n\nclass PersonModel extends Model {\n @attr('string') firstName;\n @attr('string') lastName;\n @attr('date') birthday;\n }\n\nPersonModel.eachAttribute(function(name, meta) {\n console.log(name, meta);\n });\n\n// prints:\n// firstName {type: "string", isAttribute: true, options: Object, parentType: function, name: "firstName"}\n// lastName {type: "string", isAttribute: true, options: Object, parentType: function, name: "lastName"}\n// birthday {type: "date", isAttribute: true, options: Object, parentType: function, name: "birthday"} | \n
Iterates through the transformedAttributes of the model, calling\nthe passed function on each attribute. Note the callback will not be\ncalled for any attributes that do not have an transformation type.
\nThe callback method you provide should have the following signature (all\nparameters are optional):
\n1\n | \n function(name, type); | \n
name the name of the current property in the iterationtype a string containing the name of the type of transformed\napplied to the attributeNote that in addition to a callback, you can also pass an optional target\nobject that will be set as this on the context.
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Model, { attr } from '@ember-data/model';\n\nlet Person = Model.extend({\n firstName: attr(),\n lastName: attr('string'),\n birthday: attr('date')\n });\n\nPerson.eachTransformedAttribute(function(name, type) {\n console.log(name, type);\n });\n\n// prints:\n// lastName string\n// birthday date | \n
Returns the name of the model class.
\n", + "itemtype": "method", + "name": "toString", + "access": "public", + "tagname": "", + "static": 1, + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 2085, + "description": "Provides info about the model for debugging purposes\nby grouping the properties into more semantic groups.
\nMeant to be used by debugging tools such as the Chrome Ember Extension.
\nOverride the default event firing from Ember.Evented to\nalso call methods with the given name.
\n", + "itemtype": "method", + "name": "trigger", + "access": "private", + "tagname": "", + "params": [ + { + "name": "name", + "description": "", + "type": "String" + } + ], + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 2181, + "description": "Use JSONSerializer to\nget the JSON representation of a record.
\ntoJSON takes an optional hash as a parameter, currently\nsupported options are:
includeId: true if the record's ID should be included in the\nJSON representation.Fired when the record is ready to be interacted with,\nthat is either loaded from the server or created locally.
\n", + "deprecated": true, + "access": "public", + "tagname": "", + "itemtype": "event", + "name": "ready", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 643, + "description": "Fired when the record is loaded from the server.
\n", + "deprecated": true, + "access": "public", + "tagname": "", + "itemtype": "event", + "name": "didLoad", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 651, + "description": "Fired when the record is updated.
\n", + "deprecated": true, + "access": "public", + "tagname": "", + "itemtype": "event", + "name": "didUpdate", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 659, + "description": "Fired when a new record is commited to the server.
\n", + "deprecated": true, + "access": "public", + "tagname": "", + "itemtype": "event", + "name": "didCreate", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 667, + "description": "Fired when the record is deleted.
\n", + "deprecated": true, + "access": "public", + "tagname": "", + "itemtype": "event", + "name": "didDelete", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 675, + "description": "Fired when the record becomes invalid.
\n", + "deprecated": true, + "access": "public", + "tagname": "", + "itemtype": "event", + "name": "becameInvalid", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 683, + "description": "Fired when the record enters the error state.
\n", + "deprecated": true, + "access": "public", + "tagname": "", + "itemtype": "event", + "name": "becameError", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 691, + "description": "Fired when the record is rolled back.
\n", + "deprecated": true, + "access": "public", + "tagname": "", + "itemtype": "event", + "name": "rolledBack", + "class": "Model", + "module": "@ember-data/model" + } + ], + "properties": [ + { + "file": "../model/addon/-private/model.js", + "line": 141, + "description": "If this property is true the record is in the empty\nstate. Empty is the first state all records enter after they have\nbeen created. Most records created by the store will quickly\ntransition to the loading state if data needs to be fetched from\nthe server or the created state if the record is created on the\nclient. A record can also enter the empty state if the adapter is\nunable to locate the record.
If this property is true the record is in the loading state. A\nrecord enters this state when the store asks the adapter for its\ndata. It remains in this state until the adapter provides the\nrequested data.
If this property is true the record is in the loaded state. A\nrecord enters this state when its data is populated. Most of a\nrecord's lifecycle is spent inside substates of the loaded\nstate.
Example
\n1\n2\n3\n4\n5\n6\n | \n let record = store.createRecord('model');\nrecord.get('isLoaded'); // true\n\nstore.findRecord('model', 1).then(function(model) {\n model.get('isLoaded'); // true\n}); | \n
If this property is true the record is in the dirty state. The\nrecord has local changes that have not yet been saved by the\nadapter. This includes records that have been created (but not yet\nsaved) or deleted.
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n | \n let record = store.createRecord('model');\nrecord.get('hasDirtyAttributes'); // true\n\nstore.findRecord('model', 1).then(function(model) {\n model.get('hasDirtyAttributes'); // false\n model.set('foo', 'some value');\n model.get('hasDirtyAttributes'); // true\n}); | \n
If this property is true the record is in the saving state. A\nrecord enters the saving state when save is called, but the\nadapter has not yet acknowledged that the changes have been\npersisted to the backend.
Example
\n1\n2\n3\n4\n5\n6\n7\n | \n let record = store.createRecord('model');\nrecord.get('isSaving'); // false\nlet promise = record.save();\nrecord.get('isSaving'); // true\npromise.then(function() {\n record.get('isSaving'); // false\n}); | \n
If this property is true the record is in the deleted state\nand has been marked for deletion. When isDeleted is true and\nhasDirtyAttributes is true, the record is deleted locally but the deletion\nwas not yet persisted. When isSaving is true, the change is\nin-flight. When both hasDirtyAttributes and isSaving are false, the\nchange has persisted.
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n | \n let record = store.createRecord('model');\nrecord.get('isDeleted'); // false\nrecord.deleteRecord();\n\n// Locally deleted\nrecord.get('isDeleted'); // true\nrecord.get('hasDirtyAttributes'); // true\nrecord.get('isSaving'); // false\n\n// Persisting the deletion\nlet promise = record.save();\nrecord.get('isDeleted'); // true\nrecord.get('isSaving'); // true\n\n// Deletion Persisted\npromise.then(function() {\n record.get('isDeleted'); // true\n record.get('isSaving'); // false\n record.get('hasDirtyAttributes'); // false\n}); | \n
If this property is true the record is in the new state. A\nrecord will be in the new state when it has been created on the\nclient and the adapter has not yet report that it was successfully\nsaved.
Example
\n1\n2\n3\n4\n5\n6\n | \n let record = store.createRecord('model');\nrecord.get('isNew'); // true\n\nrecord.save().then(function(model) {\n model.get('isNew'); // false\n}); | \n
If this property is true the record is in the valid state.
A record will be in the valid state when the adapter did not report any\nserver-side validation failures.
If the record is in the dirty state this property will report what\nkind of change has caused it to move into the dirty\nstate. Possible values are:
\ncreated The record has been created by the client and not yet saved to the adapter.updated The record has been updated by the client and not yet saved to the adapter.deleted The record has been deleted by the client and not yet saved to the adapter.Example
\n1\n2\n | \n let record = store.createRecord('model');\nrecord.get('dirtyType'); // 'created' | \n
If true the adapter reported that it was unable to save local\nchanges to the backend for any reason other than a server-side\nvalidation error.
Example
\n1\n2\n3\n4\n5\n | \n record.get('isError'); // false\nrecord.set('foo', 'valid value');\nrecord.save().then(null, function() {\n record.get('isError'); // true\n}); | \n
If true the store is attempting to reload the record from the adapter.
Example
\n1\n2\n3\n | \n record.get('isReloading'); // false\nrecord.reload();\nrecord.get('isReloading'); // true | \n
All ember models have an id property. This is an identifier\nmanaged by an external source. These are always coerced to be\nstrings before being used internally. Note when declaring the\nattributes for a model it is an error to declare an id\nattribute.
\n1\n2\n3\n4\n5\n6\n | \n let record = store.createRecord('model');\nrecord.get('id'); // null\n\nstore.findRecord('model', 1).then(function(model) {\n model.get('id'); // '1'\n}); | \n
The store service instance which created this record instance
\n", + "itemtype": "property", + "name": "store", + "access": "public", + "tagname": "", + "class": "Model", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/model.js", + "line": 504, + "description": "When the record is in the invalid state this object will contain\nany errors returned by the adapter. When present the errors hash\ncontains keys corresponding to the invalid property names\nand values which are arrays of Javascript objects with two keys:
message A string containing the error message from the backendattribute The name of the property associated with this error message1\n2\n3\n4\n5\n6\n | \n record.get('errors.length'); // 0\nrecord.set('foo', 'invalid value');\nrecord.save().catch(function() {\n record.get('errors').get('foo');\n // [{message: 'foo should be a number.', attribute: 'foo'}]\n}); | \n
The errors property is useful for displaying error messages to\nthe user.
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n <label>Username: <Input @value={{@model.username}} /> </label>\n{{#each @model.errors.username as |error|}}\n <div class="error">\n {{error.message}}\n </div>\n{{/each}}\n<label>Email: <Input @value={{@model.email}} /> </label>\n{{#each @model.errors.email as |error|}}\n <div class="error">\n {{error.message}}\n </div>\n{{/each}} | \n
You can also access the special messages property on the error\nobject to get an array of all the error strings.
1\n2\n3\n4\n5\n | \n {{#each @model.errors.messages as |message|}}\n <div class="error">\n {{message}}\n </div>\n{{/each}} | \n
This property holds the AdapterError object with which\nlast adapter operation was rejected.
Represents the model's class name as a string. This can be used to look up the model's class name through\nStore's modelFor method.
modelName is generated for you by Ember Data. It will be a lowercased, dasherized string.\nFor example:
1\n2\n | \n store.modelFor('post').modelName; // 'post'\nstore.modelFor('blog-post').modelName; // 'blog-post' | \n
The most common place you'll want to access modelName is in your serializer's payloadKeyFromModelName method. For example, to change payload\nkeys to underscore (instead of dasherized), you might use the following code:
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTSerializer from '@ember-data/serializer/rest';\nimport { underscore } from '@ember/string';\n\nexport default const PostSerializer = RESTSerializer.extend({\n payloadKeyFromModelName(modelName) {\n return underscore(modelName);\n }\n}); | \n
The model's relationships as a map, keyed on the type of the\nrelationship. The value of each entry is an array containing a descriptor\nfor each relationship with that type, describing the name of the relationship\nas well as the type.
\nFor example, given the following model definition:
\n| app/models/blog.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { belongsTo, hasMany } from '-data/model';\n\nexport default class BlogModel extends Model {\n ('user') users;\n ('user') owner;\n ('post') posts;\n } | \n
This computed property would return a map describing these\nrelationships, like this:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import { get } from '@ember/object';\nimport Blog from 'app/models/blog';\nimport User from 'app/models/user';\nimport Post from 'app/models/post';\n\nlet relationships = Blog.relationships;\nrelationships.get('user');\n//=> [ { name: 'users', kind: 'hasMany' },\n// { name: 'owner', kind: 'belongsTo' } ]\nrelationships.get('post');\n//=> [ { name: 'posts', kind: 'hasMany' } ] | \n
A hash containing lists of the model's relationships, grouped\nby the relationship kind. For example, given a model with this\ndefinition:
\n| app/models/blog.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { belongsTo, hasMany } from '-data/model';\n\nexport default class BlogModel extends Model {\n ('user') users;\n ('user') owner;\n\n ('post') posts;\n } | \n
This property would contain the following:
\n1\n2\n3\n4\n5\n6\n7\n8\n | \n import { get } from '@ember/object';\nimport Blog from 'app/models/blog';\n\nlet relationshipNames = Blog.relationshipNames;\nrelationshipNames.hasMany;\n//=> ['users', 'posts']\nrelationshipNames.belongsTo;\n//=> ['owner'] | \n
An array of types directly related to a model. Each type will be\nincluded once, regardless of the number of relationships it has with\nthe model.
\nFor example, given a model with this definition:
\n| app/models/blog.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { belongsTo, hasMany } from '-data/model';\n\nexport default class BlogModel extends Model {\n ('user') users;\n ('user') owner;\n\n ('post') posts;\n } | \n
This property would contain the following:
\n1\n2\n3\n4\n5\n | \n import { get } from '@ember/object';\nimport Blog from 'app/models/blog';\n\nlet relatedTypes = Blog.relatedTypes');\n//=> [ User, Post ] | \n
A map whose keys are the relationships of a model and whose values are\nrelationship descriptors.
\nFor example, given a model with this\ndefinition:
\n| app/models/blog.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { belongsTo, hasMany } from '-data/model';\n\nexport default class BlogModel extends Model {\n ('user') users;\n ('user') owner;\n\n ('post') posts;\n } | \n
This property would contain the following:
\n1\n2\n3\n4\n5\n6\n7\n8\n | \n import { get } from '@ember/object';\nimport Blog from 'app/models/blog';\n\nlet relationshipsByName = Blog.relationshipsByName;\nrelationshipsByName.get('users');\n//=> { key: 'users', kind: 'hasMany', type: 'user', options: Object, isRelationship: true }\nrelationshipsByName.get('owner');\n//=> { key: 'owner', kind: 'belongsTo', type: 'user', options: Object, isRelationship: true } | \n
A map whose keys are the fields of the model and whose values are strings\ndescribing the kind of the field. A model's fields are the union of all of its\nattributes and relationships.
\nFor example:
\n| app/models/blog.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import Model, { attr, belongsTo, hasMany } from '-data/model';\n\nexport default class BlogModel extends Model {\n ('user') users;\n ('user') owner;\n\n ('post') posts;\n\n ('string') title;\n } | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import { get } from '@ember/object';\nimport Blog from 'app/models/blog'\n\nlet fields = Blog.fields;\nfields.forEach(function(kind, field) {\n console.log(field, kind);\n });\n\n// prints:\n// users, hasMany\n// owner, belongsTo\n// posts, hasMany\n// title, attribute | \n
A map whose keys are the attributes of the model (properties\ndescribed by attr) and whose values are the meta object for the\nproperty.
\nExample
\n| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr } from '-data/model';\n\nexport default class PersonModel extends Model {\n ('string') firstName;\n ('string') lastName;\n ('date') birthday;\n } | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import { get } from '@ember/object';\nimport Blog from 'app/models/blog'\n\nlet attributes = Person.attributes\n\nattributes.forEach(function(meta, name) {\n console.log(name, meta);\n });\n\n// prints:\n// firstName {type: "string", isAttribute: true, options: Object, parentType: function, name: "firstName"}\n// lastName {type: "string", isAttribute: true, options: Object, parentType: function, name: "lastName"}\n// birthday {type: "date", isAttribute: true, options: Object, parentType: function, name: "birthday"} | \n
A map whose keys are the attributes of the model (properties\ndescribed by attr) and whose values are type of transformation\napplied to each attribute. This map does not include any\nattributes that do not have an transformation type.
\nExample
\n| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr } from '-data/model';\n\nexport default class PersonModel extends Model {\n firstName;\n ('string') lastName;\n ('date') birthday;\n } | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import { get } from '@ember/object';\nimport Person from 'app/models/person';\n\nlet transformedAttributes = Person.transformedAttributes\n\ntransformedAttributes.forEach(function(field, type) {\n console.log(field, type);\n });\n\n// prints:\n// lastName string\n// birthday date | \n
A NotFoundError equates to a HTTP 404 Not Found response status.\nIt is used by an adapter to signal that a request to the external API\nwas rejected because the resource could not be found on the API.
An example use case would be to detect if the user has entered a route\nfor a specific model that does not exist. For example:
\n| app/routes/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n | \n import Route from '@ember/routing/route';\nimport { NotFoundError } from '@ember-data/adapter/error';\nimport { inject as service } from '@ember/service';\nimport { action } from '@ember/object';\n\nexport default class PostRoute extends Route {\n store;\n model(params) {\n return this.get('store').findRecord('post', params.post_id);\n }\n \n error(error, transition) {\n if (error instanceof NotFoundError) {\n // redirect to a list of all posts instead\n this.transitionTo('posts');\n } else {\n // otherwise let the error bubble\n return true;\n }\n }\n} | \n
The NumberTransform class is used to serialize and deserialize\nnumeric attributes on Ember Data record objects. This transform is\nused when number is passed as the type parameter to the\nattr function.
Usage
\n| app/models/score.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class ScoreModel extends Model {\n ('number') value;\n ('player') player;\n ('date') date;\n} | \n
When given a deserialized value from a record attribute this\nmethod must return the serialized value.
\nExample
\n1\n2\n3\n4\n5\n | \n import { isEmpty } from '@ember/utils';\n\nserialize(deserialized, options) {\n return isEmpty(deserialized) ? null : Number(deserialized);\n} | \n
When given a serialized value from a JSON object this method must\nreturn the deserialized value for the record attribute.
\nExample
\n1\n2\n3\n | \n deserialize(serialized, options) {\n return empty(serialized) ? null : Number(serialized);\n} | \n
This class is returned as the result of accessing an async hasMany relationship\non an instance of a Model extending from @ember-data/model.
A PromiseManyArray is an array-like proxy that also proxies certain method calls\nto the underlying ManyArray in addition to being "promisified".
\nRight now we proxy:
\nreload()createRecord()This promise-proxy behavior is primarily to ensure that async relationship interact\nnicely with templates. In your JS code you should resolve the promise first.
\n1\n | \n const comments = await post.comments; | \n
Iterate the proxied content. Called by the glimmer iterator in #each
\n", + "itemtype": "method", + "name": "forEach", + "params": [ + { + "name": "cb", + "description": "" + } + ], + "return": { + "description": "" + }, + "access": "private", + "tagname": "", + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 127, + "description": "chain this promise
\n", + "itemtype": "method", + "name": "then", + "access": "public", + "tagname": "", + "params": [ + { + "name": "success", + "description": "" + }, + { + "name": "fail", + "description": "" + } + ], + "return": { + "description": "Promise" + }, + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 140, + "description": "catch errors thrown by this promise
\n", + "itemtype": "method", + "name": "catch", + "access": "public", + "tagname": "", + "params": [ + { + "name": "callback", + "description": "" + } + ], + "return": { + "description": "Promise" + }, + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 151, + "description": "run cleanup after this promise completes
\n", + "itemtype": "method", + "name": "finally", + "access": "public", + "tagname": "", + "params": [ + { + "name": "callback", + "description": "" + } + ], + "return": { + "description": "Promise" + }, + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 194, + "description": "Reload the relationship
\n", + "itemtype": "method", + "name": "reload", + "access": "public", + "tagname": "", + "params": [ + { + "name": "options", + "description": "" + } + ], + "return": { + "description": "" + }, + "class": "PromiseManyArray", + "module": "@ember-data/model" + } + ], + "events": [], + "properties": [ + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 59, + "description": "Retrieve the length of the content
\n", + "itemtype": "property", + "name": "length", + "access": "public", + "tagname": "", + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 98, + "description": "Whether the loading promise is still pending
\n", + "itemtype": "property", + "name": "isPending", + "type": "Boolean", + "access": "public", + "tagname": "", + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 105, + "description": "Whether the loading promise rejected
\n", + "itemtype": "property", + "name": "isRejected", + "type": "Boolean", + "access": "public", + "tagname": "", + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 112, + "description": "Whether the loading promise succeeded
\n", + "itemtype": "property", + "name": "isFulfilled", + "type": "Boolean", + "access": "public", + "tagname": "", + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 119, + "description": "Whether the loading promise completed (resolved or rejected)
\n", + "itemtype": "property", + "name": "isSettled", + "type": "Boolean", + "access": "public", + "tagname": "", + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 174, + "description": "Retrieve the links for this relationship
\n", + "itemtype": "property", + "name": "links", + "access": "public", + "tagname": "", + "class": "PromiseManyArray", + "module": "@ember-data/model" + }, + { + "file": "../model/addon/-private/system/promise-many-array.ts", + "line": 184, + "description": "Retrieve the meta for this relationship
\n", + "itemtype": "property", + "name": "meta", + "access": "public", + "tagname": "", + "class": "PromiseManyArray", + "module": "@ember-data/model" + } + ] + }, + "relationships": { + "parent-class": { + "data": null + }, + "descendants": { + "data": [] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/model", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-RESTAdapter-b5df0eb287.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-RESTAdapter-b5df0eb287.json new file mode 100644 index 000000000..be0bc0327 --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-RESTAdapter-b5df0eb287.json @@ -0,0 +1,1815 @@ +{ + "data": { + "id": "ember-data-3.28.13-RESTAdapter", + "type": "class", + "attributes": { + "name": "RESTAdapter", + "shortname": "RESTAdapter", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/adapter/rest", + "namespace": "", + "file": "../adapter/addon/rest.ts", + "line": 79, + "description": "The REST adapter allows your store to communicate with an HTTP server by\ntransmitting JSON via XHR. Most Ember.js apps that consume a JSON API\nshould use the REST adapter.
\nThis adapter is designed around the idea that the JSON exchanged with\nthe server should be conventional.
\nThe REST adapter will consider a success any response with a status code\nof the 2xx family ("Success"), as well as 304 ("Not Modified"). Any other\nstatus code will be considered a failure.
\nOn success, the request promise will be resolved with the full response\npayload.
\nFailed responses with status code 422 ("Unprocessable Entity") will be\nconsidered "invalid". The response will be discarded, except for the\nerrors key. The request promise will be rejected with a InvalidError.\nThis error object will encapsulate the saved errors value.
Any other status codes will be treated as an "adapter error". The request\npromise will be rejected, similarly to the "invalid" case, but with\nan instance of AdapterError instead.
The REST adapter expects the JSON returned from your server to follow\nthese conventions.
\nThe JSON payload should be an object that contains the record inside a\nroot property. For example, in response to a GET request for\n/posts/1, the JSON should look like this:
1\n2\n3\n4\n5\n6\n7\n | \n {\n "posts": {\n "id": 1,\n "title": "I'm Running to Reform the W3C's Tag",\n "author": "Yehuda Katz"\n }\n} | \n
Similarly, in response to a GET request for /posts, the JSON should\nlook like this:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n {\n "posts": [\n {\n "id": 1,\n "title": "I'm Running to Reform the W3C's Tag",\n "author": "Yehuda Katz"\n },\n {\n "id": 2,\n "title": "Rails is omakase",\n "author": "D2H"\n }\n ]\n} | \n
Note that the object root can be pluralized for both a single-object response\nand an array response: the REST adapter is not strict on this. Further, if the\nHTTP server responds to a GET request to /posts/1 (e.g. the response to a\nfindRecord query) with more than one object in the array, Ember Data will\nonly display the object with the matching ID.
Attribute names in your JSON payload should be the camelCased versions of\nthe attributes in your Ember.js models.
\nFor example, if you have a Person model:
| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr } from '@ember-data/model';\n\nexport default Model.extend({\n firstName: attr('string'),\n lastName: attr('string'),\n occupation: attr('string')\n}); | \n
The JSON returned should look like this:
\n1\n2\n3\n4\n5\n6\n7\n8\n | \n {\n "people": {\n "id": 5,\n "firstName": "Zaphod",\n "lastName": "Beeblebrox",\n "occupation": "President"\n }\n} | \n
Relationships are usually represented by ids to the record in the\nrelationship. The related records can then be sideloaded in the\nresponse under a key for the type.
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n {\n "posts": {\n "id": 5,\n "title": "I'm Running to Reform the W3C's Tag",\n "author": "Yehuda Katz",\n "comments": [1, 2]\n },\n "comments": [{\n "id": 1,\n "author": "User 1",\n "message": "First!",\n }, {\n "id": 2,\n "author": "User 2",\n "message": "Good Luck!",\n }]\n} | \n
If the records in the relationship are not known when the response\nis serialized it's also possible to represent the relationship as a\nURL using the links key in the response. Ember Data will fetch\nthis URL to resolve the relationship when it is accessed for the\nfirst time.
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n {\n "posts": {\n "id": 5,\n "title": "I'm Running to Reform the W3C's Tag",\n "author": "Yehuda Katz",\n "links": {\n "comments": "/posts/5/comments"\n }\n }\n} | \n
If a response is considered a failure, the JSON payload is expected to include\na top-level key errors, detailing any specific issues. For example:
1\n2\n3\n4\n5\n | \n {\n "errors": {\n "msg": "Something went wrong"\n }\n} | \n
This adapter does not make any assumptions as to the format of the errors\nobject. It will simply be passed along as is, wrapped in an instance\nof InvalidError or AdapterError. The serializer can interpret it\nafterwards.
Endpoint paths can be prefixed with a namespace by setting the namespace\nproperty on the adapter:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n namespace = 'api/1';\n} | \n
Requests for the Person model would now target /api/1/people/1.
An adapter can target other hosts by setting the host property.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n host = 'https://api.example.com';\n} | \n
Some APIs require HTTP headers, e.g. to provide an API key. Arbitrary\nheaders can be set as key/value pairs on the RESTAdapter's headers\nobject and Ember Data will send them along with each ajax request.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { computed } from '/object';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n headers: computed(function() {\n return {\n 'API_KEY': 'secret key',\n 'ANOTHER_HEADER': 'Some header value'\n };\n }\n} | \n
headers can also be used as a computed property to support dynamic\nheaders. In the example below, the session object has been\ninjected into an adapter by Ember's container.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { computed } from '/object';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n headers: computed('session.authToken', function() {\n return {\n 'API_KEY': this.get('session.authToken'),\n 'ANOTHER_HEADER': 'Some header value'\n };\n })\n} | \n
In some cases, your dynamic headers may require data from some\nobject outside of Ember's observer system (for example\ndocument.cookie). You can use the\nvolatile\nfunction to set the property into a non-cached mode causing the headers to\nbe recomputed with every request.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { get } from '/object';\nimport { computed } from '/object';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n headers: computed(function() {\n return {\n 'API_KEY': get(document.cookie.match(/apiKey\\=([^;]*)/), '1'),\n 'ANOTHER_HEADER': 'Some header value'\n };\n }).volatile()\n} | \n
@mainName @ember-data/adapter/rest\n @tag main
\n", + "_main": true, + "access": "public", + "tagname": "", + "is_constructor": 1, + "extends": "Adapter", + "uses": [ + "BuildURLMixin" + ], + "methods": [ + { + "file": "../adapter/addon/rest.ts", + "line": 374, + "description": "By default, the RESTAdapter will send the query params sorted alphabetically to the\nserver.
\nFor example:
\n1\n | \n store.query('posts', { sort: 'price', category: 'pets' }); | \n
will generate a requests like this /posts?category=pets&sort=price, even if the\nparameters were specified in a different order.
That way the generated URL will be deterministic and that simplifies caching mechanisms\nin the backend.
\nSetting sortQueryParams to a falsey value will respect the original order.
In case you want to sort the query parameters with a different criteria, set\nsortQueryParams to your custom sort function.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n sortQueryParams(params) {\n let sortedKeys = Object.keys(params).sort().reverse();\n let len = sortedKeys.length, newParams = {};\n\n for (let i = 0; i < len; i++) {\n newParams[sortedKeys[i]] = params[sortedKeys[i]];\n }\n\n return newParams;\n }\n} | \n
Called by the store in order to fetch the JSON for a given\ntype and ID.
\nThe findRecord method makes an Ajax request to a URL computed by\nbuildURL, 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.
Called by the store in order to fetch a JSON array for all\nof the records for a given type.
\nThe findAll method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a\npromise for the resulting payload.
Called by the store in order to fetch a JSON array for\nthe records that match a particular query.
\nThe query method makes an Ajax (HTTP GET) request to a URL\ncomputed by buildURL, and returns a promise for the resulting\npayload.
The query argument is a simple JavaScript object that will be passed directly\nto the server as parameters.
Called by the store in order to fetch a JSON object for\nthe record that matches a particular query.
\nThe queryRecord method makes an Ajax (HTTP GET) request to a URL\ncomputed by buildURL, and returns a promise for the resulting\npayload.
The query argument is a simple JavaScript object that will be passed directly\nto the server as parameters.
Called by the store in order to fetch several records together if coalesceFindRequests is true
For example, if the original payload looks like:
\n1\n2\n3\n4\n5\n | \n {\n "id": 1,\n "title": "Rails is omakase",\n "comments": [ 1, 2, 3 ]\n} | \n
The IDs will be passed as a URL-encoded Array of IDs, in this form:
\n1\n | \n ids[]=1&ids[]=2&ids[]=3 | \n
Many servers, such as Rails and PHP, will automatically convert this URL-encoded array\ninto an Array for you on the server-side. If you want to encode the\nIDs, differently, just override this (one-line) method.
\nThe findMany method makes an Ajax (HTTP GET) request to a URL computed by buildURL, and returns a\npromise for the resulting payload.
Called by the store in order to fetch a JSON array for\nthe unloaded records in a has-many relationship that were originally\nspecified as a URL (inside of links).
For example, if your original payload looks like this:
\n1\n2\n3\n4\n5\n6\n7\n | \n {\n "post": {\n "id": 1,\n "title": "Rails is omakase",\n "links": { "comments": "/posts/1/comments" }\n }\n} | \n
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.
Called by the store in order to fetch the JSON for the unloaded record in a\nbelongs-to relationship that was originally specified as a URL (inside of\nlinks).
For example, if your original payload looks like this:
\n1\n2\n3\n4\n5\n6\n7\n | \n {\n "person": {\n "id": 1,\n "name": "Tom Dale",\n "links": { "group": "/people/1/group" }\n }\n} | \n
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.
Called by the store when a newly created record is\nsaved via the save method on a model record instance.
The createRecord method serializes the record and makes an Ajax (HTTP POST) request\nto a URL computed by buildURL.
See serialize for information on how to customize the serialized form\nof a record.
Called by the store when an existing record is saved\nvia the save method on a model record instance.
The updateRecord method serializes the record and makes an Ajax (HTTP PUT) request\nto a URL computed by buildURL.
See serialize for information on how to customize the serialized form\nof a record.
Called by the store when a record is deleted.
\nThe deleteRecord method makes an Ajax (HTTP DELETE) request to a URL computed by buildURL.
Organize records into groups, each of which is to be passed to separate\ncalls to findMany.
This implementation groups together records that have the same base URL but\ndiffering ids. For example /comments/1 and /comments/2 will be grouped together\nbecause 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\nbut not those where there is more than 1 query param such as /comments?id=2&name=David\nCurrently only the query param of id is supported. If you need to support others, please\noverride this or the _stripIDFromURL method.
It does not group records that have differing base urls, such as for example: /posts/1/comments/2\nand /posts/2/comments/3
Takes an ajax response, and returns the json payload or an error.
\nBy default this hook just returns the json payload passed to it.\nYou might want to override it in two cases:
\nYour API might return useful results in the response headers.\nResponse headers are passed in as the second argument.
\nYour API might return errors as successful responses with status code\n200 and an Errors text or object. You can return a InvalidError or a\nAdapterError (or a sub class) from this hook and it will automatically\nreject the promise and put your record into the invalid or error state.
Returning a InvalidError from this method will cause the\nrecord to transition into the invalid state and make the\nerrors object available on the record. When returning an\nInvalidError the store will attempt to normalize the error data\nreturned from the server using the serializer's extractErrors\nmethod.
Default handleResponse implementation uses this hook to decide if the\nresponse is a success.
Default handleResponse implementation uses this hook to decide if the\nresponse is an invalid error.
Takes a URL, an HTTP method and a hash of data, and makes an\nHTTP request.
\nWhen the server responds with a payload, Ember Data will call into extractSingle\nor extractArray (depending on whether the original query was for one record or\nmany records).
By default, ajax method has the following behavior:
dataType to "json""GET", it sets the Content-Type to be\napplication/json; charset=utf-8"GET", it stringifies the data passed in. The\ndata is the serialized record in the case of a save.Generates a detailed ("friendly") error message, with plenty\nof information for debugging (good luck!)
\n", + "itemtype": "method", + "name": "generatedDetailedMessage", + "access": "private", + "tagname": "", + "params": [ + { + "name": "status", + "description": "", + "type": "Number" + }, + { + "name": "headers", + "description": "", + "type": "Object" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "requestData", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "detailed error message", + "type": "String" + }, + "class": "RESTAdapter", + "module": "@ember-data/adapter/rest" + }, + { + "file": "../adapter/addon/rest.ts", + "line": 1304, + "description": "Used by findAll and findRecord to build the query's data hash\nsupplied to the ajax method.
The findRecord() method is invoked when the store is asked for a record that\nhas not previously been loaded. In response to findRecord() being called, you\nshould query your persistence layer for a record with the given ID. The findRecord\nmethod should return a promise that will resolve to a JavaScript object that will be\nnormalized by the serializer.
Here is an example of the findRecord implementation:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findRecord(store, type, id, snapshot) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}/${id}`).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
The findAll() method is used to retrieve all records for a given type.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findAll(store, type) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
This method is called when you call query on the store.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n query(store, type, query) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`, query).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
The queryRecord() method is invoked when the store is asked for a single\nrecord through a query object.
In response to queryRecord() being called, you should always fetch fresh\ndata. Once found, you can asynchronously call the store's push() method\nto push the record into the store.
Here is an example queryRecord implementation:
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Adapter, { BuildURLMixin } from '@ember-data/adapter';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter.extend(BuildURLMixin) {\n queryRecord(store, type, query) {\n return new RSVP.Promise(function(resolve, reject) {\n $.getJSON(`/${type.modelName}`, query).then(function(data) {\n resolve(data);\n }, function(jqXHR) {\n reject(jqXHR);\n });\n });\n }\n} | \n
If the globally unique IDs for your records should be generated on the client,\nimplement the generateIdForRecord() method. This method will be invoked\neach time you create a new record, and the value returned from it will be\nassigned to the record's primaryKey.
Most traditional REST-like HTTP APIs will not use this method. Instead, the ID\nof the record will be set by the server, and your adapter will update the store\nwith the new ID when it calls didCreateRecord(). Only implement this method if\nyou intend to generate record IDs on the client-side.
The generateIdForRecord() method will be invoked with the requesting store as\nthe first parameter and the newly created record as the second parameter:
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Adapter from '-data/adapter';\nimport { v4 } from 'uuid';\n\nexport default class ApplicationAdapter extends Adapter {\n generateIdForRecord(store, type, inputProperties) {\n return v4();\n }\n} | \n
Proxies to the serializer's serialize method.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import Adapter from '-data/adapter';\n\nexport default class ApplicationAdapter extends Adapter {\n createRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let url = `/${type.modelName}`;\n\n // ...\n }\n} | \n
Implement this method in a subclass to handle the creation of\nnew records.
\nSerializes the record and sends it to the server.
\nExample
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n createRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n\n return new RSVP.Promise(function (resolve, reject) {\n $.ajax({\n type: 'POST',\n url: `/${type.modelName}`,\n dataType: 'json',\n data: data\n }).then(function (data) {\n run(null, resolve, data);\n }, function (jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Implement this method in a subclass to handle the updating of\na record.
\nSerializes the record update and sends it to the server.
\nThe updateRecord method is expected to return a promise that will\nresolve with the serialized record. This allows the backend to\ninform the Ember Data store the current state of this record after\nthe update. If it is not possible to return a serialized record\nthe updateRecord promise can also resolve with undefined and the\nEmber Data store will assume all of the updates were successfully\napplied on the backend.
Example
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n updateRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let id = snapshot.id;\n\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'PUT',\n url: `/${type.modelName}/${id}`,\n dataType: 'json',\n data: data\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Implement this method in a subclass to handle the deletion of\na record.
\nSends a delete request for the record to the server.
\nExample
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n deleteRecord(store, type, snapshot) {\n let data = this.serialize(snapshot, { includeId: true });\n let id = snapshot.id;\n\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'DELETE',\n url: `/${type.modelName}/${id}`,\n dataType: 'json',\n data: data\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
The store will call findMany instead of multiple findRecord\nrequests to find multiple records at once if coalesceFindRequests\nis true.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n | \n import Adapter from '@ember-data/adapter';\nimport { run } from '@ember/runloop';\nimport RSVP from 'RSVP';\nimport $ from 'jquery';\n\nexport default class ApplicationAdapter extends Adapter {\n findMany(store, type, ids, snapshots) {\n return new RSVP.Promise(function(resolve, reject) {\n $.ajax({\n type: 'GET',\n url: `/${type.modelName}/`,\n dataType: 'json',\n data: { filter: { id: ids.join(',') } }\n }).then(function(data) {\n run(null, resolve, data);\n }, function(jqXHR) {\n jqXHR.then = null; // tame jQuery's ill mannered promises\n run(null, reject, jqXHR);\n });\n });\n }\n} | \n
Organize records into groups, each of which is to be passed to separate\ncalls to findMany.
For example, if your API has nested URLs that depend on the parent, you will\nwant to group records by their parent.
\nThe default implementation returns the records as a single group.
\n", + "itemtype": "method", + "name": "groupRecordsForFindMany", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "snapshots", + "description": "", + "type": "Array" + } + ], + "return": { + "description": "an array of arrays of records, each of which is to be\n loaded separately by `findMany`.", + "type": "Array" + }, + "class": "RESTAdapter", + "module": "@ember-data/adapter", + "inherited": true, + "inheritedFrom": "Adapter" + }, + { + "file": "../adapter/addon/index.ts", + "line": 703, + "description": "This method is used by the store to determine if the store should\nreload a record from the adapter when a record is requested by\nstore.findRecord.
If this method returns true, the store will re-fetch a record from\nthe adapter. If this method returns false, the store will resolve\nimmediately using the cached record.
For example, if you are building an events ticketing system, in which users\ncan only reserve tickets for 20 minutes at a time, and want to ensure that\nin each route you have data that is no more than 20 minutes old you could\nwrite:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n shouldReloadRecord(store, ticketSnapshot) {\n let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt');\n let timeDiff = moment().diff(lastAccessedAt, 'minutes');\n\n if (timeDiff > 20) {\n return true;\n } else {\n return false;\n }\n} | \n
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\ncase the cached version is more than 20 minutes old, findRecord will not\nresolve until you fetched the latest version.
By default this hook returns false, as most UIs should not block user\ninteractions while waiting on data update.
Note that, with default settings, shouldBackgroundReloadRecord will always\nre-fetch the records in the background even if shouldReloadRecord returns\nfalse. You can override shouldBackgroundReloadRecord if this does not\nsuit your use case.
This method is used by the store to determine if the store should\nreload all records from the adapter when records are requested by\nstore.findAll.
If this method returns true, the store will re-fetch all records from\nthe adapter. If this method returns false, the store will resolve\nimmediately using the cached records.
For example, if you are building an events ticketing system, in which users\ncan only reserve tickets for 20 minutes at a time, and want to ensure that\nin each route you have data that is no more than 20 minutes old you could\nwrite:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n shouldReloadAll(store, snapshotArray) {\n let snapshots = snapshotArray.snapshots();\n\n return snapshots.any((ticketSnapshot) => {\n let lastAccessedAt = ticketSnapshot.attr('lastAccessedAt');\n let timeDiff = moment().diff(lastAccessedAt, 'minutes');\n\n if (timeDiff > 20) {\n return true;\n } else {\n return false;\n }\n });\n} | \n
This method would ensure that whenever you do store.findAll('ticket') you\nwill always get a list of tickets that are no more than 20 minutes old. In\ncase a cached version is more than 20 minutes old, findAll will not\nresolve until you fetched the latest versions.
By default, this method returns true if the passed snapshotRecordArray\nis empty (meaning that there are no records locally available yet),\notherwise, it returns false.
Note that, with default settings, shouldBackgroundReloadAll will always\nre-fetch all the records in the background even if shouldReloadAll returns\nfalse. You can override shouldBackgroundReloadAll if this does not suit\nyour use case.
This method is used by the store to determine if the store should\nreload a record after the store.findRecord method resolves a\ncached record.
This method is only checked by the store when the store is\nreturning a cached record.
\nIf this method returns true the store will re-fetch a record from\nthe adapter.
For example, if you do not want to fetch complex data over a mobile\nconnection, or if the network is down, you can implement\nshouldBackgroundReloadRecord as follows:
1\n2\n3\n4\n5\n | \n shouldBackgroundReloadRecord(store, snapshot) {\n let { downlink, effectiveType } = navigator.connection;\n\n return downlink > 0 && effectiveType === '4g';\n} | \n
By default, this hook returns true so the data for the record is updated\nin the background.
This method is used by the store to determine if the store should\nreload a record array after the store.findAll method resolves\nwith a cached record array.
This method is only checked by the store when the store is\nreturning a cached record array.
\nIf this method returns true the store will re-fetch all records\nfrom the adapter.
For example, if you do not want to fetch complex data over a mobile\nconnection, or if the network is down, you can implement\nshouldBackgroundReloadAll as follows:
1\n2\n3\n4\n5\n | \n shouldBackgroundReloadAll(store, snapshotArray) {\n let { downlink, effectiveType } = navigator.connection;\n\n return downlink > 0 && effectiveType === '4g';\n} | \n
By default this method returns true, indicating that a background reload\nshould always be triggered.
Builds a URL for a given type and optional ID.
\nBy default, it pluralizes the type's name (for example, 'post'\nbecomes 'posts' and 'person' becomes 'people'). To override the\npluralization see pathForType.
\nIf an ID is specified, it adds the ID to the path generated\nfor the type, separated by a /.
When called by RESTAdapter.findMany() the id and snapshot parameters\nwill be arrays of ids and snapshots.
Builds a URL for a store.findRecord(type, id) call.
Example:
\n| app/adapters/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindRecord(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id, snapshot);\n return `${baseUrl}/users/${snapshot.adapterOptions.user_id}/playlists/${id}`;\n }\n} | \n
Builds a URL for a store.findAll(type) call.
Example:
\n| app/adapters/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindAll(modelName, snapshot) {\n let baseUrl = this.buildURL(modelName);\n return `${baseUrl}/data/comments.json`;\n }\n} | \n
Builds a URL for a store.query(type, query) call.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n host = 'https://api.github.com';\n urlForQuery (query, modelName) {\n switch(modelName) {\n case 'repo':\n return `https://api.github.com/orgs/${query.orgId}/repos`;\n default:\n return super.urlForQuery(...arguments);\n }\n }\n} | \n
Builds a URL for a store.queryRecord(type, query) call.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForQueryRecord({ slug }, modelName) {\n let baseUrl = this.buildURL();\n return `${baseUrl}/${encodeURIComponent(slug)}`;\n }\n} | \n
Builds a URL for coalescing multiple store.findRecord(type, id)\nrecords into 1 request when the adapter's coalesceFindRequests\nproperty is true.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForFindMany(ids, modelName) {\n let baseUrl = this.buildURL();\n return `${baseUrl}/coalesce`;\n }\n} | \n
Builds a URL for fetching an async hasMany relationship when a URL\nis not provided by the server.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindHasMany(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id);\n return `${baseUrl}/relationships`;\n }\n} | \n
Builds a URL for fetching an async belongsTo relationship when a url\nis not provided by the server.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n urlForFindBelongsTo(id, modelName, snapshot) {\n let baseUrl = this.buildURL(modelName, id);\n return `${baseUrl}/relationships`;\n }\n} | \n
Builds a URL for a record.save() call when the record was created\nlocally using store.createRecord().
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForCreateRecord(modelName, snapshot) {\n return super.urlForCreateRecord(...arguments) + '/new';\n }\n} | \n
Builds a URL for a record.save() call when the record has been updated locally.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForUpdateRecord(id, modelName, snapshot) {\n return `/${id}/feed?access_token=${snapshot.adapterOptions.token}`;\n }\n} | \n
Builds a URL for a record.save() call when the record has been deleted locally.
Example:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n urlForDeleteRecord(id, modelName, snapshot) {\n return super.urlForDeleteRecord(...arguments) + '/destroy';\n }\n} | \n
Determines the pathname for a given type.
\nBy default, it pluralizes the type's name (for example,\n'post' becomes 'posts' and 'person' becomes 'people').
\nFor example, if you have an object LineItem with an\nendpoint of /line_items/.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { decamelize } from '/string';\nimport { pluralize } from 'ember-inflector';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n pathForType(modelName) {\n var decamelized = decamelize(modelName);\n return pluralize(decamelized);\n }\n} | \n
If jQuery or nAjax are installed, this property\n allows fetch to still be used instead when true.
By default the RESTAdapter will send each find request coming from a store.find\nor from accessing a relationship separately to the server. If your server supports passing\nids as a query string, you can set coalesceFindRequests to true to coalesce all find requests\nwithin a single runloop.
For example, if you have an initial payload of:
\n1\n2\n3\n4\n5\n6\n | \n {\n post: {\n id: 1,\n comments: [1, 2]\n }\n} | \n
By default calling post.get('comments') will trigger the following requests(assuming the\ncomments haven't been loaded before):
1\n2\n | \n GET /comments/1\nGET /comments/2 | \n
If you set coalesceFindRequests to true it will instead trigger the following request:
1\n | \n GET /comments?ids[]=1&ids[]=2 | \n
Setting coalesceFindRequests to true also works for store.find requests and belongsTo\nrelationships accessed within the same runloop. If you set coalesceFindRequests: true
1\n2\n | \n store.findRecord('comment', 1);\nstore.findRecord('comment', 2); | \n
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\ngroupRecordsForFindMany more likely should be overridden as well in order for coalescing to work.
Endpoint paths can be prefixed with a namespace by setting the namespace\nproperty on the adapter:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n namespace = 'api/1';\n} | \n
Requests for the Post model would now target /api/1/post/.
An adapter can target other hosts by setting the host property.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n host = 'https://api.example.com';\n} | \n
Requests for the Post model would now target https://api.example.com/post/.
Some APIs require HTTP headers, e.g. to provide an API\nkey. Arbitrary headers can be set as key/value pairs on the\nRESTAdapter's headers object and Ember Data will send them\nalong with each ajax request. For dynamic headers see headers\ncustomization.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { computed } from '/object';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n headers: computed(function() {\n return {\n 'API_KEY': 'secret key',\n 'ANOTHER_HEADER': 'Some header value'\n };\n })\n} | \n
If you would like your adapter to use a custom serializer you can\nset the defaultSerializer property to be the name of the custom\nserializer.
Note the defaultSerializer serializer has a lower priority than\na model specific serializer (i.e. PostSerializer) or the\napplication serializer.
| app/adapters/django.js | \n|
1\n2\n3\n4\n5\n | \n import Adapter from '@ember-data/adapter';\n\nexport default Adapter.extend({\n defaultSerializer: 'django'\n}); | \n
By default the store will try to coalesce all fetchRecord calls within the same runloop\ninto as few requests as possible by calling groupRecordsForFindMany and passing it into a findMany call.\nYou can opt out of this behaviour by either not implementing the findMany hook or by setting\ncoalesceFindRequests to false.
Normally, applications will use the RESTSerializer by implementing\nthe normalize method.
This allows you to do whatever kind of munging you need and is\nespecially useful if your server is inconsistent and you need to\ndo munging differently for many different kinds of responses.
\nSee the normalize documentation for more information.
There are also a number of hooks that you might find useful to define\nacross-the-board rules for your payload. These rules will be useful\nif your server is consistent, or if you're building an adapter for\nan infrastructure service, like Firebase, and want to encode service\nconventions.
\nFor example, if all of your keys are underscored and all-caps, but\notherwise consistent with the names you use in your models, you\ncan implement across-the-board rules for how to convert an attribute\nname in your model to a key in your JSON.
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTSerializer from '-data/serializer/rest';\nimport { underscore } from '/string';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n keyForAttribute(attr, method) {\n return underscore(attr).toUpperCase();\n }\n} | \n
You can also implement keyForRelationship, which takes the name\nof the relationship as the first parameter, the kind of\nrelationship (hasMany or belongsTo) as the second parameter, and\nthe method (serialize or deserialize) as the third parameter.\n @mainName @ember-data/serializer/rest\n @tag main
keyForPolymorphicType can be used to define a custom key when\nserializing and deserializing a polymorphic type. By default, the\nreturned key is ${key}Type.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import RESTSerializer from '-data/serializer/rest';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n keyForPolymorphicType(key, relationship) {\n let relationshipKey = this.keyForRelationship(key);\n\n return 'type-' + relationshipKey;\n }\n} | \n
Normalizes a part of the JSON payload returned by\nthe server. You should override this method, munge the hash\nand call super if you have generic normalization to do.
\nIt takes the type of the record that is being normalized\n(as a Model class), the property where the hash was\noriginally found, and the hash to normalize.
\nFor example, if you have a payload that looks like this:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n {\n "post": {\n "id": 1,\n "title": "Rails is omakase",\n "comments": [ 1, 2 ]\n },\n "comments": [{\n "id": 1,\n "body": "FIRST"\n }, {\n "id": 2,\n "body": "Rails is unagi"\n }]\n} | \n
The normalize method will be called three times:
App.Post, "posts" and { id: 1, title: "Rails is omakase", ... }App.Comment, "comments" and { id: 1, body: "FIRST" }App.Comment, "comments" and { id: 2, body: "Rails is unagi" }You can use this method, for example, to normalize underscored keys to camelized\nor other general-purpose normalizations. You will only need to implement\nnormalize and manipulate the payload as desired.
For example, if the IDs under "comments" are provided as _id instead of\nid, you can specify how to normalize just the comments:
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import RESTSerializer from '-data/serializer/rest';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n normalize(model, hash, prop) {\n if (prop === 'comments') {\n hash.id = hash._id;\n delete hash._id;\n }\n\n return super.normalize(...arguments);\n }\n} | \n
On each call to the normalize method, the third parameter (prop) is always\none of the keys that were in the original payload or in the result of another\nnormalization as normalizeResponse.
Normalizes an array of resource payloads and returns a JSON-API Document\nwith primary data and, if any, included data as { data, included }.
This method allows you to push a payload containing top-level\ncollections of records organized per type.
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n | \n {\n "posts": [{\n "id": "1",\n "title": "Rails is omakase",\n "author", "1",\n "comments": [ "1" ]\n }],\n "comments": [{\n "id": "1",\n "body": "FIRST"\n }],\n "users": [{\n "id": "1",\n "name": "@d2h"\n }]\n} | \n
It will first normalize the payload, so you can use this to push\nin data streaming in from your server structured the same way\nthat fetches and saves are structured.
\n", + "itemtype": "method", + "name": "pushPayload", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "payload", + "description": "", + "type": "Object" + } + ], + "class": "RESTSerializer", + "module": "@ember-data/serializer/rest" + }, + { + "file": "../serializer/addon/rest.js", + "line": 429, + "description": "This method is used to convert each JSON root key in the payload\ninto a modelName that it can use to look up the appropriate model for\nthat part of the payload.
\nFor example, your server may send a model name that does not correspond with\nthe name of the model in your app. Let's take a look at an example model,\nand an example payload:
\n| app/models/post.js | \n|
1\n2\n3\n | \n import Model from '-data/model';\n\nexport default class Post extends Model {} | \n
1\n2\n3\n4\n5\n | \n {\n "blog/post": {\n "id": "1\n }\n } | \n
Ember Data is going to normalize the payload's root key for the modelName. As a result,\nit will try to look up the "blog/post" model. Since we don't have a model called "blog/post"\n(or a file called app/models/blog/post.js in ember-cli), Ember Data will throw an error\nbecause it cannot find the "blog/post" model.
\nSince we want to remove this namespace, we can define a serializer for the application that will\nremove "blog/" from the payload key whenver it's encountered by Ember Data:
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import RESTSerializer from '-data/serializer/rest';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n modelNameFromPayloadKey(payloadKey) {\n if (payloadKey === 'blog/post') {\n return super.modelNameFromPayloadKey(payloadKey.replace('blog/', ''));\n } else {\n return super.modelNameFromPayloadKey(payloadKey);\n }\n }\n} | \n
After refreshing, Ember Data will appropriately look up the "post" model.
\nBy default the modelName for a model is its\nname in dasherized form. This means that a payload key like "blogPost" would be\nnormalized to "blog-post" when Ember Data looks up the model. Usually, Ember Data\ncan use the correct inflection to do this for you. Most of the time, you won't\nneed to override modelNameFromPayloadKey for this purpose.
Called when a record is saved in order to convert the\nrecord into JSON.
\nBy default, it creates a JSON object with a key for\neach attribute and belongsTo relationship.
\nFor example, consider this model:
\n| app/models/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class Comment extends Model {\n title\n body\n\n ('user') author\n} | \n
The default serialization would create a JSON object like:
\n1\n2\n3\n4\n5\n | \n {\n "title": "Rails is unagi",\n "body": "Rails? Omakase? O_O",\n "author": 12\n} | \n
By default, attributes are passed through as-is, unless\nyou specified an attribute type (attr('date')). If\nyou specify a transform, the JavaScript value will be\nserialized when inserted into the JSON hash.
By default, belongs-to relationships are converted into\nIDs when inserted into the JSON hash.
\nserialize takes an options hash with a single option:\nincludeId. If this option is true, serialize will,\nby default include the ID in the JSON object it builds.
The adapter passes in includeId: true when serializing\na record for createRecord, but not for updateRecord.
Your server may expect a different JSON format than the\nbuilt-in serialization format.
\nIn that case, you can implement serialize yourself and\nreturn a JSON hash of your choosing.
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import RESTSerializer from '@ember-data/serializer/rest';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n serialize(snapshot, options) {\n let json = {\n POST_TTL: snapshot.attr('title'),\n POST_BDY: snapshot.attr('body'),\n POST_CMS: snapshot.hasMany('comments', { ids: true })\n };\n\n if (options.includeId) {\n json.POST_ID_ = snapshot.id;\n }\n\n return json;\n }\n} | \n
If you want to define a serializer for your entire\napplication, you'll probably want to use eachAttribute\nand eachRelationship on the record.
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n | \n import RESTSerializer from '@ember-data/serializer/rest';\nimport { pluralize } from 'ember-inflector';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n serialize(snapshot, options) {\n let json = {};\n\n snapshot.eachAttribute(function(name) {\n json[serverAttributeName(name)] = snapshot.attr(name);\n });\n\n snapshot.eachRelationship(function(name, relationship) {\n if (relationship.kind === 'hasMany') {\n json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });\n }\n });\n\n if (options.includeId) {\n json.ID_ = snapshot.id;\n }\n\n return json;\n }\n}\n\nfunction serverAttributeName(attribute) {\n return attribute.underscore().toUpperCase();\n}\n\nfunction serverHasManyName(name) {\n return serverAttributeName(singularize(name)) + "_IDS";\n} | \n
This serializer will generate JSON that looks like this:
\n1\n2\n3\n4\n5\n | \n {\n "TITLE": "Rails is omakase",\n "BODY": "Yep. Omakase.",\n "COMMENT_IDS": [ 1, 2, 3 ]\n} | \n
If you just want to do some small tweaks on the default JSON,\nyou can call super first and make the tweaks on the returned\nJSON.
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import RESTSerializer from '-data/serializer/rest';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n serialize(snapshot, options) {\n let json = super.serialize(snapshot, options);\n\n json.subject = json.title;\n delete json.title;\n\n return json;\n }\n} | \n
You can use this method to customize the root keys serialized into the JSON.\nThe hash property should be modified by reference (possibly using something like _.extend)\nBy default the REST Serializer sends the modelName of a model, which is a camelized\nversion of the name.
\nFor example, your server may expect underscored root objects.
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import RESTSerializer from '-data/serializer/rest';\nimport { decamelize } from '/string';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n serializeIntoHash(data, type, record, options) {\n let root = decamelize(type.modelName);\n data[root] = this.serialize(record, options);\n }\n} | \n
You can use payloadKeyFromModelName to override the root key for an outgoing\nrequest. By default, the RESTSerializer returns a camelized version of the\nmodel's name.
For a model called TacoParty, its modelName would be the string taco-party. The RESTSerializer\nwill send it to the server with tacoParty as the root key in the JSON payload:
1\n2\n3\n4\n5\n6\n | \n {\n "tacoParty": {\n "id": "1",\n "location": "Matthew Beale's House"\n }\n} | \n
For example, your server may expect dasherized root objects:
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTSerializer from '-data/serializer/rest';\nimport { dasherize } from '/string';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n payloadKeyFromModelName(modelName) {\n return dasherize(modelName);\n }\n} | \n
Given a TacoParty model, calling save on it would produce an outgoing\nrequest like:
1\n2\n3\n4\n5\n6\n | \n {\n "taco-party": {\n "id": "1",\n "location": "Matthew Beale's House"\n }\n} | \n
You can use this method to customize how polymorphic objects are serialized.\nBy default the REST Serializer creates the key by appending Type to\nthe attribute and value from the model's camelcased model name.
You can use this method to customize how a polymorphic relationship should\nbe extracted.
\n", + "itemtype": "method", + "name": "extractPolymorphicRelationship", + "access": "public", + "tagname": "", + "params": [ + { + "name": "relationshipType", + "description": "", + "type": "Object" + }, + { + "name": "relationshipHash", + "description": "", + "type": "Object" + }, + { + "name": "relationshipOptions", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/rest" + }, + { + "file": "../serializer/addon/json.js", + "line": 182, + "description": "Given a subclass of Model and a JSON object this method will\niterate through each attribute of the Model and invoke the\nTransform#deserialize method on the matching property of the\nJSON object. This method is typically called after the\nserializer's normalize method.
The normalizeResponse method is used to normalize a payload from the\nserver to a JSON-API Document.
http://jsonapi.org/format/#document-structure
\nThis method delegates to a more specific normalize method based on\nthe requestType.
To override this method with a custom one, make sure to call\nreturn this._super(store, primaryModelClass, payload, id, requestType) with your\npre-processed data.
Here's an example of using normalizeResponse manually:
1\n2\n3\n4\n5\n6\n7\n8\n | \n socket.on('message', function(message) {\n let data = message.data;\n let modelClass = store.modelFor(data.modelName);\n let serializer = store.serializerFor(data.modelName);\n let normalized = serializer.normalizeSingleResponse(store, modelClass, data, data.id);\n\n store.push(normalized);\n}); | \n
Called by the default normalizeResponse implementation when the\ntype of request is findRecord
Called by the default normalizeResponse implementation when the\ntype of request is queryRecord
Called by the default normalizeResponse implementation when the\ntype of request is findAll
Called by the default normalizeResponse implementation when the\ntype of request is findBelongsTo
Called by the default normalizeResponse implementation when the\ntype of request is findHasMany
Called by the default normalizeResponse implementation when the\ntype of request is findMany
Called by the default normalizeResponse implementation when the\ntype of request is query
Called by the default normalizeResponse implementation when the\ntype of request is createRecord
Called by the default normalizeResponse implementation when the\ntype of request is deleteRecord
Called by the default normalizeResponse implementation when the\ntype of request is updateRecord
normalizeUpdateRecordResponse, normalizeCreateRecordResponse and\nnormalizeDeleteRecordResponse delegate to this method by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeSaveResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 470, + "description": "normalizeQueryResponse and normalizeFindRecordResponse delegate to this\nmethod by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeSingleResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 488, + "description": "normalizeQueryResponse, normalizeFindManyResponse, and normalizeFindHasManyResponse delegate\nto this method by default.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "normalizeArrayResponse", + "access": "public", + "tagname": "", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 506, + "itemtype": "method", + "name": "_normalizeResponse", + "params": [ + { + "name": "store", + "description": "", + "type": "Store" + }, + { + "name": "primaryModelClass", + "description": "", + "type": "Model" + }, + { + "name": "payload", + "description": "", + "type": "Object" + }, + { + "name": "id", + "description": "", + "type": "String|Number" + }, + { + "name": "requestType", + "description": "", + "type": "String" + }, + { + "name": "isSingle", + "description": "", + "type": "Boolean" + } + ], + "return": { + "description": "JSON-API Document", + "type": "Object" + }, + "access": "private", + "tagname": "", + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 555, + "description": "Normalizes a part of the JSON payload returned by\nthe server. You should override this method, munge the hash\nand call super if you have generic normalization to do.
\nIt takes the type of the record that is being normalized\n(as a Model class), the property where the hash was\noriginally found, and the hash to normalize.
\nYou can use this method, for example, to normalize underscored keys to camelized\nor other general-purpose normalizations.
\nExample
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n | \n import JSONSerializer from '@ember-data/serializer/json';\nimport { underscore } from '@ember/string';\nimport { get } from '@ember/object';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n normalize(typeClass, hash) {\n let fields = get(typeClass, 'fields');\n\n fields.forEach(function(type, field) {\n let payloadField = underscore(field);\n if (field === payloadField) { return; }\n\n hash[field] = hash[payloadField];\n delete hash[payloadField];\n });\n\n return this._super.apply(this, arguments);\n }\n} | \n
Returns the resource's ID.
\n", + "itemtype": "method", + "name": "extractId", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "String" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 634, + "description": "Returns the resource's attributes formatted as a JSON-API "attributes object".
\nhttp://jsonapi.org/format/#document-resource-object-attributes
\n", + "itemtype": "method", + "name": "extractAttributes", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 659, + "description": "Returns a relationship formatted as a JSON-API "relationship object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\n", + "itemtype": "method", + "name": "extractRelationship", + "access": "public", + "tagname": "", + "params": [ + { + "name": "relationshipModelName", + "description": "", + "type": "Object" + }, + { + "name": "relationshipHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 694, + "description": "Returns a polymorphic relationship formatted as a JSON-API "relationship object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\nrelationshipOptions is a hash which contains more information about the\npolymorphic relationship which should be extracted:
resourceHash complete hash of the resource the relationship should be\nextracted fromrelationshipKey key under which the value for the relationship is\nextracted from the resourceHashrelationshipMeta meta information about the relationshipReturns the resource's relationships formatted as a JSON-API "relationships object".
\nhttp://jsonapi.org/format/#document-resource-object-relationships
\n", + "itemtype": "method", + "name": "extractRelationships", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelClass", + "description": "", + "type": "Object" + }, + { + "name": "resourceHash", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "", + "type": "Object" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 790, + "description": "Dasherizes the model name in the payload
\n", + "itemtype": "method", + "name": "modelNameFromPayloadKey", + "access": "public", + "tagname": "", + "params": [ + { + "name": "key", + "description": "", + "type": "String" + } + ], + "return": { + "description": "the model's modelName", + "type": "String" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 802, + "itemtype": "method", + "name": "normalizeRelationships", + "access": "private", + "tagname": "", + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 825, + "itemtype": "method", + "name": "normalizeUsingDeclaredMapping", + "access": "private", + "tagname": "", + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 858, + "description": "Looks up the property key that was set by the custom attr mapping\npassed to the serializer.
Check attrs.key.serialize property to inform if the key\ncan be serialized
When attrs.key.serialize is set to true then\nit takes priority over the other checks and the related\nattribute/relationship will be serialized
\n", + "itemtype": "method", + "name": "_mustSerialize", + "access": "private", + "tagname": "", + "params": [ + { + "name": "key", + "description": "", + "type": "String" + } + ], + "return": { + "description": "true if the key must be serialized", + "type": "Boolean" + }, + "class": "RESTSerializer", + "module": "@ember-data/serializer/json", + "inherited": true, + "inheritedFrom": "JSONSerializer" + }, + { + "file": "../serializer/addon/json.js", + "line": 928, + "description": "Check if the given hasMany relationship should be serialized
\nBy default only many-to-many and many-to-none relationships are serialized.\nThis could be configured per relationship by Serializer's attrs object.
Called when a record is saved in order to convert the\nrecord into JSON.
\nBy default, it creates a JSON object with a key for\neach attribute and belongsTo relationship.
\nFor example, consider this model:
\n| app/models/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class CommentModel extends Model {\n title;\n body;\n\n ('user') author;\n} | \n
The default serialization would create a JSON object like:
\n1\n2\n3\n4\n5\n | \n {\n "title": "Rails is unagi",\n "body": "Rails? Omakase? O_O",\n "author": 12\n} | \n
By default, attributes are passed through as-is, unless\nyou specified an attribute type (attr('date')). If\nyou specify a transform, the JavaScript value will be\nserialized when inserted into the JSON hash.
By default, belongs-to relationships are converted into\nIDs when inserted into the JSON hash.
\nserialize takes an options hash with a single option:\nincludeId. If this option is true, serialize will,\nby default include the ID in the JSON object it builds.
The adapter passes in includeId: true when serializing\na record for createRecord, but not for updateRecord.
Your server may expect a different JSON format than the\nbuilt-in serialization format.
\nIn that case, you can implement serialize yourself and\nreturn a JSON hash of your choosing.
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import JSONSerializer from '@ember-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = {\n POST_TTL: snapshot.attr('title'),\n POST_BDY: snapshot.attr('body'),\n POST_CMS: snapshot.hasMany('comments', { ids: true })\n };\n\n if (options.includeId) {\n json.POST_ID_ = snapshot.id;\n }\n\n return json;\n }\n} | \n
If you want to define a serializer for your entire\napplication, you'll probably want to use eachAttribute\nand eachRelationship on the record.
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n | \n import JSONSerializer from '@ember-data/serializer/json';\nimport { singularize } from 'ember-inflector';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = {};\n\n snapshot.eachAttribute((name) => {\n json[serverAttributeName(name)] = snapshot.attr(name);\n });\n\n snapshot.eachRelationship((name, relationship) => {\n if (relationship.kind === 'hasMany') {\n json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });\n }\n });\n\n if (options.includeId) {\n json.ID_ = snapshot.id;\n }\n\n return json;\n }\n}\n\nfunction serverAttributeName(attribute) {\n return attribute.underscore().toUpperCase();\n}\n\nfunction serverHasManyName(name) {\n return serverAttributeName(singularize(name)) + "_IDS";\n} | \n
This serializer will generate JSON that looks like this:
\n1\n2\n3\n4\n5\n | \n {\n "TITLE": "Rails is omakase",\n "BODY": "Yep. Omakase.",\n "COMMENT_IDS": [ "1", "2", "3" ]\n} | \n
If you just want to do some small tweaks on the default JSON,\nyou can call super.serialize first and make the tweaks on\nthe returned JSON.
| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serialize(snapshot, options) {\n let json = super.serialize(...arguments);\n\n json.subject = json.title;\n delete json.title;\n\n return json;\n }\n} | \n
You can use this method to customize how a serialized record is added to the complete\nJSON hash to be sent to the server. By default the JSON Serializer does not namespace\nthe payload and just sends the raw serialized JSON object.\nIf your server expects namespaced keys, you should consider using the RESTSerializer.\nOtherwise you can override this method to customize how the record is added to the hash.\nThe hash property should be modified by reference.
\nFor example, your server may expect underscored root objects.
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import RESTSerializer from '-data/serializer/rest';\nimport { decamelize } from '/string';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n serializeIntoHash(data, type, snapshot, options) {\n let root = decamelize(type.modelName);\n data[root] = this.serialize(snapshot, options);\n }\n} | \n
serializeAttribute can be used to customize how attr\nproperties are serialized
For example if you wanted to ensure all your attributes were always\nserialized as properties on an attributes object you could\nwrite:
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n serializeAttribute(snapshot, json, key, attributes) {\n json.attributes = json.attributes || {};\n this._super(snapshot, json.attributes, key, attributes);\n }\n} | \n
serializeBelongsTo can be used to customize how belongsTo\nproperties are serialized.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import JSONSerializer from '-data/serializer/json';\nimport { isNone } from '/utils';\n\nexport default class PostSerializer extends JSONSerializer {\n serializeBelongsTo(snapshot, json, relationship) {\n let key = relationship.key;\n let belongsTo = snapshot.belongsTo(key);\n\n key = this.keyForRelationship ? this.keyForRelationship(key, "belongsTo", "serialize") : key;\n\n json[key] = isNone(belongsTo) ? belongsTo : belongsTo.record.toJSON();\n }\n} | \n
serializeHasMany can be used to customize how hasMany\nproperties are serialized.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n serializeHasMany(snapshot, json, relationship) {\n let key = relationship.key;\n if (key === 'comments') {\n return;\n } else {\n this._super(...arguments);\n }\n }\n} | \n
You can use this method to customize how polymorphic objects are\nserialized. Objects are considered to be polymorphic if\n{ polymorphic: true } is pass as the second argument to the\nbelongsTo function.
Example
\n| app/serializers/comment.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import JSONSerializer from '-data/serializer/json';\nimport { isNone } from '/utils';\n\nexport default class CommentSerializer extends JSONSerializer {\n serializePolymorphicType(snapshot, json, relationship) {\n let key = relationship.key;\n let belongsTo = snapshot.belongsTo(key);\n\n key = this.keyForAttribute ? this.keyForAttribute(key, 'serialize') : key;\n\n if (isNone(belongsTo)) {\n json[key + '_type'] = null;\n } else {\n json[key + '_type'] = belongsTo.modelName;\n }\n }\n} | \n
extractMeta is used to deserialize any meta information in the\nadapter payload. By default Ember Data expects meta information to\nbe located on the meta property of the payload object.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n extractMeta(store, typeClass, payload) {\n if (payload && payload.hasOwnProperty('_pagination')) {\n let meta = payload._pagination;\n delete payload._pagination;\n return meta;\n }\n }\n} | \n
extractErrors is used to extract model errors when a call\nto Model#save fails with an InvalidError. By default\nEmber Data expects error information to be located on the errors\nproperty of the payload object.
This serializer expects this errors object to be an Array similar\nto the following, compliant with the https://jsonapi.org/format/#errors specification:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n {\n "errors": [\n {\n "detail": "This username is already taken!",\n "source": {\n "pointer": "data/attributes/username"\n }\n }, {\n "detail": "Doesn't look like a valid email.",\n "source": {\n "pointer": "data/attributes/email"\n }\n }\n ]\n} | \n
The key detail provides a textual description of the problem.\nAlternatively, the key title can be used for the same purpose.
The nested keys source.pointer detail which specific element\nof the request data was invalid.
Note that JSON-API also allows for object-level errors to be placed\nin an object with pointer data, signifying that the problem\ncannot be traced to a specific attribute:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n {\n "errors": [\n {\n "detail": "Some generic non property error message",\n "source": {\n "pointer": "data"\n }\n }\n ]\n} | \n
When turn into a Errors object, you can read these errors\nthrough the property base:
1\n2\n3\n4\n5\n | \n {{#each @model.errors.base as |error|}}\n <div class="error">\n {{error.message}}\n </div>\n{{/each}} | \n
Example of alternative implementation, overriding the default\nbehavior to deal with a different format of errors:
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n extractErrors(store, typeClass, payload, id) {\n if (payload && typeof payload === 'object' && payload._problems) {\n payload = payload._problems;\n this.normalizeErrors(typeClass, payload);\n }\n return payload;\n }\n} | \n
keyForAttribute can be used to define rules for how to convert an\nattribute name in your model to a key in your JSON.
Example
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\nimport { underscore } from '/string';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n keyForAttribute(attr, method) {\n return underscore(attr).toUpperCase();\n }\n} | \n
keyForRelationship can be used to define a custom key when\nserializing and deserializing relationship properties. By default\nJSONSerializer does not provide an implementation of this method.
Example
\n| app/serializers/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\nimport { underscore } from '/string';\n\nexport default class PostSerializer extends JSONSerializer {\n keyForRelationship(key, relationship, method) {\n return `rel_${underscore(key)}`;\n }\n} | \n
keyForLink can be used to define a custom key when deserializing link\nproperties.
The normalizeResponse method is used to normalize a payload from the\nserver to a JSON-API Document.
http://jsonapi.org/format/#document-structure
\nExample:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n Serializer.extend({\n normalizeResponse(store, primaryModelClass, payload, id, requestType) {\n if (requestType === 'findRecord') {\n return this.normalize(primaryModelClass, payload);\n } else {\n return payload.reduce(function(documentHash, item) {\n let { data, included } = this.normalize(primaryModelClass, item);\n documentHash.included.push(...included);\n documentHash.data.push(data);\n return documentHash;\n }, { data: [], included: [] })\n }\n }\n}); | \n
The serialize method is used when a record is saved in order to convert\nthe record into the form that your external data source expects.
serialize takes an optional options hash with a single option:
includeId: If this is true, serialize should include the ID\nin the serialized object it builds.Example:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n | \n Serializer.extend({\n serialize(snapshot, options) {\n let json = {\n id: snapshot.id\n };\n\n snapshot.eachAttribute((key, attribute) => {\n json[key] = snapshot.attr(key);\n });\n\n snapshot.eachRelationship((key, relationship) => {\n if (relationship.kind === 'belongsTo') {\n json[key] = snapshot.belongsTo(key, { id: true });\n } else if (relationship.kind === 'hasMany') {\n json[key] = snapshot.hasMany(key, { ids: true });\n }\n });\n\n return json;\n },\n}); | \n
The normalize method is used to convert a payload received from your\nexternal data source into the normalized form store.push() expects. You\nshould override this method, munge the hash and return the normalized\npayload.
Example:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n Serializer.extend({\n normalize(modelClass, resourceHash) {\n let data = {\n id: resourceHash.id,\n type: modelClass.modelName,\n attributes: resourceHash\n };\n return { data: data };\n }\n}) | \n
The primaryKey is used when serializing and deserializing\ndata. Ember Data always uses the id property to store the id of\nthe record. The external source may not always follow this\nconvention. In these cases it is useful to override the\nprimaryKey property to match the primaryKey of your external\nstore.
Example
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class ApplicationSerializer extends JSONSerializer {\n primaryKey = '_id'\n} | \n
The attrs object can be used to declare a simple mapping between\nproperty names on Model records and payload keys in the\nserialized JSON object representing the record. An object with the\nproperty key can also be used to designate the attribute's key on\nthe response payload.
Example
\n| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr } from '-data/model';\n\nexport default class PersonModel extends Model {\n ('string') firstName;\n ('string') lastName;\n ('string') occupation;\n ('boolean') admin;\n} | \n
| app/serializers/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PersonSerializer extends JSONSerializer {\n attrs = {\n admin: 'is_admin',\n occupation: { key: 'career' }\n }\n} | \n
You can also remove attributes and relationships by setting the serialize\nkey to false in your mapping object.
Example
\n| app/serializers/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import JSONSerializer from '-data/serializer/json';\n\nexport default class PostSerializer extends JSONSerializer {\n attrs = {\n admin: { serialize: false },\n occupation: { key: 'career' }\n }\n} | \n
When serialized:
\n1\n2\n3\n4\n5\n | \n {\n "firstName": "Harry",\n "lastName": "Houdini",\n "career": "magician"\n} | \n
Note that the admin is now not included in the payload.
Setting serialize to true enforces serialization for hasMany\nrelationships even if it's neither a many-to-many nor many-to-none\nrelationship.
The store property is the application's store that contains\nall records. It can be used to look up serializers for other model\ntypes that may be nested inside the payload response.
Example:
\n1\n2\n3\n4\n5\n6\n7\n | \n Serializer.extend({\n extractRelationship(relationshipModelName, relationshipHash) {\n let modelClass = this.store.modelFor(relationshipModelName);\n let relationshipSerializer = this.store.serializerFor(relationshipModelName);\n return relationshipSerializer.normalize(modelClass, relationshipHash);\n }\n}); | \n
A record array is an array that contains records of a certain modelName. The record\narray materializes records as needed when they are retrieved for the first\ntime. You should not create record arrays yourself. Instead, an instance of\nRecordArray or its subclasses will be returned by your application's store\nin response to queries.
This class should not be imported and instantiated by consuming applications.
\n", + "access": "public", + "tagname": "", + "extends": "Ember.ArrayProxy", + "uses": [ + "Ember.Evented" + ], + "methods": [ + { + "file": "../store/addon/-private/system/record-arrays/record-array.js", + "line": 118, + "description": "Retrieves an object from the content by index.
\n", + "itemtype": "method", + "name": "objectAtContent", + "access": "private", + "tagname": "", + "params": [ + { + "name": "index", + "description": "", + "type": "Number" + } + ], + "return": { + "description": "record", + "type": "Model" + }, + "class": "RecordArray", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/record-arrays/record-array.js", + "line": 131, + "description": "Used to get the latest version of all of the records in this array\nfrom the adapter.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n | \n let people = store.peekAll('person');\npeople.get('isUpdating'); // false\n\npeople.update().then(function() {\n people.get('isUpdating'); // false\n});\n\npeople.get('isUpdating'); // true | \n
Saves all of the records in the RecordArray.
Example
\n1\n2\n3\n4\n5\n | \n let messages = store.peekAll('message');\nmessages.forEach(function(message) {\n message.set('hasBeenSeen', true);\n});\nmessages.save(); | \n
The array of client ids backing the record array. When a\nrecord is requested from the record array, the record\nfor the client id at the same index is materialized, if\nnecessary, by the store.
\n", + "itemtype": "property", + "name": "content", + "access": "private", + "tagname": "", + "type": "Ember.Array", + "class": "RecordArray", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/record-arrays/record-array.js", + "line": 54, + "description": "The flag to signal a RecordArray is finished loading data.
Example
\n1\n2\n | \n let people = store.peekAll('person');\npeople.get('isLoaded'); // true | \n
The flag to signal a RecordArray is currently loading data.
Example
\n1\n2\n3\n4\n | \n let people = store.peekAll('person');\npeople.get('isUpdating'); // false\npeople.update();\npeople.get('isUpdating'); // true | \n
The store that created this record array.
\n", + "itemtype": "property", + "name": "store", + "access": "private", + "tagname": "", + "type": "Store", + "class": "RecordArray", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/record-arrays/record-array.js", + "line": 104, + "description": "The modelClass represented by this record array.
\n", + "itemtype": "property", + "name": "type", + "access": "public", + "tagname": "", + "type": "{subclass of Model}", + "class": "RecordArray", + "module": "@ember-data/store" + } + ] + }, + "relationships": { + "parent-class": { + "data": { + "id": "Ember.ArrayProxy", + "type": "missing" + } + }, + "descendants": { + "data": [ + { + "type": "class", + "id": "ember-data-3.28.13-AdapterPopulatedRecordArray" + } + ] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/store", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-RecordReference-6c446acafd.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-RecordReference-6c446acafd.json new file mode 100644 index 000000000..645bbe6f0 --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-RecordReference-6c446acafd.json @@ -0,0 +1,211 @@ +{ + "data": { + "id": "ember-data-3.28.13-RecordReference", + "type": "class", + "attributes": { + "name": "RecordReference", + "shortname": "RecordReference", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/store", + "namespace": "", + "file": "../store/addon/-private/system/references/record.ts", + "line": 22, + "description": "A RecordReference is a low-level API that allows users and\naddon authors to perform meta-operations on a record.
The id of the record that this reference refers to.
Together, the type and id properties form a composite key for\nthe identity map.
Example
\n1\n2\n3\n | \n let userRef = store.getReference('user', 1);\n\nuserRef.id(); // '1' | \n
The identifier of the record that this reference refers to.
Together, the type and id properties form a composite key for\nthe identity map.
Example
\n1\n2\n3\n | \n let userRef = store.getReference('user', 1);\n\nuserRef.identifier(); // '1' | \n
How the reference will be looked up when it is loaded. Currently\nthis always returns identity to signify that a record will be\nloaded by its type and id.
Example
\n1\n2\n3\n | \n const userRef = store.getReference('user', 1);\n\nuserRef.remoteType(); // 'identity' | \n
This API allows you to provide a reference with new data. The\nsimplest usage of this API is similar to store.push: you provide a\nnormalized hash of data and the object represented by the reference\nwill update.
If you pass a promise to push, Ember Data will not ask the adapter\nfor the data if another attempt to fetch it is made in the\ninterim. When the promise resolves, the underlying object is updated\nwith the new data, and the promise returned by this function is resolved\nwith that object.
For example, recordReference.push(promise) will be resolved with a\nrecord.
Example
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n let userRef = store.getReference('user', 1);\n\n// provide data for reference\nuserRef.push({\n data: {\n id: "1",\n type: "user",\n attributes: {\n username: "@user"\n }\n }\n}).then(function(user) {\n userRef.value() === user;\n}); | \n
If the entity referred to by the reference is already loaded, it is\npresent as reference.value. Otherwise the value returned by this function\nis null.
Example
\n1\n2\n3\n | \n let userRef = store.getReference('user', 1);\n\nuserRef.value(); // user | \n
Triggers a fetch for the backing entity based on its remoteType\n(see remoteType definitions per reference type).
Example
\n1\n2\n3\n4\n | \n let userRef = store.getReference('user', 1);\n\n// load user (via store.find)\nuserRef.load().then(...) | \n
Reloads the record if it is already loaded. If the record is not\nloaded it will load the record via store.findRecord
Example
\n1\n2\n3\n4\n | \n let userRef = store.getReference('user', 1);\n\n// or trigger a reload\nuserRef.reload().then(...) | \n
This returns a string that represents how the reference will be\nlooked up when it is loaded. If the relationship has a link it will\nuse the "link" otherwise it defaults to "id".
\nExample
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '@ember-data/model';\n\nexport default Model.extend({\n comments: hasMany({ async: true })\n}); | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\n// get the identifier of the reference\nif (commentsRef.remoteType() === "ids") {\n let ids = commentsRef.ids();\n} else if (commentsRef.remoteType() === "link") {\n let link = commentsRef.link();\n} | \n
The link Ember Data will use to fetch or reload this belongs-to\nrelationship. By default it uses only the "related" resource linkage.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\nexport default Model.extend({\n user: belongsTo({ async: true })\n });\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n links: {\n related: '/articles/1/author'\n }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\n// get the identifier of the reference\nif (userRef.remoteType() === "link") {\n let link = userRef.link();\n } | \n
The meta data for the belongs-to relationship.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\nexport default Model.extend({\n user: belongsTo({ async: true })\n });\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n links: {\n related: {\n href: '/articles/1/author'\n },\n meta: {\n lastUpdated: 1458014400000\n }\n }\n }\n }\n }\n });\n\nlet userRef = blog.belongsTo('user');\n\nuserRef.meta() // { lastUpdated: 1458014400000 } | \n
This is the baseClass for the different References\nlike RecordReference/HasManyReference/BelongsToReference
\n", + "access": "public", + "tagname": "", + "methods": [ + { + "file": "../store/addon/-private/system/references/reference.ts", + "line": 61, + "description": "This returns a string that represents how the reference will be\nlooked up when it is loaded. If the relationship has a link it will\nuse the "link" otherwise it defaults to "id".
\nExample
\n| app/models/post.js | \n|
1\n2\n3\n4\n5\n | \n import Model, { hasMany } from '@ember-data/model';\n\nexport default Model.extend({\n comments: hasMany({ async: true })\n}); | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n | \n let post = store.push({\n data: {\n type: 'post',\n id: 1,\n relationships: {\n comments: {\n data: [{ type: 'comment', id: 1 }]\n }\n }\n }\n});\n\nlet commentsRef = post.hasMany('comments');\n\n// get the identifier of the reference\nif (commentsRef.remoteType() === "ids") {\n let ids = commentsRef.ids();\n} else if (commentsRef.remoteType() === "link") {\n let link = commentsRef.link();\n} | \n
The link Ember Data will use to fetch or reload this belongs-to\nrelationship. By default it uses only the "related" resource linkage.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\nexport default Model.extend({\n user: belongsTo({ async: true })\n });\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n links: {\n related: '/articles/1/author'\n }\n }\n }\n }\n });\nlet userRef = blog.belongsTo('user');\n\n// get the identifier of the reference\nif (userRef.remoteType() === "link") {\n let link = userRef.link();\n } | \n
The meta data for the belongs-to relationship.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n | \n // models/blog.js\nimport Model, { belongsTo } from '@ember-data/model';\nexport default Model.extend({\n user: belongsTo({ async: true })\n });\n\nlet blog = store.push({\n data: {\n type: 'blog',\n id: 1,\n relationships: {\n user: {\n links: {\n related: {\n href: '/articles/1/author'\n },\n meta: {\n lastUpdated: 1458014400000\n }\n }\n }\n }\n }\n });\n\nlet userRef = blog.belongsTo('user');\n\nuserRef.meta() // { lastUpdated: 1458014400000 } | \n
Snapshot is not directly instantiable.\nInstances are provided to a consuming application's\nadapters and serializers for certain requests.
\n", + "access": "public", + "tagname": "", + "methods": [ + { + "file": "../store/addon/-private/system/snapshot.ts", + "line": 59, + "itemtype": "method", + "name": "constructor", + "is_constructor": 1, + "access": "private", + "tagname": "", + "params": [ + { + "name": "options", + "description": "" + }, + { + "name": "identifier", + "description": "" + }, + { + "name": "_store", + "description": "" + } + ], + "class": "Snapshot", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot.ts", + "line": 199, + "description": "Returns the value of an attribute.
\nExample
\n1\n2\n3\n | \n // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });\npostSnapshot.attr('author'); // => 'Tomster'\npostSnapshot.attr('title'); // => 'Ember.js rocks' | \n
Note: Values are loaded eagerly and cached when the snapshot is created.
\n", + "itemtype": "method", + "name": "attr", + "params": [ + { + "name": "keyName", + "description": "", + "type": "String" + } + ], + "return": { + "description": "The attribute value or undefined", + "type": "Object" + }, + "access": "public", + "tagname": "", + "class": "Snapshot", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot.ts", + "line": 224, + "description": "Returns all attributes and their corresponding values.
\nExample
\n1\n2\n | \n // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });\npostSnapshot.attributes(); // => { author: 'Tomster', title: 'Ember.js rocks' } | \n
Returns all changed attributes and their old and new values.
\nExample
\n1\n2\n3\n | \n // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });\npostModel.set('title', 'Ember.js rocks!');\npostSnapshot.changedAttributes(); // => { title: ['Ember.js rocks', 'Ember.js rocks!'] } | \n
Returns the current value of a belongsTo relationship.
\nbelongsTo takes an optional hash of options as a second parameter,\ncurrently supported options are:
id: set to true if you only want the ID of the related record to be\nreturned.Example
\n1\n2\n3\n4\n5\n6\n7\n | \n // store.push('post', { id: 1, title: 'Hello World' });\n// store.createRecord('comment', { body: 'Lorem ipsum', post: post });\ncommentSnapshot.belongsTo('post'); // => Snapshot\ncommentSnapshot.belongsTo('post', { id: true }); // => '1'\n\n// store.push('comment', { id: 1, body: 'Lorem ipsum' });\ncommentSnapshot.belongsTo('post'); // => undefined | \n
Calling belongsTo will return a new Snapshot as long as there's any known\ndata for the relationship available, such as an ID. If the relationship is\nknown but unset, belongsTo will return null. If the contents of the\nrelationship is unknown belongsTo will return undefined.
Note: Relationships are loaded lazily and cached upon first access.
\n", + "itemtype": "method", + "name": "belongsTo", + "params": [ + { + "name": "keyName", + "description": "", + "type": "String" + }, + { + "name": "options", + "description": "", + "type": "Object", + "optional": true + } + ], + "access": "public", + "tagname": "", + "return": { + "description": "A snapshot or ID of a known\nrelationship or null if the relationship is known but unset. undefined\nwill be returned if the contents of the relationship is unknown.", + "type": "(Snapshot|String|null|undefined)" + }, + "class": "Snapshot", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot.ts", + "line": 377, + "description": "Returns the current value of a hasMany relationship.
\nhasMany takes an optional hash of options as a second parameter,\ncurrently supported options are:
ids: set to true if you only want the IDs of the related records to be\nreturned.Example
\n1\n2\n3\n4\n5\n6\n | \n // store.push('post', { id: 1, title: 'Hello World', comments: [2, 3] });\npostSnapshot.hasMany('comments'); // => [Snapshot, Snapshot]\npostSnapshot.hasMany('comments', { ids: true }); // => ['2', '3']\n\n// store.push('post', { id: 1, title: 'Hello World' });\npostSnapshot.hasMany('comments'); // => undefined | \n
Note: Relationships are loaded lazily and cached upon first access.
\n", + "itemtype": "method", + "name": "hasMany", + "params": [ + { + "name": "keyName", + "description": "", + "type": "String" + }, + { + "name": "options", + "description": "", + "type": "Object", + "optional": true + } + ], + "access": "public", + "tagname": "", + "return": { + "description": "An array of snapshots or IDs of a known\nrelationship or an empty array if the relationship is known but unset.\nundefined will be returned if the contents of the relationship is unknown.", + "type": "(Array|undefined)" + }, + "class": "Snapshot", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot.ts", + "line": 476, + "description": "Iterates through all the attributes of the model, calling the passed\nfunction on each attribute.
\nExample
\n1\n2\n3\n | \n snapshot.eachAttribute(function(name, meta) {\n // ...\n}); | \n
Iterates through all the relationships of the model, calling the passed\nfunction on each relationship.
\nExample
\n1\n2\n3\n | \n snapshot.eachRelationship(function(name, relationship) {\n // ...\n}); | \n
Serializes the snapshot using the serializer for the model.
\nExample
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import Adapter from '@ember-data/adapter';\n\nexport default Adapter.extend({\n createRecord(store, type, snapshot) {\n let data = snapshot.serialize({ includeId: true });\n let url = `/${type.modelName}`;\n\n return fetch(url, {\n method: 'POST',\n body: data,\n }).then((response) => response.json())\n }\n}); | \n
The id of the snapshot's underlying record
\nExample
\n1\n2\n | \n // store.push('post', { id: 1, author: 'Tomster', title: 'Ember.js rocks' });\npostSnapshot.id; // => '1' | \n
A hash of adapter options
\n", + "itemtype": "property", + "name": "adapterOptions", + "type": "{Object}", + "access": "public", + "tagname": "", + "class": "Snapshot", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot.ts", + "line": 110, + "description": "If include was passed to the options hash for the request, the value\nwould be available here.
The name of the type of the underlying record for this snapshot, as a string.
\n", + "itemtype": "property", + "name": "modelName", + "type": "{String}", + "access": "public", + "tagname": "", + "class": "Snapshot", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot.ts", + "line": 133, + "description": "The underlying record for this snapshot. Can be used to access methods and\nproperties defined on the record.
\nExample
\n1\n | \n let json = snapshot.record.toJSON(); | \n
The type of the underlying record for this snapshot, as a Model.
\n", + "itemtype": "property", + "name": "type", + "access": "public", + "tagname": "", + "type": "{Model}", + "class": "Snapshot", + "module": "@ember-data/store" + } + ] + }, + "relationships": { + "parent-class": { + "data": null + }, + "descendants": { + "data": [] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/store", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-SnapshotRecordArray-d7fdb43022.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-SnapshotRecordArray-d7fdb43022.json new file mode 100644 index 000000000..e9b0c5095 --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-SnapshotRecordArray-d7fdb43022.json @@ -0,0 +1,186 @@ +{ + "data": { + "id": "ember-data-3.28.13-SnapshotRecordArray", + "type": "class", + "attributes": { + "name": "SnapshotRecordArray", + "shortname": "SnapshotRecordArray", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/store", + "namespace": "", + "file": "../store/addon/-private/system/snapshot-record-array.ts", + "line": 8, + "description": "SnapshotRecordArray is not directly instantiable.\nInstances are provided to consuming application's\nadapters for certain requests.
\n", + "access": "public", + "tagname": "", + "methods": [ + { + "file": "../store/addon/-private/system/snapshot-record-array.ts", + "line": 26, + "description": "SnapshotRecordArray is not directly instantiable.\nInstances are provided to consuming application's\nadapters and serializers for certain requests.
\n", + "itemtype": "method", + "name": "constructor", + "access": "private", + "tagname": "", + "is_constructor": 1, + "params": [ + { + "name": "recordArray", + "description": "", + "type": "RecordArray" + }, + { + "name": "meta", + "description": "", + "type": "Object" + }, + { + "name": "options", + "description": "" + } + ], + "class": "SnapshotRecordArray", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot-record-array.ts", + "line": 168, + "description": "Get snapshots of the underlying record array
\nExample
\n| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class PostAdapter extends JSONAPIAdapter {\n shouldReloadAll(store, snapshotArray) {\n let snapshots = snapshotArray.snapshots();\n\n return snapshots.any(function(ticketSnapshot) {\n let timeDiff = moment().diff(ticketSnapshot.attr('lastAccessedAt'), 'minutes');\n if (timeDiff > 20) {\n return true;\n } else {\n return false;\n }\n });\n }\n} | \n
An array of snapshots
\n", + "access": "private", + "tagname": "", + "itemtype": "property", + "name": "_snapshots", + "type": "{Array}", + "class": "SnapshotRecordArray", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot-record-array.ts", + "line": 47, + "description": "An array of records
\n", + "access": "private", + "tagname": "", + "itemtype": "property", + "name": "_recordArray", + "type": "{Array}", + "class": "SnapshotRecordArray", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot-record-array.ts", + "line": 55, + "description": "Number of records in the array
\nExample
\n| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class PostAdapter extends JSONAPIAdapter {\n shouldReloadAll(store, snapshotRecordArray) {\n return !snapshotRecordArray.length;\n }\n}); | \n
Meta objects for the record array.
\nExample
\n| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class PostAdapter extends JSONAPIAdapter {\n shouldReloadAll(store, snapshotRecordArray) {\n let lastRequestTime = snapshotRecordArray.meta.lastRequestTime;\n let twentyMinutes = 20 * 60 * 1000;\n return Date.now() > lastRequestTime + twentyMinutes;\n }\n}); | \n
A hash of adapter options passed into the store method for this request.
\nExample
\n| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import MyCustomAdapter from './custom-adapter';\n\nexport default class PostAdapter extends MyCustomAdapter {\n findAll(store, type, sinceToken, snapshotRecordArray) {\n if (snapshotRecordArray.adapterOptions.subscribe) {\n // ...\n }\n // ...\n }\n} | \n
The relationships to include for this request.
\nExample
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import Adapter from '-data/adapter';\n\nexport default class ApplicationAdapter extends Adapter {\n findAll(store, type, snapshotRecordArray) {\n let url = `/${type.modelName}?include=${encodeURIComponent(snapshotRecordArray.include)}`;\n\n return fetch(url).then((response) => response.json())\n }\n} | \n
The type of the underlying records for the snapshots in the array, as a Model
\n", + "itemtype": "property", + "name": "type", + "access": "public", + "tagname": "", + "type": "{Model}", + "class": "SnapshotRecordArray", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/snapshot-record-array.ts", + "line": 158, + "description": "The modelName of the underlying records for the snapshots in the array, as a Model
\n", + "itemtype": "property", + "name": "modelName", + "access": "public", + "tagname": "", + "type": "{Model}", + "class": "SnapshotRecordArray", + "module": "@ember-data/store" + } + ] + }, + "relationships": { + "parent-class": { + "data": null + }, + "descendants": { + "data": [] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/store", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-Store-cadfb8849f.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-Store-cadfb8849f.json new file mode 100644 index 000000000..63d3f91ce --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-Store-cadfb8849f.json @@ -0,0 +1,1076 @@ +{ + "data": { + "id": "ember-data-3.28.13-Store", + "type": "class", + "attributes": { + "name": "Store", + "shortname": "Store", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/store", + "namespace": "", + "file": "../store/addon/-private/system/core-store.ts", + "line": 149, + "description": "The store contains all of the data for records loaded from the server.\nIt is also responsible for creating instances of Model that wrap\nthe individual data for a record, so that they can be bound to in your\nHandlebars templates.
Define your application's store like this:
\n| app/services/store.js | \n|
1\n2\n3\n | \n import Store from '-data/store';\n\nexport default class MyStore extends Store {} | \n
Most Ember.js applications will only have a single Store that is\nautomatically created by their Ember.Application.
You can retrieve models from the store in several ways. To retrieve a record\nfor a specific id, use Store's findRecord() method:
1\n2\n | \n store.findRecord('person', 123).then(function (person) {\n}); | \n
By default, the store will talk to your backend using a standard\nREST mechanism. You can customize how the store talks to your\nbackend by specifying a custom adapter:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n | \n import Adapter from '-data/adapter';\n\nexport default class ApplicationAdapter extends Adapter {\n} | \n
You can learn more about writing a custom adapter by reading the Adapter\ndocumentation.
The store provides multiple ways to create new record objects. They have\nsome subtle differences in their use which are detailed below:
\ncreateRecord is used for creating new\nrecords on the client side. This will return a new record in the\ncreated.uncommitted state. In order to persist this record to the\nbackend, you will need to call record.save().
push is used to notify Ember Data's store of new or\nupdated records that exist in the backend. This will return a record\nin the loaded.saved state. The primary use-case for store#push is\nto notify Ember Data about record updates (full or partial) that happen\noutside of the normal adapter methods (for example\nSSE or Web\nSockets).
pushPayload is a convenience wrapper for\nstore#push that will deserialize payloads if the\nSerializer implements a pushPayload method.
Note: When creating a new record using any of the above methods\nEmber Data will update RecordArrays such as those returned by\nstore#peekAll() or store#findAll(). This means any\ndata bindings or computed properties that depend on the RecordArray\nwill automatically be synced to include the new or updated record\nvalues.\n @mainName @ember-data/store\n @tag main
Returns the schema for a particular modelName.
When used with Model from @ember-data/model the return is the model class,\nbut this is not guaranteed.
\nThe class of a model might be useful if you want to get a list of all the\nrelationship names of the model, see\nrelationshipNames\nfor example.
Returns whether a ModelClass exists for a given modelName\nThis exists for legacy support for the RESTSerializer,\nwhich due to how it must guess whether a key is a model\nmust query for whether a match exists.
\nWe should investigate an RFC to make this public or removing\nthis requirement.
\n", + "itemtype": "method", + "name": "_hasModelFor", + "access": "private", + "tagname": "", + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 598, + "description": "Create a new record in the current store. The properties passed\nto this method are set on the newly created record.
\nTo create a new instance of a Post:
1\n2\n3\n | \n store.createRecord('post', {\n title: 'Ember is awesome!'\n}); | \n
To create a new instance of a Post that has a relationship with a User record:
1\n2\n3\n4\n5\n | \n let user = this.store.peekRecord('user', 1);\nstore.createRecord('post', {\n title: 'Ember is awesome!',\n user: user\n}); | \n
If possible, this method asks the adapter to generate an ID for\na newly created record.
\n", + "itemtype": "method", + "name": "_generateId", + "access": "private", + "tagname": "", + "params": [ + { + "name": "modelName", + "description": "", + "type": "String" + }, + { + "name": "properties", + "description": "from the new record", + "type": "Object" + } + ], + "return": { + "description": "if the adapter can generate one, an ID", + "type": "String" + }, + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 695, + "description": "For symmetry, a record can be deleted via the store.
\nExample
\n1\n2\n3\n4\n5\n | \n let post = store.createRecord('post', {\n title: 'Ember is awesome!'\n});\n\nstore.deleteRecord(post); | \n
For symmetry, a record can be unloaded via the store.\nThis will cause the record to be destroyed and freed up for garbage collection.
\nExample
\n1\n2\n3\n | \n store.findRecord('post', 1).then(function(post) {\n store.unloadRecord(post);\n}); | \n
This method returns a record for a given type and id combination.
\nThe findRecord method will always resolve its promise with the same\nobject for a given type and id.
The findRecord method will always return a promise that will be\nresolved with the record.
Example
\n| app/routes/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Route from '/routing/route';\n\nexport default class PostRoute extends Route {\n model(params) {\n return this.store.findRecord('post', params.post_id);\n }\n} | \n
If the record is not yet available, the store will ask the adapter's find\nmethod to find the necessary data. If the record is already present in the\nstore, it depends on the reload behavior when the returned promise\nresolves.
You can optionally preload specific attributes and relationships that you know of\nby passing them via the passed options.
For example, if your Ember route looks like /posts/1/comments/2 and your API route\nfor the comment also looks like /posts/1/comments/2 if you want to fetch the comment\nwithout fetching the post you can pass in the post to the findRecord call:
1\n | \n store.findRecord('comment', 2, { preload: { post: 1 } }); | \n
If you have access to the post model you can also pass the model itself:
\n1\n2\n3\n | \n store.findRecord('post', 1).then(function (myPostModel) {\n store.findRecord('comment', 2, { post: myPostModel });\n}); | \n
The reload behavior is configured either via the passed options hash or\nthe result of the adapter's shouldReloadRecord.
If { reload: true } is passed or adapter.shouldReloadRecord evaluates\nto true, then the returned promise resolves once the adapter returns\ndata, regardless if the requested record is already in the store:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n | \n store.push({\n data: {\n id: 1,\n type: 'post',\n revision: 1\n }\n});\n\n// adapter#findRecord resolves with\n// [\n// {\n// id: 1,\n// type: 'post',\n// revision: 2\n// }\n// ]\nstore.findRecord('post', 1, { reload: true }).then(function(post) {\n post.get('revision'); // 2\n}); | \n
If no reload is indicated via the above mentioned ways, then the promise\nimmediately resolves with the cached version in the store.
\nOptionally, if adapter.shouldBackgroundReloadRecord evaluates to true,\nthen a background reload is started, which updates the records' data, once\nit is available:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n34\n35\n36\n37\n | \n // app/adapters/post.js\nimport ApplicationAdapter from "./application";\n\nexport default class PostAdapter extends ApplicationAdapter {\n shouldReloadRecord(store, snapshot) {\n return false;\n },\n\n shouldBackgroundReloadRecord(store, snapshot) {\n return true;\n }\n});\n\n// ...\n\nstore.push({\n data: {\n id: 1,\n type: 'post',\n revision: 1\n }\n});\n\nlet blogPost = store.findRecord('post', 1).then(function(post) {\n post.get('revision'); // 1\n});\n\n// later, once adapter#findRecord resolved with\n// [\n// {\n// id: 1,\n// type: 'post',\n// revision: 2\n// }\n// ]\n\nblogPost.get('revision'); // 2 | \n
If you would like to force or prevent background reloading, you can set a\nboolean value for backgroundReload in the options object for\nfindRecord.
| app/routes/post/edit.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Route from '/routing/route';\n\nexport default class PostEditRoute extends Route {\n model(params) {\n return this.store.findRecord('post', params.post_id, { backgroundReload: false });\n }\n} | \n
If you pass an object on the adapterOptions property of the options\nargument it will be passed to your adapter via the snapshot
| app/routes/post/edit.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import Route from '/routing/route';\n\nexport default class PostEditRoute extends Route {\n model(params) {\n return this.store.findRecord('post', params.post_id, {\n adapterOptions: { subscribe: false }\n });\n }\n} | \n
| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import MyCustomAdapter from './custom-adapter';\n\nexport default class PostAdapter extends MyCustomAdapter {\n findRecord(store, type, id, snapshot) {\n if (snapshot.adapterOptions.subscribe) {\n // ...\n }\n // ...\n }\n} | \n
See peekRecord to get the cached version of a record.
\nIf you use an adapter such as Ember's default\nJSONAPIAdapter\nthat supports the JSON API specification and if your server\nendpoint supports the use of an\n'include' query parameter,\nyou can use findRecord() or findAll() to automatically retrieve additional records related to\nthe one you request by supplying an include parameter in the options object.
For example, given a post model that has a hasMany relationship with a comment\nmodel, when we retrieve a specific post we can have the server also return that post's\ncomments in the same request:
| app/routes/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Route from '/routing/route';\n\nexport default class PostRoute extends Route {\n model(params) {\n return this.store.findRecord('post', params.post_id, { include: 'comments' });\n }\n} | \n
In this case, the post's comments would then be available in your template as\nmodel.comments.
Multiple relationships can be requested using an include parameter consisting of a\ncomma-separated list (without white-space) while nested relationships can be specified\nusing a dot-separated sequence of relationship names. So to request both the post's\ncomments and the authors of those comments the request would look like this:
| app/routes/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Route from '/routing/route';\n\nexport default class PostRoute extends Route {\n model(params) {\n return this.store.findRecord('post', params.post_id, { include: 'comments,comments.author' });\n }\n} | \n
If your server endpoint supports the use of a 'fields' query parameter,\nyou can use pass those fields through to your server. At this point in time, this requires a few manual steps on your part.
\nbuildQuery in your adapter.| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n buildQuery(snapshot) {\n let query = this._super(...arguments);\n\n let { fields } = snapshot.adapterOptions;\n\n if (fields) {\n query.fields = fields;\n }\n\n return query;\n} | \n
findRecord request.Given a post model with attributes body, title, publishDate and meta, you can retrieve a filtered list of attributes.
| app/routes/post.js | \n|
1\n2\n3\n4\n5\n6\n | \n import Route from '@ember/routing/route';\nexport default Route.extend({\n model(params) {\n return this.store.findRecord('post', params.post_id, { adapterOptions: { fields: { post: 'body,title' } });\n }\n}); | \n
Moreover, you can filter attributes on related models as well. If a post has a belongsTo relationship to a user,\njust include the relationship key and attributes.
| app/routes/post.js | \n|
1\n2\n3\n4\n5\n6\n | \n import Route from '@ember/routing/route';\nexport default Route.extend({\n model(params) {\n return this.store.findRecord('post', params.post_id, { adapterOptions: { fields: { post: 'body,title', user: 'name,email' } });\n }\n}); | \n
This method makes a series of requests to the adapter's find method\nand returns a promise that resolves once they are all loaded.
This method is called by findRecord if it discovers that a particular\ntype/id pair hasn't been loaded yet to kick off a request to the\nadapter.
Get the reference for the specified record.
\nExample
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n | \n let userRef = store.getReference('user', 1);\n\n// check if the user is loaded\nlet isLoaded = userRef.value() !== null;\n\n// get the record of the reference (null if not yet available)\nlet user = userRef.value();\n\n// get the identifier of the reference\nif (userRef.remoteType() === 'id') {\nlet id = userRef.id();\n}\n\n// load user (via store.find)\nuserRef.load().then(...)\n\n// or trigger a reload\nuserRef.reload().then(...)\n\n// provide data for reference\nuserRef.push({ id: 1, username: '@user' }).then(function(user) {\n userRef.value() === user;\n}); | \n
Get a record by a given type and ID without triggering a fetch.
\nThis method will synchronously return the record if it is available in the store,\notherwise it will return null. A record is available if it has been fetched earlier, or\npushed manually into the store.
See findRecord if you would like to request this record from the backend.
\nNote: This is a synchronous method and does not return a promise.
\n1\n2\n3\n | \n let post = store.peekRecord('post', 1);\n\npost.get('id'); // 1 | \n
This method is called by the record's reload method.
This method calls the adapter's find method, which returns a promise. When\nthat promise resolves, _reloadRecord will resolve the promise returned\nby the record's reload.
This method returns true if a record for a given modelName and id is already\nloaded in the store. Use this function to know beforehand if a findRecord()\nwill result in a request or that it will be a cache hit.
\nExample
\n1\n2\n3\n4\n | \n store.hasRecordForId('post', 1); // false\nstore.findRecord('post', 1).then(function() {\n store.hasRecordForId('post', 1); // true\n}); | \n
Returns id record for a given type and ID. If one isn't already loaded,\nit builds a new record and leaves it in the empty state.
If a relationship was originally populated by the adapter as a link\n(as opposed to a list of IDs), this method is called when the\nrelationship is fetched.
\nThe link (which is usually a URL) is passed through unchanged, so the\nadapter can make whatever request it wants.
\nThe usual use-case is for the server to register a URL as a link, and\nthen use that URL in the future to make a request for the relationship.
\n", + "itemtype": "method", + "name": "findHasMany", + "access": "private", + "tagname": "", + "params": [ + { + "name": "internalModel", + "description": "", + "type": "InternalModel" + }, + { + "name": "link", + "description": "", + "type": "Any" + }, + { + "name": "relationship", + "description": "", + "type": "(Relationship)" + } + ], + "return": { + "description": "promise", + "type": "Promise" + }, + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 1836, + "itemtype": "method", + "name": "findBelongsTo", + "access": "private", + "tagname": "", + "params": [ + { + "name": "internalModel", + "description": "", + "type": "InternalModel" + }, + { + "name": "link", + "description": "", + "type": "Any" + }, + { + "name": "relationship", + "description": "", + "type": "Relationship" + } + ], + "return": { + "description": "promise", + "type": "Promise" + }, + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 1949, + "description": "This method delegates a query to the adapter. This is the one place where\nadapter-level semantics are exposed to the application.
\nEach time this method is called a new request is made through the adapter.
\nExposing queries this way seems preferable to creating an abstract query\nlanguage for all server-side queries, and then require all adapters to\nimplement them.
\nIf you do something like this:
\n1\n | \n store.query('person', { page: 1 }); | \n
The request made to the server will look something like this:
\n1\n | \n GET "/api/v1/person?page=1" | \n
If you do something like this:
\n1\n | \n store.query('person', { ids: [1, 2, 3] }); | \n
The request made to the server will look something like this:
\n1\n2\n | \n GET "/api/v1/person?ids%5B%5D=1&ids%5B%5D=2&ids%5B%5D=3"\ndecoded: "/api/v1/person?ids[]=1&ids[]=2&ids[]=3" | \n
This method returns a promise, which is resolved with an\nAdapterPopulatedRecordArray\nonce the server returns.
This method makes a request for one record, where the id is not known\nbeforehand (if the id is known, use findRecord\ninstead).
This method can be used when it is certain that the server will return a\nsingle object for the primary data.
\nEach time this method is called a new request is made through the adapter.
\nLet's assume our API provides an endpoint for the currently logged in user\nvia:
\n1\n2\n3\n4\n5\n6\n7\n | \n // GET /api/current_user\n{\n user: {\n id: 1234,\n username: 'admin'\n }\n} | \n
Since the specific id of the user is not known beforehand, we can use\nqueryRecord to get the user:
1\n2\n3\n4\n | \n store.queryRecord('user', {}).then(function(user) {\n let username = user.get('username');\n console.log(`Currently logged in as ${username}`);\n}); | \n
The request is made through the adapters' queryRecord:
| app/adapters/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Adapter from '-data/adapter';\nimport $ from 'jquery';\n\nexport default class UserAdapter extends Adapter {\n queryRecord(modelName, query) {\n return $.getJSON('/api/current_user');\n }\n} | \n
Note: the primary use case for store.queryRecord is when a single record\nis queried and the id is not known beforehand. In all other cases\nstore.query and using the first item of the array is likely the preferred\nway:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n // GET /users?username=unique\n{\n data: [{\n id: 1234,\n type: 'user',\n attributes: {\n username: "unique"\n }\n }]\n} | \n
1\n2\n3\n4\n5\n | \n store.query('user', { username: 'unique' }).then(function(users) {\n return users.get('firstObject');\n}).then(function(user) {\n let id = user.get('id');\n}); | \n
This method returns a promise, which resolves with the found record.
\nIf the adapter returns no data for the primary data of the payload, then\nqueryRecord resolves with null:
1\n2\n3\n4\n | \n // GET /users?username=unique\n{\n data: null\n} | \n
1\n2\n3\n | \n store.queryRecord('user', { username: 'unique' }).then(function(user) {\n console.log(user); // null\n}); | \n
findAll asks the adapter's findAll method to find the records for the\ngiven type, and returns a promise which will resolve with all records of\nthis type present in the store, even if the adapter only returns a subset\nof them.
| app/routes/authors.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Route from '/routing/route';\n\nexport default class AuthorsRoute extends Route {\n model(params) {\n return this.store.findAll('author');\n }\n} | \n
When the returned promise resolves depends on the reload behavior,\nconfigured via the passed options hash and the result of the adapter's\nshouldReloadAll method.
If { reload: true } is passed or adapter.shouldReloadAll evaluates to\ntrue, then the returned promise resolves once the adapter returns data,\nregardless if there are already records in the store:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n store.push({\n data: {\n id: 'first',\n type: 'author'\n }\n});\n\n// adapter#findAll resolves with\n// [\n// {\n// id: 'second',\n// type: 'author'\n// }\n// ]\nstore.findAll('author', { reload: true }).then(function(authors) {\n authors.getEach('id'); // ['first', 'second']\n}); | \n
If no reload is indicated via the above mentioned ways, then the promise\nimmediately resolves with all the records currently loaded in the store.
\nOptionally, if adapter.shouldBackgroundReloadAll evaluates to true,\nthen a background reload is started. Once this resolves, the array with\nwhich the promise resolves, is updated automatically so it contains all the\nrecords in the store:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n34\n35\n36\n37\n | \n import Adapter from '@ember-data/adapter';\n\nexport default class ApplicationAdapter extends Adapter {\n shouldReloadAll(store, snapshotsArray) {\n return false;\n },\n\n shouldBackgroundReloadAll(store, snapshotsArray) {\n return true;\n }\n});\n\n// ...\n\nstore.push({\n data: {\n id: 'first',\n type: 'author'\n }\n});\n\nlet allAuthors;\nstore.findAll('author').then(function(authors) {\n authors.getEach('id'); // ['first']\n\n allAuthors = authors;\n});\n\n// later, once adapter#findAll resolved with\n// [\n// {\n// id: 'second',\n// type: 'author'\n// }\n// ]\n\nallAuthors.getEach('id'); // ['first', 'second'] | \n
If you would like to force or prevent background reloading, you can set a\nboolean value for backgroundReload in the options object for\nfindAll.
| app/routes/post/edit.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Route from '/routing/route';\n\nexport default class PostEditRoute extends Route {\n model() {\n return this.store.findAll('post', { backgroundReload: false });\n }\n} | \n
If you pass an object on the adapterOptions property of the options\nargument it will be passed to you adapter via the snapshotRecordArray
| app/routes/posts.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import Route from '/routing/route';\n\nexport default class PostsRoute extends Route {\n model(params) {\n return this.store.findAll('post', {\n adapterOptions: { subscribe: false }\n });\n }\n} | \n
| app/adapters/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n import MyCustomAdapter from './custom-adapter';\n\nexport default class UserAdapter extends MyCustomAdapter {\n findAll(store, type, sinceToken, snapshotRecordArray) {\n if (snapshotRecordArray.adapterOptions.subscribe) {\n // ...\n }\n // ...\n }\n} | \n
See peekAll to get an array of current records in the\nstore, without waiting until a reload is finished.
\nIf you use an adapter such as Ember's default\nJSONAPIAdapter\nthat supports the JSON API specification and if your server\nendpoint supports the use of an\n'include' query parameter,\nyou can use findAll() to automatically retrieve additional records related to\nthose requested by supplying an include parameter in the options object.
For example, given a post model that has a hasMany relationship with a comment\nmodel, when we retrieve all of the post records we can have the server also return\nall of the posts' comments in the same request:
| app/routes/posts.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Route from '/routing/route';\n\nexport default class PostsRoute extends Route {\n model() {\n return this.store.findAll('post', { include: 'comments' });\n }\n} | \n
Multiple relationships can be requested using an include parameter consisting of a\ncomma-separated list (without white-space) while nested relationships can be specified\nusing a dot-separated sequence of relationship names. So to request both the posts'\ncomments and the authors of those comments the request would look like this:
| app/routes/posts.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Route from '/routing/route';\n\nexport default class PostsRoute extends Route {\n model() {\n return this.store.findAll('post', { include: 'comments,comments.author' });\n }\n} | \n
See query to only get a subset of records from the server.
\n", + "since": "1.13.0", + "itemtype": "method", + "name": "findAll", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelName", + "description": "", + "type": "String" + }, + { + "name": "options", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "promise", + "type": "Promise" + }, + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 2380, + "itemtype": "method", + "name": "_fetchAll", + "access": "private", + "tagname": "", + "params": [ + { + "name": "modelName", + "description": "", + "type": "Model" + }, + { + "name": "array", + "description": "", + "type": "RecordArray" + } + ], + "return": { + "description": "promise", + "type": "Promise" + }, + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 2429, + "itemtype": "method", + "name": "_didUpdateAll", + "params": [ + { + "name": "modelName", + "description": "", + "type": "String" + } + ], + "access": "private", + "tagname": "", + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 2438, + "description": "This method returns a filtered array that contains all of the\nknown records for a given type in the store.
\nNote that because it's just a filter, the result will contain any\nlocally created records of the type, however, it will not make a\nrequest to the backend to retrieve additional records. If you\nwould like to request all the records from the backend please use\nstore.findAll.
\nAlso note that multiple calls to peekAll for a given type will always\nreturn the same RecordArray.
Example
\n1\n | \n let localPosts = store.peekAll('post'); | \n
This method unloads all records in the store.\nIt schedules unloading to happen during the next run loop.
\nOptionally you can pass a type which unload all records for a given type.
\n1\n2\n | \n store.unloadAll();\nstore.unloadAll('post'); | \n
This method is called by record.save, and gets passed a\nresolver for the promise that record.save returns.
It schedules saving to happen at the end of the run loop.
\n", + "itemtype": "method", + "name": "scheduleSave", + "access": "private", + "tagname": "", + "params": [ + { + "name": "internalModel", + "description": "", + "type": "InternalModel" + }, + { + "name": "resolver", + "description": "", + "type": "Resolver" + }, + { + "name": "options", + "description": "", + "type": "Object" + } + ], + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 2602, + "description": "This method is called at the end of the run loop, and\nflushes any records passed into scheduleSave
This method is called once the promise returned by an\nadapter's createRecord, updateRecord or deleteRecord\nis resolved.
If the data provides a server-generated ID, it will\nupdate the record and the store's indexes.
\n", + "itemtype": "method", + "name": "didSaveRecord", + "access": "private", + "tagname": "", + "params": [ + { + "name": "internalModel", + "description": "the in-flight internal model", + "type": "InternalModel" + }, + { + "name": "data", + "description": "optional data (see above)", + "type": "Object" + }, + { + "name": "op", + "description": "the adapter operation that was committed", + "type": "String" + } + ], + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 2694, + "description": "This method is called once the promise returned by an\nadapter's createRecord, updateRecord or deleteRecord\nis rejected with a InvalidError.
This method is called once the promise returned by an\nadapter's createRecord, updateRecord or deleteRecord\nis rejected (with anything other than a InvalidError).
Sets newly received ID from the adapter's createRecord, updateRecord\nor deleteRecord.
This internal method is used by push.
Push some data for a given type into the store.
\nThis method expects normalized JSON API document. This means you have to follow JSON API specification with few minor adjustments:
\ntype should always be in singular, dasherized formYour primary data should be wrapped inside data property:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n store.push({\n data: {\n // primary data for single record of type `Person`\n id: '1',\n type: 'person',\n attributes: {\n firstName: 'Daniel',\n lastName: 'Kmak'\n }\n }\n}); | \n
data property can also hold an array (of records):
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n | \n store.push({\n data: [\n // an array of records\n {\n id: '1',\n type: 'person',\n attributes: {\n firstName: 'Daniel',\n lastName: 'Kmak'\n }\n },\n {\n id: '2',\n type: 'person',\n attributes: {\n firstName: 'Tom',\n lastName: 'Dale'\n }\n }\n ]\n}); | \n
There are some typical properties for JSONAPI payload:
id - mandatory, unique record's keytype - mandatory string which matches model's dasherized name in singular formattributes - object which holds data for record attributes - attr's declared in modelrelationships - object which must contain any of the following properties under each relationships' respective key (example path is relationships.achievements.data):\nFor this model:
\n| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, hasMany } from '-data/model';\n\nexport default class PersonRoute extends Route {\n ('string') firstName;\n ('string') lastName;\n\n ('person') children;\n} | \n
To represent the children as IDs:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n | \n {\n data: {\n id: '1',\n type: 'person',\n attributes: {\n firstName: 'Tom',\n lastName: 'Dale'\n },\n relationships: {\n children: {\n data: [\n {\n id: '2',\n type: 'person'\n },\n {\n id: '3',\n type: 'person'\n },\n {\n id: '4',\n type: 'person'\n }\n ]\n }\n }\n }\n} | \n
To represent the children relationship as a URL:
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n {\n data: {\n id: '1',\n type: 'person',\n attributes: {\n firstName: 'Tom',\n lastName: 'Dale'\n },\n relationships: {\n children: {\n links: {\n related: '/people/1/children'\n }\n }\n }\n }\n} | \n
If you're streaming data or implementing an adapter, make sure\nthat you have converted the incoming data into this form. The\nstore's normalize method is a convenience\nhelper for converting a json payload into the form Ember Data\nexpects.
\n1\n | \n store.push(store.normalize('person', data)); | \n
This method can be used both to push in brand new\nrecords, as well as to update existing records.
\n", + "itemtype": "method", + "name": "push", + "access": "public", + "tagname": "", + "params": [ + { + "name": "data", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "the record(s) that was created or\n updated." + }, + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 2969, + "description": "Push some data in the form of a json-api document into the store,\nwithout creating materialized records.
\n", + "itemtype": "method", + "name": "_push", + "access": "private", + "tagname": "", + "params": [ + { + "name": "jsonApiDoc", + "description": "", + "type": "Object" + } + ], + "return": { + "description": "pushed InternalModel(s)", + "type": "InternalModel|ArrayPush some raw data into the store.
\nThis method can be used both to push in brand new\nrecords, as well as to update existing records. You\ncan push in more than one type of object at once.\nAll objects should be in the format expected by the\nserializer.
\n| app/serializers/application.js | \n|
1\n2\n3\n | \n import RESTSerializer from '-data/serializer/rest';\n\nexport default class ApplicationSerializer extends RESTSerializer; | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n let pushData = {\n posts: [\n { id: 1, postTitle: "Great post", commentIds: [2] }\n ],\n comments: [\n { id: 2, commentBody: "Insightful comment" }\n ]\n}\n\nstore.pushPayload(pushData); | \n
By default, the data will be deserialized using a default\nserializer (the application serializer if it exists).
\nAlternatively, pushPayload will accept a model type which\nwill determine which serializer will process the payload.
| app/serializers/application.js | \n|
1\n2\n3\n | \n import RESTSerializer from '-data/serializer/rest';\n\n export default class ApplicationSerializer extends RESTSerializer; | \n
| app/serializers/post.js | \n|
1\n2\n3\n | \n import JSONSerializer from '@ember-data/serializer/json';\n\nexport default JSONSerializer; | \n
1\n2\n | \n store.pushPayload(pushData); // Will use the application serializer\nstore.pushPayload('post', pushData); // Will use the post serializer | \n
Instantiation hook allowing applications or addons to configure the store\nto utilize a custom RecordData implementation.
\n", + "itemtype": "method", + "name": "createRecordDataFor", + "access": "public", + "tagname": "", + "params": [ + { + "name": "modelName", + "description": "" + }, + { + "name": "id", + "description": "" + }, + { + "name": "clientId", + "description": "" + }, + { + "name": "storeWrapper", + "description": "" + } + ], + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 3302, + "description": "normalize converts a json payload into the normalized form that\npush expects.
Example
\n1\n2\n3\n4\n5\n | \n socket.on('message', function(message) {\n let modelName = message.model;\n let data = message.data;\n store.push(store.normalize(modelName, data));\n}); | \n
Returns an instance of the adapter for a given type. For\nexample, adapterFor('person') will return an instance of\nApp.PersonAdapter.
If no App.PersonAdapter is found, this method will look\nfor an App.ApplicationAdapter (the default adapter for\nyour entire application).
If no App.ApplicationAdapter is found, it will return\nthe value of the defaultAdapter.
Returns an instance of the serializer for a given type. For\nexample, serializerFor('person') will return an instance of\nApp.PersonSerializer.
If no App.PersonSerializer is found, this method will look\nfor an App.ApplicationSerializer (the default serializer for\nyour entire application).
if no App.ApplicationSerializer is found, it will attempt\nto get the defaultSerializer from the PersonAdapter\n(adapterFor('person')).
If a serializer cannot be found on the adapter, it will fall back\nto an instance of JSONSerializer.
EmberData specific backburner instance
\n", + "itemtype": "property", + "name": "_backburner", + "access": "private", + "tagname": "", + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 267, + "description": "The default adapter to use to communicate to a backend server or\nother persistence layer. This will be overridden by an application\nadapter if present.
\nIf you want to specify app/adapters/custom.js as a string, do:
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Store from '@ember-data/store';\n\nexport default Store.extend({\n constructor() {\n super(...arguments);\n this.adapter = 'custom';\n }\n} | \n
This property returns the adapter, after resolving a possible\nstring key.
\nIf the supplied adapter was a class, or a String property\npath resolved to a class, this property will instantiate the\nclass.
This property is cacheable, so the same instance of a specified\nadapter class should be used for the lifetime of the store.
\n", + "itemtype": "property", + "name": "defaultAdapter", + "access": "private", + "tagname": "", + "return": { + "description": "Adapter" + }, + "class": "Store", + "module": "@ember-data/store" + }, + { + "file": "../store/addon/-private/system/core-store.ts", + "line": 429, + "description": "Provides access to the IdentifierCache instance\nfor this store.
\nThe IdentifierCache can be used to generate or\nretrieve a stable unique identifier for any resource.
\n", + "itemtype": "property", + "name": "identifierCache", + "type": "IdentifierCache", + "access": "public", + "tagname": "", + "class": "Store", + "module": "@ember-data/store" + } + ] + }, + "relationships": { + "parent-class": { + "data": { + "id": "Ember.Service", + "type": "missing" + } + }, + "descendants": { + "data": [] + }, + "module": { + "data": { + "id": "ember-data-3.28.13-@ember-data/store", + "type": "module" + } + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-StringTransform-e22b28a886.json b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-StringTransform-e22b28a886.json new file mode 100644 index 000000000..981fa897b --- /dev/null +++ b/json-docs/ember-data/3.28.13/classes/ember-data-3.28.13-StringTransform-e22b28a886.json @@ -0,0 +1,102 @@ +{ + "data": { + "id": "ember-data-3.28.13-StringTransform", + "type": "class", + "attributes": { + "name": "StringTransform", + "shortname": "StringTransform", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "module": "@ember-data/serializer", + "namespace": "", + "file": "../serializer/addon/-private/transforms/string.js", + "line": 9, + "description": "The StringTransform class is used to serialize and deserialize\nstring attributes on Ember Data record objects. This transform is\nused when string is passed as the type parameter to the\nattr function.
Usage
\n| app/models/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class UserModel extends Model {\n ('boolean') isAdmin;\n ('string') name;\n ('string') email;\n} | \n
When given a deserialized value from a record attribute this\nmethod must return the serialized value.
\nExample
\n1\n2\n3\n4\n5\n | \n import { isEmpty } from '@ember/utils';\n\nserialize(deserialized, options) {\n return isEmpty(deserialized) ? null : Number(deserialized);\n} | \n
When given a serialized value from a JSON object this method must\nreturn the deserialized value for the record attribute.
\nExample
\n1\n2\n3\n | \n deserialize(serialized, options) {\n return empty(serialized) ? null : Number(serialized);\n} | \n
A TimeoutError is used by an adapter to signal that a request\nto the external API has timed out. I.e. no response was received from\nthe external API within an allowed time period.
An example use case would be to warn the user to check their internet\nconnection if an adapter operation has timed out:
\n| app/routes/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n | \n import Route from '/routing/route';\nimport { TimeoutError } from '-data/adapter/error';\nimport { action } from '/object';\n\nexport default class ApplicationRoute extends Route {\n \n error(error, transition) {\n if (error instanceof TimeoutError) {\n // alert the user\n alert('Are you still connected to the Internet?');\n return;\n }\n\n // ...other error handling logic\n }\n} | \n
The Transform class is used to serialize and deserialize model\nattributes when they are saved or loaded from an\nadapter. Subclassing Transform is useful for creating custom\nattributes. All subclasses of Transform must implement a\nserialize and a deserialize method.
Example
\n| app/transforms/temperature.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import Transform from '-data/serializer/transform';\n\n// Converts centigrade in the JSON to fahrenheit in the app\nexport default class TemperatureTransform extends Transform {\n deserialize(serialized, options) {\n return (serialized * 1.8) + 32;\n }\n\n serialize(deserialized, options) {\n return (deserialized - 32) / 1.8;\n }\n} | \n
Usage
\n| app/models/requirement.js | \n|
1\n2\n3\n4\n5\n6\n | \n import Model, { attr } from '-data/model';\n\nexport default class RequirementModel extends Model {\n ('string') name;\n ('temperature') temperature;\n} | \n
The options passed into the attr function when the attribute is\ndeclared on the model is also available in the transform.
| app/models/post.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import Model, { attr } from '-data/model';\n\nexport default class PostModel extends Model {\n ('string') title;\n ('markdown', {\n markdown: {\n gfm: false,\n sanitize: true\n }\n })\n markdown;\n} | \n
| app/transforms/markdown.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n | \n import Transform from '-data/serializer/transform';\n\nexport default class MarkdownTransform extends Transform {\n serialize(deserialized, options) {\n return deserialized.raw;\n }\n\n deserialize(serialized, options) {\n let markdownOptions = options.markdown || {};\n\n return marked(serialized, markdownOptions);\n }\n} | \n
When given a deserialized value from a record attribute this\nmethod must return the serialized value.
\nExample
\n1\n2\n3\n4\n5\n | \n import { isEmpty } from '@ember/utils';\n\nserialize(deserialized, options) {\n return isEmpty(deserialized) ? null : Number(deserialized);\n} | \n
When given a serialized value from a JSON object this method must\nreturn the deserialized value for the record attribute.
\nExample
\n1\n2\n3\n | \n deserialize(serialized, options) {\n return empty(serialized) ? null : Number(serialized);\n} | \n
A UnauthorizedError equates to a HTTP 401 Unauthorized response\nstatus. It is used by an adapter to signal that a request to the external\nAPI was rejected because authorization is required and has failed or has not\nyet been provided.
An example use case would be to redirect the user to a login route if a\nrequest is unauthorized:
\n| app/routes/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n | \n import Route from '/routing/route';\nimport { UnauthorizedError } from '-data/adapter/error';\nimport { action } from '/object';\n\nexport default class ApplicationRoute extends Route {\n \n error(error, transition) {\n if (error instanceof UnauthorizedError) {\n // go to the login route\n this.transitionTo('login');\n return;\n }\n\n // ...other error handling logic\n }\n} | \n
In order to properly fetch and update data, EmberData\nneeds to understand how to connect to your API.
\nAdapters accept various kinds of requests from the store\nand manage fulfillment of the request from your API.
When the store decides it needs to issue a request it uses the\nfollowing flow to manage the request and process the data.
\nWhen a request errors and your adapter does not have the ability to recover from the error,\nyou may either reject the promise returned by your adapter method with the error or simply\nthrow the error.
\nIf the request was for a createRecord updateRecord or deleteRecord special rules\napply to how this error will affect the state of the store and additional properties on\nthe Error class may be used. See the documentation for these methods in the\nMinimumAdapterInterface for more information.
There are seven required adapter methods, one for each of\nthe primary request types that EmberData issues.
\nThey are:
\nEach of these request types has a matching store method that triggers it\nand matching requestType that is passed to the serializer's\nnormalizeResponse method.
If your app only reads data but never writes data, it is not necessary\nto implement the methods for create, update, and delete. This extends to\nall of the store's find methods with the exception of findRecord (findAll,\nquery, queryRecord): if you do not use the store method in your app then\nyour Adapter does not need the method.
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import EmberObject from '@ember/object';\n\nasync function fetchData(url, options = {}) {\n let response = await fetch(url, options);\n return response.toJSON();\n}\n\nexport default class ApplicationAdapter extends EmberObject {\n findRecord(_, { modelName }, id) {\n return fetchData(`./${modelName}s/${id}`);\n }\n} | \n
store.adapterFor(name) will lookup adapters defined in app/adapters/ and\nreturn an instance.
adapterFor first attempts to find an adapter with an exact match on name,\nthen falls back to checking for the presence of an adapter named application.
If no adapter is found, an error will be thrown.
\n1\n2\n3\n4\n5\n | \n store.adapterFor('author');\n\n// lookup paths (in order) =>\n// app/adapters/author.js\n// app/adapters/application.js | \n
Most requests in EmberData are made with respect to a particular type (or modelName)\n(e.g., "get me the full collection of books" or "get me the employee whose id is 37"). We\nrefer to this as the primary resource type.
adapterFor is used by the store to find an adapter with a name matching that of the primary\nresource type for the request, which then falls back to the application adapter.
It is recommended that applications define only a single application adapter and serializer\nwhere possible, only implementing an adapter specific to the type when absolutely necessary.
If you need to support multiple API versions for the same type, the per-type strategy for\ndefining adapters might not be adequate.
\nIf you have multiple APIs or multiple API versions and the single application adapter and per-type\nstrategy does not suite your needs, one strategy is to write an application adapter and serializer\nthat make use of options to specify the desired format when making a request, then forwards to the\nrequest to the desired adapter or serializer as needed.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n | \n export default class Adapter extends EmberObject {\n findRecord(store, schema, id, snapshot) {\n let { apiVersion } = snapshot.adapterOptions;\n return this.adapterFor(`-api-${apiVersion}`).findRecord(store, schema, id, snapshot);\n }\n} | \n
Any adapter in app/adapters/ can be looked up by name using store.adapterFor(name).
Applications whose API's structure endpoint URLs very close to or exactly the REST\nor JSON:API convention, the @ember-data/adapter package contains implementations\nthese applications can extend.
Many applications will find writing their own adapter to be allow greater flexibility,\ncustomization, and maintenance than attempting to override methods in these adapters.
\n", + "itemtype": "main", + "parent": null, + "publicclasses": [ + "BuildURLMixin", + "Adapter", + "MinimumAdapterInterface" + ], + "privateclasses": [], + "staticfunctions": {}, + "allstaticfunctions": {}, + "version": "3.28.13" + }, + "relationships": { + "classes": { + "data": [] + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/modules/ember-data-3.28.13-@ember-data/adapter/error-80a5cf85b4.json b/json-docs/ember-data/3.28.13/modules/ember-data-3.28.13-@ember-data/adapter/error-80a5cf85b4.json new file mode 100644 index 000000000..5fcb69852 --- /dev/null +++ b/json-docs/ember-data/3.28.13/modules/ember-data-3.28.13-@ember-data/adapter/error-80a5cf85b4.json @@ -0,0 +1,145 @@ +{ + "data": { + "id": "ember-data-3.28.13-@ember-data/adapter/error", + "type": "module", + "attributes": { + "name": "@ember-data/adapter/error", + "submodules": {}, + "elements": {}, + "fors": { + "@ember-data/adapter/error": 1 + }, + "namespaces": {}, + "tag": "main", + "file": "../adapter/addon/error.js", + "line": 334, + "description": "A AdapterError is used by an adapter to signal that an error occurred\nduring a request to an external API. It indicates a generic error, and\nsubclasses are used to indicate specific error states. The following\nsubclasses are provided:
InvalidErrorTimeoutErrorAbortErrorUnauthorizedErrorForbiddenErrorNotFoundErrorConflictErrorServerErrorTo create a custom error to signal a specific error state in communicating\nwith an external API, extend the AdapterError. For example, if the\nexternal API exclusively used HTTP 503 Service Unavailable to indicate\nit was closed for maintenance:
| error.js | \n|
1\n2\n3\n | \n import AdapterError from '@ember-data/adapter/error';\n\nexport default AdapterError.extend({ message: "Down for maintenance." }); | \n
This error would then be returned by an adapter's handleResponse method:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\nimport MaintenanceError from './maintenance-error';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n handleResponse(status) {\n if (503 === status) {\n return new MaintenanceError();\n }\n\n return this._super(...arguments);\n }\n} | \n
And can then be detected in an application and used to send the user to an\nunder-maintenance route:
| app/routes/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n | \n import Route from '/routing/route';\nimport MaintenanceError from '../adapters/maintenance-error';\n\nexport default class ApplicationRoute extends Route {\n actions: {\n error(error, transition) {\n if (error instanceof MaintenanceError) {\n this.transitionTo('under-maintenance');\n return;\n }\n\n // ...other error handling logic\n }\n }\n} | \n
The JSONAPIAdapter is the default adapter used by Ember Data. It\nis responsible for transforming the store's requests into HTTP\nrequests that follow the JSON API\nformat.
The JSONAPIAdapter uses JSON API conventions for building the URL\nfor a record and selecting the HTTP verb to use with a request. The\nactions you can take on a record map onto the following URLs in the\nJSON API adapter:
\n| \n Action\n | \n\n HTTP Verb\n | \n\n URL\n | \n
|---|---|---|
| \n `store.findRecord('post', 123)`\n | \n\n GET\n | \n\n /posts/123\n | \n
| \n `store.findAll('post')`\n | \n\n GET\n | \n\n /posts\n | \n
| \n Update `postRecord.save()`\n | \n\n PATCH\n | \n\n /posts/123\n | \n
| \n Create `store.createRecord('post').save()`\n | \n\n POST\n | \n\n /posts\n | \n
| \n Delete `postRecord.destroyRecord()`\n | \n\n DELETE\n | \n\n /posts/123\n | \n
The JSONAPIAdapter will consider a success any response with a\nstatus code of the 2xx family ("Success"), as well as 304 ("Not\nModified"). Any other status code will be considered a failure.
\nOn success, the request promise will be resolved with the full\nresponse payload.
\nFailed responses with status code 422 ("Unprocessable Entity") will\nbe considered "invalid". The response will be discarded, except for\nthe errors key. The request promise will be rejected with a\nInvalidError. This error object will encapsulate the saved\nerrors value.
Any other status codes will be treated as an adapter error. The\nrequest promise will be rejected, similarly to the invalid case,\nbut with an instance of AdapterError instead.
Endpoint paths can be prefixed with a namespace by setting the\nnamespace property on the adapter:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n namespace = 'api/1';\n} | \n
Requests for the person model would now target /api/1/people/1.
An adapter can target other hosts by setting the host property.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import JSONAPIAdapter from '-data/adapter/json-api';\n\nexport default class ApplicationAdapter extends JSONAPIAdapter {\n host = 'https://api.example.com';\n} | \n
Requests for the person model would now target\nhttps://api.example.com/people/1.
The REST adapter allows your store to communicate with an HTTP server by\ntransmitting JSON via XHR. Most Ember.js apps that consume a JSON API\nshould use the REST adapter.
\nThis adapter is designed around the idea that the JSON exchanged with\nthe server should be conventional.
\nThe REST adapter will consider a success any response with a status code\nof the 2xx family ("Success"), as well as 304 ("Not Modified"). Any other\nstatus code will be considered a failure.
\nOn success, the request promise will be resolved with the full response\npayload.
\nFailed responses with status code 422 ("Unprocessable Entity") will be\nconsidered "invalid". The response will be discarded, except for the\nerrors key. The request promise will be rejected with a InvalidError.\nThis error object will encapsulate the saved errors value.
Any other status codes will be treated as an "adapter error". The request\npromise will be rejected, similarly to the "invalid" case, but with\nan instance of AdapterError instead.
The REST adapter expects the JSON returned from your server to follow\nthese conventions.
\nThe JSON payload should be an object that contains the record inside a\nroot property. For example, in response to a GET request for\n/posts/1, the JSON should look like this:
1\n2\n3\n4\n5\n6\n7\n | \n {\n "posts": {\n "id": 1,\n "title": "I'm Running to Reform the W3C's Tag",\n "author": "Yehuda Katz"\n }\n} | \n
Similarly, in response to a GET request for /posts, the JSON should\nlook like this:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n | \n {\n "posts": [\n {\n "id": 1,\n "title": "I'm Running to Reform the W3C's Tag",\n "author": "Yehuda Katz"\n },\n {\n "id": 2,\n "title": "Rails is omakase",\n "author": "D2H"\n }\n ]\n} | \n
Note that the object root can be pluralized for both a single-object response\nand an array response: the REST adapter is not strict on this. Further, if the\nHTTP server responds to a GET request to /posts/1 (e.g. the response to a\nfindRecord query) with more than one object in the array, Ember Data will\nonly display the object with the matching ID.
Attribute names in your JSON payload should be the camelCased versions of\nthe attributes in your Ember.js models.
\nFor example, if you have a Person model:
| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr } from '@ember-data/model';\n\nexport default Model.extend({\n firstName: attr('string'),\n lastName: attr('string'),\n occupation: attr('string')\n}); | \n
The JSON returned should look like this:
\n1\n2\n3\n4\n5\n6\n7\n8\n | \n {\n "people": {\n "id": 5,\n "firstName": "Zaphod",\n "lastName": "Beeblebrox",\n "occupation": "President"\n }\n} | \n
Relationships are usually represented by ids to the record in the\nrelationship. The related records can then be sideloaded in the\nresponse under a key for the type.
\n1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n {\n "posts": {\n "id": 5,\n "title": "I'm Running to Reform the W3C's Tag",\n "author": "Yehuda Katz",\n "comments": [1, 2]\n },\n "comments": [{\n "id": 1,\n "author": "User 1",\n "message": "First!",\n }, {\n "id": 2,\n "author": "User 2",\n "message": "Good Luck!",\n }]\n} | \n
If the records in the relationship are not known when the response\nis serialized it's also possible to represent the relationship as a\nURL using the links key in the response. Ember Data will fetch\nthis URL to resolve the relationship when it is accessed for the\nfirst time.
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n | \n {\n "posts": {\n "id": 5,\n "title": "I'm Running to Reform the W3C's Tag",\n "author": "Yehuda Katz",\n "links": {\n "comments": "/posts/5/comments"\n }\n }\n} | \n
If a response is considered a failure, the JSON payload is expected to include\na top-level key errors, detailing any specific issues. For example:
1\n2\n3\n4\n5\n | \n {\n "errors": {\n "msg": "Something went wrong"\n }\n} | \n
This adapter does not make any assumptions as to the format of the errors\nobject. It will simply be passed along as is, wrapped in an instance\nof InvalidError or AdapterError. The serializer can interpret it\nafterwards.
Endpoint paths can be prefixed with a namespace by setting the namespace\nproperty on the adapter:
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n namespace = 'api/1';\n} | \n
Requests for the Person model would now target /api/1/people/1.
An adapter can target other hosts by setting the host property.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n | \n import RESTAdapter from '-data/adapter/rest';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n host = 'https://api.example.com';\n} | \n
Some APIs require HTTP headers, e.g. to provide an API key. Arbitrary\nheaders can be set as key/value pairs on the RESTAdapter's headers\nobject and Ember Data will send them along with each ajax request.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { computed } from '/object';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n headers: computed(function() {\n return {\n 'API_KEY': 'secret key',\n 'ANOTHER_HEADER': 'Some header value'\n };\n }\n} | \n
headers can also be used as a computed property to support dynamic\nheaders. In the example below, the session object has been\ninjected into an adapter by Ember's container.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { computed } from '/object';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n headers: computed('session.authToken', function() {\n return {\n 'API_KEY': this.get('session.authToken'),\n 'ANOTHER_HEADER': 'Some header value'\n };\n })\n} | \n
In some cases, your dynamic headers may require data from some\nobject outside of Ember's observer system (for example\ndocument.cookie). You can use the\nvolatile\nfunction to set the property into a non-cached mode causing the headers to\nbe recomputed with every request.
| app/adapters/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n | \n import RESTAdapter from '-data/adapter/rest';\nimport { get } from '/object';\nimport { computed } from '/object';\n\nexport default class ApplicationAdapter extends RESTAdapter {\n headers: computed(function() {\n return {\n 'API_KEY': get(document.cookie.match(/apiKey\\=([^;]*)/), '1'),\n 'ANOTHER_HEADER': 'Some header value'\n };\n }).volatile()\n} | \n
EmberData allows users to test features that are implemented but not yet\navailable even in canary.
\nTypically these features represent work that might introduce a new concept,\nnew API, change an API, or risk an unintended change in behavior to consuming\napplications.
\nSuch features have their implementations guarded by a "feature flag", and the\nflag is only activated once the core-data team is prepared to ship the work\nin a canary release.
\nTo test a feature you MUST be using a canary build. Canary builds are published\nto npm and can be installed using a precise tag (such as ember-data@3.16.0-alpha.1)\nor by installing the latest dist-tag published to the canary channel.
Using npm to install the latest canary
1\n | \n npm install --save-dev ember-data@canary | \n
Using yarn to install the latest canary
1\n | \n yarn add ember-@canary | \n
Once you have installed canary, feature-flags can be activated at build-time by an environment\nvariable or at runtime using window.EmberDataENV.
The "off" branch of feature-flagged code is always stripped from production builds, so you\nMUST use the build-time environment variable to activate a flag if testing production.
\nThe list of available feature-flags is located here
\nTo configure feature-flags at runtime you will want to configure window.EmberDataENV = {} appropriately.\nYou should add this global property in your app prior to your application booting. At the top of\nyour app.js file is a convenient location, as is within index.html as a script running prior\nto loading any other scripts.
Example activating a single feature flags
\n1\n2\n3\n4\n5\n | \n window.EmberDataENV = {\n FEATURES: {\n RECORD_DATA_ERRORS: true,\n }\n} | \n
Example activating multiple feature flags
\n1\n2\n3\n4\n5\n6\n | \n window.EmberDataENV = {\n FEATURES: {\n RECORD_DATA_ERRORS: true,\n RECORD_DATA_STATE: true,\n }\n} | \n
Example activating all feature flags
\n1\n2\n3\n | \n window.EmberDataENV = {\n ENABLE_OPTIONAL_FEATURES: true\n} | \n
Example activating a single feature flags
\n1\n | \n EMBER_DATA_FEATURE_OVERRIDE=REQUEST_SERVICE ember build | \n
Example activating multiple feature flags
\n1\n | \n EMBER_DATA_FEATURE_OVERRIDE=REQUEST_SERVICE,CUSTOM_MODEL_CLASS ember build | \n
Example activating all feature flags
\n1\n | \n EMBER_DATA_FEATURE_OVERRIDE=ENABLE_ALL_OPTIONAL ember build | \n
For most addons and most features simple version detection should be\nenough. Using the provided version compatibility helpers from\nember-compatibility-helpers\nthe following can be done:
\n1\n2\n3\n4\n5\n | \n if (gte('@ember-data/store', '3.12.0')) {\n\n} else {\n\n} | \n
For addons needing more advanced detection babel-plugin-debug-macros\ncan be leveraged to provide code-stripping based on feature presence. For example in your addon's index.js:
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n34\n35\n36\n37\n38\n39\n | \n function debugMacros(features) {\n let plugins = [\n [\n require.resolve('babel-plugin-debug-macros'),\n {\n flags: [\n {\n source: '<addon-name>/feature-flags',\n flags: features,\n },\n ],\n },\n '<addon-name>/canary-features-stripping',\n ],\n ];\n\n return plugins;\n}\n\nmodule.exports = {\n name: '<addon-name>',\n\n init() {\n this._super.init.apply(this, arguments);\n\n let features;\n try {\n features = this.project.require('@ember-data/private-build-infra/src/features')();\n } catch (e) {\n features = { CUSTOM_MODEL_CLASS: false };\n }\n\n this.options = this.options || {};\n this.options.babel = this.options.babel || {};\n // this ensures that the same `@ember-data/canary-features` processing that the various\n // ember-data addons do is done for this addon\n this.options.babel.plugins = [...debugMacros(features)];\n }\n} | \n
This package provides the DataAdapter which the Ember Inspector\nuses to subscribe and retrieve information for the data tab in the inspector.
This package adds roughly .6 KB when minified and compressed to your application in production; however,\nyou can opt out of shipping this addon in production via options in ember-cli-build.js
1\n2\n3\n4\n5\n | \n let app = new EmberApp(defaults, {\n emberData: {\n includeDataAdapterInProduction: false\n }\n}); | \n
When using ember-data as a dependency of your app, the default is to ship the inspector support to production.
When not using ember-data as a dependency but instead using EmberData via declaring specific @ember-data/<package>\ndependencies the default is to not ship to production.
In EmberData a Model is a class defining the attributes and relationships\n of a specific resource type (model name). In this sense it represents a static "schema".
Data for individual resources fetched from your API is presented\n to the UI via instances of the Models you define.
An instantiated Model is referred to as a record.
When we refer to the ModelClass we are referring to the class definition\n and the static schema methods present on it.
When we refer to a record we refer to a specific class instance presenting\n the resource data for a given type and id.
| app/models/person.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n | \n import Model, { attr, belongsTo, hasMany } from '-data/model';\n\nexport default class PersonModel extends Model {\n name;\n\n ('pet', { inverse: 'owners', async: false }) dog;\n\n ('person', { inverse: 'friends', async: true }) friends;\n} | \n
By convention, the name of a given model (its type) matches the name\n of the file in the app/models folder and should be lowercase, singular\n and dasherized.
In order to properly manage and present your data, EmberData\nneeds to understand the structure of data it receives.
\nSerializers convert data between the server's API format and\nthe format EmberData understands.
Data received from an API response is normalized into\nJSON:API (the format used internally\nby EmberData), while data sent to an API is serialized\ninto the format the API expects.
\nThere are only two required serializer methods, one for\nnormalizing data from the server API format into JSON:API, and\nanother for serializing records via Snapshots into the expected\nserver API format.
To implement a serializer, export a class that conforms to the structure\ndescribed by the MinimumSerializerInterface\nfrom the app/serializers/ directory. An example is below.
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n | \n import EmberObject from '/object';\n\nexport default class ApplicationSerializer extends EmberObject {\n normalizeResponse(store, schema, rawPayload) {\n return rawPayload;\n }\n\n serialize(snapshot, options) {\n const serializedResource = {\n id: snapshot.id,\n type: snapshot.modelName,\n attributes: snapshot.attributes()\n };\n\n return serializedResource;\n }\n} | \n
store.serializerFor(name) will lookup serializers defined in\napp/serializers/ and return an instance. If no serializer is found, an\nerror will be thrown.
serializerFor first attempts to find a serializer with an exact match on name,\nthen falls back to checking for the presence of a serializer named application.
1\n2\n3\n4\n5\n | \n store.serializerFor('author');\n\n// lookup paths (in order) =>\n// app/serializers/author.js\n// app/serializers/application.js | \n
Most requests in EmberData are made with respect to a particular type (or modelName)\n(e.g., "get me the full collection of books" or "get me the employee whose id is 37"). We\nrefer to this as the primary resource type.
Typically serializerFor will be used to find a serializer with a name matching that of the primary\nresource type for the request, falling back to the application serializer for those types that\ndo not have a defined serializer. This is often described as a per-model or per-type strategy\nfor defining serializers. However, because APIs rarely format payloads per-type but rather\nper-API-version, this may not be a desired strategy.
It is recommended that applications define only a single application adapter and serializer\nwhere possible.
If you have multiple API formats and the per-type strategy is not viable, one strategy is to\nwrite an application adapter and serializer that make use of options to specify the desired\nformat when making a request.
Any serializer in app/serializers/ can be looked up by name using store.serializerFor(name).
For applications whose APIs are very close to or exactly the REST format or JSON:API\nformat the @ember-data/serializer package contains implementations these applications can\nextend. It also contains a simple JSONSerializer for serializing to/from very basic JSON objects.
Many applications will find writing their own serializer to be more performant and less\ncomplex than extending these classes even when their API format is very close to that expected\nby these serializers.
\nIt is recommended that apps write their own serializer to best suit the needs of their API and\napplication.
\n", + "itemtype": "main", + "parent": null, + "publicclasses": [ + "BooleanTransform", + "DateTransform", + "NumberTransform", + "StringTransform", + "Transform", + "Serializer", + "MinimumSerializerInterface" + ], + "privateclasses": [], + "staticfunctions": {}, + "allstaticfunctions": {}, + "version": "3.28.13" + }, + "relationships": { + "classes": { + "data": [] + }, + "project-version": { + "data": { + "id": "ember-data-3.28.13", + "type": "project-version" + } + } + } + } +} \ No newline at end of file diff --git a/json-docs/ember-data/3.28.13/modules/ember-data-3.28.13-@ember-data/serializer/json-a8fe5001d6.json b/json-docs/ember-data/3.28.13/modules/ember-data-3.28.13-@ember-data/serializer/json-a8fe5001d6.json new file mode 100644 index 000000000..39259ccc4 --- /dev/null +++ b/json-docs/ember-data/3.28.13/modules/ember-data-3.28.13-@ember-data/serializer/json-a8fe5001d6.json @@ -0,0 +1,37 @@ +{ + "data": { + "id": "ember-data-3.28.13-@ember-data/serializer/json", + "type": "module", + "attributes": { + "name": "@ember-data/serializer/json", + "submodules": {}, + "elements": {}, + "fors": {}, + "namespaces": {}, + "tag": "main", + "file": "../serializer/addon/json.js", + "line": 16, + "description": "Ember Data 2.0 Serializer:
\nIn Ember Data a Serializer is used to serialize and deserialize\nrecords when they are transferred in and out of an external source.\nThis process involves normalizing property names, transforming\nattribute values and serializing relationships.
\nBy default, Ember Data uses and recommends the JSONAPISerializer.
JSONSerializer is useful for simpler or legacy backends that may\nnot support the http://jsonapi.org/ spec.
For example, given the following User model and JSON payload:
| app/models/user.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, belongsTo, hasMany } from '-data/model';\n\nexport default class UserModel extends Model {\n ('user') friends;\n ('location') house;\n\n ('string') name;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n | \n {\n id: 1,\n name: 'Sebastian',\n friends: [3, 4],\n links: {\n house: '/houses/lefkada'\n }\n} | \n
JSONSerializer will normalize the JSON payload to the JSON API format that the\nEmber Data store expects.
You can customize how JSONSerializer processes its payload by passing options in\nthe attrs hash or by subclassing the JSONSerializer and overriding hooks:
normalize hook.JSONSerializer normalizes the whole server response, use the\nnormalizeResponse hook.JSONSerializer normalizes a specific response from the server,\nuse one of the many specific normalizeResponse hooks.JSONSerializer normalizes your id, attributes or relationships,\nuse the extractId, extractAttributes and extractRelationships hooks.The JSONSerializer normalization process follows these steps:
normalizeResponsenormalizeCreateRecordResponsenormalizeResponse for a specific operation is called.normalizeSingleResponse|normalizeArrayResponsecreateRecord we expect a single record back, while for methods like findAll we expect multiple records back.normalizenormalizeArrayResponse iterates and calls normalize for each of its records while normalizeSingle\ncalls it once. This is the method you most likely want to subclass.extractId | extractAttributes | extractRelationshipsnormalize delegates to these methods to\nturn the record payload into the JSON API format.Ember Data 2.0 Serializer:
\nIn Ember Data a Serializer is used to serialize and deserialize\nrecords when they are transferred in and out of an external source.\nThis process involves normalizing property names, transforming\nattribute values and serializing relationships.
\nJSONAPISerializer supports the http://jsonapi.org/ spec and is the\nserializer recommended by Ember Data.
This serializer normalizes a JSON API payload that looks like:
\n| app/models/player.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import Model, { attr, belongsTo } from '-data/model';\n\nexport default class Player extends Model {\n ('string') name;\n ('string') skill;\n ('number') gamesPlayed;\n ('club') club;\n} | \n
| app/models/club.js | \n|
1\n2\n3\n4\n5\n6\n7\n | \n import Model, { attr, hasMany } from '-data/model';\n\nexport default class Club extends Model {\n ('string') name;\n ('string') location;\n ('player') players;\n} | \n
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n22\n23\n24\n25\n26\n27\n28\n29\n30\n31\n32\n33\n34\n35\n36\n37\n38\n39\n40\n41\n | \n {\n "data": [\n {\n "attributes": {\n "name": "Benfica",\n "location": "Portugal"\n },\n "id": "1",\n "relationships": {\n "players": {\n "data": [\n {\n "id": "3",\n "type": "players"\n }\n ]\n }\n },\n "type": "clubs"\n }\n ],\n "included": [\n {\n "attributes": {\n "name": "Eusebio Silva Ferreira",\n "skill": "Rocket shot",\n "games-played": 431\n },\n "id": "3",\n "relationships": {\n "club": {\n "data": {\n "id": "1",\n "type": "clubs"\n }\n }\n },\n "type": "players"\n }\n ]\n } | \n
to the format that the Ember Data store expects.
\nSince a JSON API Document can have meta defined in multiple locations you can\nuse the specific serializer hooks if you need to customize the meta.
\nOne scenario would be to camelCase the meta keys of your payload. The example\nbelow shows how this could be done using normalizeArrayResponse and\nextractRelationship.
| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n9\n10\n11\n12\n13\n14\n15\n16\n17\n18\n19\n20\n21\n | \n import JSONAPISerializer from '@ember-data/serializer/json-api';\n\nexport default class ApplicationSerializer extends JSONAPISerializer {\n normalizeArrayResponse(store, primaryModelClass, payload, id, requestType) {\n let normalizedDocument = super.normalizeArrayResponse(...arguments);\n\n // Customize document meta\n normalizedDocument.meta = camelCaseKeys(normalizedDocument.meta);\n\n return normalizedDocument;\n }\n\n extractRelationship(relationshipHash) {\n let normalizedRelationship = super.extractRelationship(...arguments);\n\n // Customize relationship meta\n normalizedRelationship.meta = camelCaseKeys(normalizedRelationship.meta);\n\n return normalizedRelationship;\n }\n} | \n
Normally, applications will use the RESTSerializer by implementing\nthe normalize method.
This allows you to do whatever kind of munging you need and is\nespecially useful if your server is inconsistent and you need to\ndo munging differently for many different kinds of responses.
\nSee the normalize documentation for more information.
There are also a number of hooks that you might find useful to define\nacross-the-board rules for your payload. These rules will be useful\nif your server is consistent, or if you're building an adapter for\nan infrastructure service, like Firebase, and want to encode service\nconventions.
\nFor example, if all of your keys are underscored and all-caps, but\notherwise consistent with the names you use in your models, you\ncan implement across-the-board rules for how to convert an attribute\nname in your model to a key in your JSON.
\n| app/serializers/application.js | \n|
1\n2\n3\n4\n5\n6\n7\n8\n | \n import RESTSerializer from '-data/serializer/rest';\nimport { underscore } from '/string';\n\nexport default class ApplicationSerializer extends RESTSerializer {\n keyForAttribute(attr, method) {\n return underscore(attr).toUpperCase();\n }\n} | \n
You can also implement keyForRelationship, which takes the name\nof the relationship as the first parameter, the kind of\nrelationship (hasMany or belongsTo) as the second parameter, and\nthe method (serialize or deserialize) as the third parameter.
The store contains all of the data for records loaded from the server.\nIt is also responsible for creating instances of Model that wrap\nthe individual data for a record, so that they can be bound to in your\nHandlebars templates.
Define your application's store like this:
\n| app/services/store.js | \n|
1\n2\n3\n | \n import Store from '-data/store';\n\nexport default class MyStore extends Store {} | \n
Most Ember.js applications will only have a single Store that is\nautomatically created by their Ember.Application.
You can retrieve models from the store in several ways. To retrieve a record\nfor a specific id, use Store's findRecord() method:
1\n2\n | \n store.findRecord('person', 123).then(function (person) {\n}); | \n
By default, the store will talk to your backend using a standard\nREST mechanism. You can customize how the store talks to your\nbackend by specifying a custom adapter:
\n| app/adapters/application.js | \n|
1\n2\n3\n4\n | \n import Adapter from '-data/adapter';\n\nexport default class ApplicationAdapter extends Adapter {\n} | \n
You can learn more about writing a custom adapter by reading the Adapter\ndocumentation.
The store provides multiple ways to create new record objects. They have\nsome subtle differences in their use which are detailed below:
\ncreateRecord is used for creating new\nrecords on the client side. This will return a new record in the\ncreated.uncommitted state. In order to persist this record to the\nbackend, you will need to call record.save().
push is used to notify Ember Data's store of new or\nupdated records that exist in the backend. This will return a record\nin the loaded.saved state. The primary use-case for store#push is\nto notify Ember Data about record updates (full or partial) that happen\noutside of the normal adapter methods (for example\nSSE or Web\nSockets).
pushPayload is a convenience wrapper for\nstore#push that will deserialize payloads if the\nSerializer implements a pushPayload method.
Note: When creating a new record using any of the above methods\nEmber Data will update RecordArrays such as those returned by\nstore#peekAll() or store#findAll(). This means any\ndata bindings or computed properties that depend on the RecordArray\nwill automatically be synced to include the new or updated record\nvalues.