DS.RESTSerializer - 1.13 - Ember API Documentation

app/serializers/application.js
1 2 3 4 5 6 7	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ keyForAttribute: function(attr, method) { return Ember.String.underscore(attr).toUpperCase(); } });

extract (store, typeClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1209

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

The extract method is used to deserialize payload data from the server. By default the JSONSerializer does not push the records into the store. However records that subclass JSONSerializer such as the RESTSerializer may push records into the store as part of the extract call.

This method delegates to a more specific extract method based on the requestType.

To override this method with a custom one, make sure to call return this._super(store, type, payload, id, requestType) with your pre-processed data.

Here's an example of using extract manually:

        
              socket.on('message', function(message) {
  var data = message.data;
  var typeClass = store.modelFor(message.modelName);
  var serializer = store.serializerFor(typeClass.modelName);
  var record = serializer.extract(store, typeClass, data, data.id, 'single');

  store.push(message.modelName, record);
});

extractArray (store, primaryTypeClass, rawPayload) Array

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:528

store: DS.Store
primaryTypeClass: DS.Model
rawPayload: Object
returns: Array; The primary array that was returned in response to the original query.

Called when the server has returned a payload representing multiple records, such as in response to a findAll or findQuery.

It is your opportunity to clean up the server's response into the normalized form expected by Ember Data.

If you want, you can just restructure the top-level of your payload, and do more fine-grained normalization in the normalize method.

For example, if you have a payload like this in response to a request for all posts:

        
          
              
              {
  "_embedded": {
    "post": [{
      "id": 1,
      "title": "Rails is omakase"
    }, {
      "id": 2,
      "title": "The Parley Letter"
    }],
    "comment": [{
      "_id": 1,
      "comment_title": "Rails is unagi",
      "post_id": 1
    }, {
      "_id": 2,
      "comment_title": "Don't tread on me",
      "post_id": 2
    }]
  }
}
            

        
      

You could implement a serializer that looks like this to get your payload into shape:

        
          
              app/serializers/post.js
            

          
              
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  // First, restructure the top-level so it's organized by type
  // and the comments are listed under a post's `comments` key.
  extractArray: function(store, type, payload) {
    var posts = payload._embedded.post;
    var comments = [];
    var postCache = {};

    posts.forEach(function(post) {
      post.comments = [];
      postCache[post.id] = post;
    });

    payload._embedded.comment.forEach(function(comment) {
      comments.push(comment);
      postCache[comment.post_id].comments.push(comment);
      delete comment.post_id;
    });

    payload = { comments: comments, posts: posts };

    return this._super(store, type, payload);
  },

  normalizeHash: {
    // Next, normalize individual comments, which (after `extract`)
    // are now located under `comments`
    comments: function(hash) {
      hash.id = hash._id;
      hash.title = hash.comment_title;
      delete hash._id;
      delete hash.comment_title;
      return hash;
    }
  }
})
            

        
      

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ // First, restructure the top-level so it's organized by type // and the comments are listed under a post's `comments` key. extractArray: function(store, type, payload) { var posts = payload._embedded.post; var comments = []; var postCache = {}; posts.forEach(function(post) { post.comments = []; postCache[post.id] = post; }); payload._embedded.comment.forEach(function(comment) { comments.push(comment); postCache[comment.post_id].comments.push(comment); delete comment.post_id; }); payload = { comments: comments, posts: posts }; return this._super(store, type, payload); }, normalizeHash: { // Next, normalize individual comments, which (after `extract`) // are now located under `comments` comments: function(hash) { hash.id = hash._id; hash.title = hash.comment_title; delete hash._id; delete hash.comment_title; return hash; } } })

When you call super from your own implementation of extractArray, the built-in implementation will find the primary array in your normalized payload and push the remaining records into the store.

The primary array is the array found under posts.

The primary record has special meaning when responding to findQuery or findHasMany. In particular, the primary array will become the list of records in the record array that kicked off the request.

If your primary array contains secondary (embedded) records of the same type, you cannot place these into the primary array posts. Instead, place the secondary items into an underscore prefixed property _posts, which will push these items into the store and will not affect the resulting query.

extractAttributes (modelClass, resourceHash) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:527

modelClass: Object
resourceHash: Object
returns: Object

Returns the resource's attributes formatted as a JSON-API "attributes object".

http://jsonapi.org/format/#document-resource-object-attributes

extractCreateRecord (store, typeClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1332

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractCreateRecord is a hook into the extract method used when a call is made to DS.Model#save and the record is new. By default this method is alias for extractSave.

extractDeleteRecord (store, typeClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1364

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractDeleteRecord is a hook into the extract method used when a call is made to DS.Model#save and the record has been deleted. By default this method is alias for extractSave.

extractErrors (store, typeClass, payload, id) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1548

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
returns: Object; json The deserialized errors

extractErrors is used to extract model errors when a call is made to DS.Model#save which fails with an InvalidError. By default Ember Data expects error information to be located on the errors property of the payload object.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  extractErrors: function(store, typeClass, payload, id) {
    if (payload && typeof payload === 'object' && payload._problems) {
      payload = payload._problems;
      this.normalizeErrors(typeClass, payload);
    }
    return payload;
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ extractErrors: function(store, typeClass, payload, id) { if (payload && typeof payload === 'object' && payload._problems) { payload = payload._problems; this.normalizeErrors(typeClass, payload); } return payload; } });

extractFind (store, typeClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1381

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractFind is a hook into the extract method used when a call is made to DS.Store#find. By default this method is alias for extractSingle.

extractFindAll (store, typeClass, payload, id, requestType) Array

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1251

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractFindAll is a hook into the extract method used when a call is made to DS.Store#findAll. By default this method is an alias for extractArray.

extractFindBelongsTo (store, typeClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1398

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractFindBelongsTo is a hook into the extract method used when a call is made to DS.Store#findBelongsTo. By default this method is alias for extractSingle.

extractFindHasMany (store, typeClass, payload, id, requestType) Array

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1315

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractFindHasMany is a hook into the extract method used when a call is made to DS.Store#findHasMany. By default this method is alias for extractArray.

extractFindMany (store, typeClass, payload, id, requestType) Array

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1299

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractFindMany is a hook into the extract method used when a call is made to DS.Store#findMany. By default this method is alias for extractArray.

extractFindQuery (store, typeClass, payload, id, requestType) Array

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1267

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Array; array An array of deserialized objects

extractFindQuery is a hook into the extract method used when a call is made to DS.Store#findQuery. By default this method is an alias for extractArray.

extractId (modelClass, resourceHash) String

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:513

modelClass: Object
resourceHash: Object
returns: String

Returns the resource's ID.

extractMeta (store, typeClass, payload)

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1512

store: DS.Store
typeClass: DS.Model
payload: Object

extractMeta is used to deserialize any meta information in the adapter payload. By default Ember Data expects meta information to be located on the meta property of the payload object.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  extractMeta: function(store, typeClass, payload) {
    if (payload && payload._pagination) {
      store.setMetadataFor(typeClass, payload._pagination);
      delete payload._pagination;
    }
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ extractMeta: function(store, typeClass, payload) { if (payload && payload._pagination) { store.setMetadataFor(typeClass, payload._pagination); delete payload._pagination; } } });

extractQueryRecord (store, typeClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1283

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; object A hash of deserialized object

extractQueryRecord is a hook into the extract method used when a call is made to DS.Store#queryRecord. By default this method is an alias for extractSingle.

extractRelationship (relationshipModelName, relationshipHash) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:551

relationshipModelName: Object
relationshipHash: Object
returns: Object

Returns a relationship formatted as a JSON-API "relationship object".

http://jsonapi.org/format/#document-resource-object-relationships

extractRelationships (modelClass, resourceHash) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:582

modelClass: Object
resourceHash: Object
returns: Object

Returns the resource's relationships formatted as a JSON-API "relationships object".

http://jsonapi.org/format/#document-resource-object-relationships

extractSave (store, typeClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1414

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractSave is a hook into the extract method used when a call is made to DS.Model#save. By default this method is alias for extractSingle.

extractSingle (store, primaryTypeClass, rawPayload, recordId) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:390

store: DS.Store
primaryTypeClass: DS.Model
rawPayload: Object
recordId: String
returns: Object; the primary response to the original request

Called when the server has returned a payload representing a single record, such as in response to a find or save.

It is your opportunity to clean up the server's response into the normalized form expected by Ember Data.

If you want, you can just restructure the top-level of your payload, and do more fine-grained normalization in the normalize method.

For example, if you have a payload like this in response to a request for post 1:

        
          
              
              {
  "id": 1,
  "title": "Rails is omakase",

  "_embedded": {
    "comment": [{
      "_id": 1,
      "comment_title": "FIRST"
    }, {
      "_id": 2,
      "comment_title": "Rails is unagi"
    }]
  }
}
            

        
      

You could implement a serializer that looks like this to get your payload into shape:

        
          
              app/serializers/post.js
            

          
              
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  // First, restructure the top-level so it's organized by type
  extractSingle: function(store, typeClass, payload, id) {
    var comments = payload._embedded.comment;
    delete payload._embedded;

    payload = { comments: comments, post: payload };
    return this._super(store, typeClass, payload, id);
  },

  normalizeHash: {
    // Next, normalize individual comments, which (after `extract`)
    // are now located under `comments`
    comments: function(hash) {
      hash.id = hash._id;
      hash.title = hash.comment_title;
      delete hash._id;
      delete hash.comment_title;
      return hash;
    }
  }
})
            

        
      

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ // First, restructure the top-level so it's organized by type extractSingle: function(store, typeClass, payload, id) { var comments = payload._embedded.comment; delete payload._embedded; payload = { comments: comments, post: payload }; return this._super(store, typeClass, payload, id); }, normalizeHash: { // Next, normalize individual comments, which (after `extract`) // are now located under `comments` comments: function(hash) { hash.id = hash._id; hash.title = hash.comment_title; delete hash._id; delete hash.comment_title; return hash; } } })

When you call super from your own implementation of extractSingle, the built-in implementation will find the primary record in your normalized payload and push the remaining records into the store.

The primary record is the single hash found under post or the first element of the posts array.

The primary record has special meaning when the record is being created for the first time or updated (createRecord or updateRecord). In particular, it will update the properties of the record that was saved.

extractUpdateRecord (store, typeClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1348

store: DS.Store
typeClass: DS.Model
payload: Object
id: (String|Number)
requestType: String
returns: Object; json The deserialized payload

extractUpdateRecord is a hook into the extract method used when a call is made to DS.Model#save and the record has been updated. By default this method is alias for extractSave.

keyForAttribute (key, method) String

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1586

key: String
method: String
returns: String; normalized key

keyForAttribute can be used to define rules for how to convert an attribute name in your model to a key in your JSON.

Example

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  keyForAttribute: function(attr, method) {
    return Ember.String.underscore(attr).toUpperCase();
  }
});

app/serializers/application.js
1 2 3 4 5 6 7	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ keyForAttribute: function(attr, method) { return Ember.String.underscore(attr).toUpperCase(); } });

keyForLink (key, kind) String

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1638

key: String
kind: String; `belongsTo` or `hasMany`
returns: String; normalized key

keyForLink can be used to define a custom key when deserializing link properties.

keyForRelationship (key, typeClass, method) String

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1611

key: String
typeClass: String
method: String
returns: String; normalized key

keyForRelationship can be used to define a custom key when serializing and deserializing relationship properties. By default JSONSerializer does not provide an implementation of this method.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  keyForRelationship: function(key, relationship, method) {
    return 'rel_' + Ember.String.underscore(key);
  }
});

app/serializers/post.js
1 2 3 4 5 6 7	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ keyForRelationship: function(key, relationship, method) { return 'rel_' + Ember.String.underscore(key); } });

modelNameFromPayloadKey (key) String

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:746

key: String
returns: String; the model's modelName

This method is used to convert each JSON root key in the payload into a modelName that it can use to look up the appropriate model for that part of the payload.

For example, your server may send a model name that does not correspond with the name of the model in your app. Let's take a look at an example model, and an example payload:

        
              app/models/post.js
            
              import DS from 'ember-data';

export default DS.Model.extend({
});

app/models/post.js
1 2 3 4	import DS from 'ember-data'; export default DS.Model.extend({ });

        
                {
    "blog/post": {
      "id": "1
    }
  }

Ember Data is going to normalize the payload's root key for the modelName. As a result, it will try to look up the "blog/post" model. Since we don't have a model called "blog/post" (or a file called app/models/blog/post.js in ember-cli), Ember Data will throw an error because it cannot find the "blog/post" model.

Since we want to remove this namespace, we can define a serializer for the application that will remove "blog/" from the payload key whenver it's encountered by Ember Data:

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  modelNameFromPayloadKey: function(payloadKey) {
    if (payloadKey === 'blog/post') {
      return this._super(payloadKey.replace('blog/', ''));
    } else {
     return this._super(payloadKey);
    }
  }
});

app/serializers/application.js
1 2 3 4 5 6 7 8 9 10 11	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ modelNameFromPayloadKey: function(payloadKey) { if (payloadKey === 'blog/post') { return this._super(payloadKey.replace('blog/', '')); } else { return this._super(payloadKey); } } });

After refreshing, Ember Data will appropriately look up the "post" model.

By default the modelName for a model is its name in dasherized form. This means that a payload key like "blogPost" would be normalized to "blog-post" when Ember Data looks up the model. Usually, Ember Data can use the correct inflection to do this for you. Most of the time, you won't need to override modelNameFromPayloadKey for this purpose.

normalize (typeClass, hash, prop) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:120

typeClass: DS.Model
hash: Object
prop: String
returns: Object

Normalizes a part of the JSON payload returned by the server. You should override this method, munge the hash and call super if you have generic normalization to do.

It takes the type of the record that is being normalized (as a DS.Model class), the property where the hash was originally found, and the hash to normalize.

For example, if you have a payload that looks like this:

        
          
              
              {
  "post": {
    "id": 1,
    "title": "Rails is omakase",
    "comments": [ 1, 2 ]
  },
  "comments": [{
    "id": 1,
    "body": "FIRST"
  }, {
    "id": 2,
    "body": "Rails is unagi"
  }]
}
            

        
      

The normalize method will be called three times:

With App.Post, "posts" and { id: 1, title: "Rails is omakase", ... }
With App.Comment, "comments" and { id: 1, body: "FIRST" }
With App.Comment, "comments" and { id: 2, body: "Rails is unagi" }

You can use this method, for example, to normalize underscored keys to camelized or other general-purpose normalizations.

If you want to do normalizations specific to some part of the payload, you can specify those under normalizeHash.

For example, if the IDs under "comments" are provided as _id instead of id, you can specify how to normalize just the comments:

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  normalizeHash: {
    comments: function(hash) {
      hash.id = hash._id;
      delete hash._id;
      return hash;
    }
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ normalizeHash: { comments: function(hash) { hash.id = hash._id; delete hash._id; return hash; } } });

The key under normalizeHash is just the original key that was in the original payload.

normalize (typeClass, hash) Object

Module: ember-data

Inherited from DS.Serializer packages/ember-data/lib/system/serializer.js:93

typeClass: DS.Model
hash: Object
returns: Object

The normalize method is used to convert a payload received from your external data source into the normalized form store.push() expects. You should override this method, munge the hash and return the normalized payload.

normalizeArray (store, modelName, arrayHash, prop) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:210

store: DS.Store
modelName: String
arrayHash: Object
prop: String
returns: Object

Normalizes an array of resource payloads and returns a JSON-API Document with primary data and, if any, included data as { data, included }.

normalizeArrayResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:404

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeCreateRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:339

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeDeleteRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:352

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindAllResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:274

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindBelongsToResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:287

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindHasManyResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:300

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindManyResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:313

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeFindRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:248

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeQueryRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:261

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeQueryResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:326

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:189

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

The normalizeResponse method is used to normalize a payload from the server to a JSON-API Document.

http://jsonapi.org/format/#document-structure

This method delegates to a more specific normalize method based on the requestType.

To override this method with a custom one, make sure to call return this._super(store, primaryModelClass, payload, id, requestType) with your pre-processed data.

Here's an example of using normalizeResponse manually:

        
              socket.on('message', function(message) {
  var data = message.data;
  var modelClass = store.modelFor(data.modelName);
  var serializer = store.serializerFor(data.modelName);
  var json = serializer.normalizeSingleResponse(store, modelClass, data, data.id);

  store.push(normalized);
});

normalizeSaveResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:378

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeSingleResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:391

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

normalizeUpdateRecordResponse (store, primaryModelClass, payload, id, requestType) Object

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:365

store: DS.Store
primaryModelClass: DS.Model
payload: Object
id: String|Number
requestType: String
returns: Object; JSON-API Document

payloadKeyFromModelName (modelName) String

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:994

modelName: String
returns: String

You can use payloadKeyFromModelName to override the root key for an outgoing request. By default, the RESTSerializer returns a camelized version of the model's name.

For a model called TacoParty, its modelName would be the string taco-party. The RESTSerializer will send it to the server with tacoParty as the root key in the JSON payload:

        
              {
  "tacoParty": {
    "id": "1",
    "location": "Matthew Beale's House"
  }
}

For example, your server may expect dasherized root objects:

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  payloadKeyFromModelName: function(modelName) {
    return Ember.String.dasherize(modelName);
  }
});

app/serializers/application.js
1 2 3 4 5 6 7	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ payloadKeyFromModelName: function(modelName) { return Ember.String.dasherize(modelName); } });

Given a TacoParty' model, calling save` on a tacoModel would produce an outgoing request like:

        
              {
  "taco-party": {
    "id": "1",
    "location": "Matthew Beale's House"
  }
}

pushPayload (store, rawPayload)

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:681

store: DS.Store
rawPayload: Object

This method allows you to push a payload containing top-level collections of records organized per type.

        
          
              
              {
  "posts": [{
    "id": "1",
    "title": "Rails is omakase",
    "author", "1",
    "comments": [ "1" ]
  }],
  "comments": [{
    "id": "1",
    "body": "FIRST"
  }],
  "users": [{
    "id": "1",
    "name": "@d2h"
  }]
}
            

        
      

It will first normalize the payload, so you can use this to push in data streaming in from your server structured the same way that fetches and saves are structured.

serialize (snapshot, options) Object

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:810

snapshot: DS.Snapshot
options: Object
returns: Object; json

Called when a record is saved in order to convert the record into JSON.

By default, it creates a JSON object with a key for each attribute and belongsTo relationship.

For example, consider this model:

        
              app/models/comment.js
            
              import DS from 'ember-data';

export default DS.Model.extend({
  title: DS.attr(),
  body: DS.attr(),

  author: DS.belongsTo('user')
});

app/models/comment.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.Model.extend({ title: DS.attr(), body: DS.attr(), author: DS.belongsTo('user') });

The default serialization would create a JSON object like:

        
              {
  "title": "Rails is unagi",
  "body": "Rails? Omakase? O_O",
  "author": 12
}

By default, attributes are passed through as-is, unless you specified an attribute type (DS.attr('date')). If you specify a transform, the JavaScript value will be serialized when inserted into the JSON hash.

By default, belongs-to relationships are converted into IDs when inserted into the JSON hash.

IDs

serialize takes an options hash with a single option: includeId. If this option is true, serialize will, by default include the ID in the JSON object it builds.

The adapter passes in includeId: true when serializing a record for createRecord, but not for updateRecord.

Customization

Your server may expect a different JSON format than the built-in serialization format.

In that case, you can implement serialize yourself and return a JSON hash of your choosing.

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  serialize: function(snapshot, options) {
    var json = {
      POST_TTL: snapshot.attr('title'),
      POST_BDY: snapshot.attr('body'),
      POST_CMS: snapshot.hasMany('comments', { ids: true })
    }

    if (options.includeId) {
      json.POST_ID_ = snapshot.id;
    }

    return json;
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ serialize: function(snapshot, options) { var json = { POST_TTL: snapshot.attr('title'), POST_BDY: snapshot.attr('body'), POST_CMS: snapshot.hasMany('comments', { ids: true }) } if (options.includeId) { json.POST_ID_ = snapshot.id; } return json; } });

Customizing an App-Wide Serializer

If you want to define a serializer for your entire application, you'll probably want to use eachAttribute and eachRelationship on the record.

        
          
              app/serializers/application.js
            

          
              
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  serialize: function(snapshot, options) {
    var json = {};

    snapshot.eachAttribute(function(name) {
      json[serverAttributeName(name)] = snapshot.attr(name);
    })

    snapshot.eachRelationship(function(name, relationship) {
      if (relationship.kind === 'hasMany') {
        json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true });
      }
    });

    if (options.includeId) {
      json.ID_ = snapshot.id;
    }

    return json;
  }
});

function serverAttributeName(attribute) {
  return attribute.underscore().toUpperCase();
}

function serverHasManyName(name) {
  return serverAttributeName(name.singularize()) + "_IDS";
}
            

        
      

app/serializers/application.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ serialize: function(snapshot, options) { var json = {}; snapshot.eachAttribute(function(name) { json[serverAttributeName(name)] = snapshot.attr(name); }) snapshot.eachRelationship(function(name, relationship) { if (relationship.kind === 'hasMany') { json[serverHasManyName(name)] = snapshot.hasMany(name, { ids: true }); } }); if (options.includeId) { json.ID_ = snapshot.id; } return json; } }); function serverAttributeName(attribute) { return attribute.underscore().toUpperCase(); } function serverHasManyName(name) { return serverAttributeName(name.singularize()) + "_IDS"; }

This serializer will generate JSON that looks like this:

        
              {
  "TITLE": "Rails is omakase",
  "BODY": "Yep. Omakase.",
  "COMMENT_IDS": [ 1, 2, 3 ]
}

Tweaking the Default JSON

If you just want to do some small tweaks on the default JSON, you can call super first and make the tweaks on the returned JSON.

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  serialize: function(snapshot, options) {
    var json = this._super(snapshot, options);

    json.subject = json.title;
    delete json.title;

    return json;
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ serialize: function(snapshot, options) { var json = this._super(snapshot, options); json.subject = json.title; delete json.title; return json; } });

serialize (record, options) Object

Module: ember-data

Inherited from DS.Serializer packages/ember-data/lib/system/serializer.js:77

record: DS.Model
options: Object
returns: Object

The serialize method is used when a record is saved in order to convert the 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 in the serialized object it builds.

serializeAttribute (snapshot, json, key, attribute)

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1031

snapshot: DS.Snapshot
json: Object
key: String
attribute: Object

serializeAttribute can be used to customize how DS.attr properties are serialized

For example if you wanted to ensure all your attributes were always serialized as properties on an attributes object you could write:

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serializeAttribute: function(snapshot, json, key, attributes) {
    json.attributes = json.attributes || {};
    this._super(snapshot, json.attributes, key, attributes);
  }
});

app/serializers/application.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serializeAttribute: function(snapshot, json, key, attributes) { json.attributes = json.attributes \|\| {}; this._super(snapshot, json.attributes, key, attributes); } });

serializeBelongsTo (snapshot, json, relationship)

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1078

snapshot: DS.Snapshot
json: Object
relationship: Object

serializeBelongsTo can be used to customize how DS.belongsTo properties are serialized.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serializeBelongsTo: function(snapshot, json, relationship) {
    var key = relationship.key;

    var belongsTo = snapshot.belongsTo(key);

    key = this.keyForRelationship ? this.keyForRelationship(key, "belongsTo", "serialize") : key;

    json[key] = Ember.isNone(belongsTo) ? belongsTo : belongsTo.record.toJSON();
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12 13	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serializeBelongsTo: function(snapshot, json, relationship) { var key = relationship.key; var belongsTo = snapshot.belongsTo(key); key = this.keyForRelationship ? this.keyForRelationship(key, "belongsTo", "serialize") : key; json[key] = Ember.isNone(belongsTo) ? belongsTo : belongsTo.record.toJSON(); } });

serializeHasMany (snapshot, json, relationship)

Module: ember-data

Inherited from DS.JSONSerializer packages/ember-data/lib/serializers/json-serializer.js:1131

snapshot: DS.Snapshot
json: Object
relationship: Object

serializeHasMany can be used to customize how DS.hasMany properties are serialized.

Example

        
              app/serializers/post.js
            
              import DS from 'ember-data';

export default DS.JSONSerializer.extend({
  serializeHasMany: function(snapshot, json, relationship) {
    var key = relationship.key;
    if (key === 'comments') {
      return;
    } else {
      this._super.apply(this, arguments);
    }
  }
});

app/serializers/post.js
1 2 3 4 5 6 7 8 9 10 11 12	import DS from 'ember-data'; export default DS.JSONSerializer.extend({ serializeHasMany: function(snapshot, json, relationship) { var key = relationship.key; if (key === 'comments') { return; } else { this._super.apply(this, arguments); } } });

serializeIntoHash (hash, typeClass, snapshot, options)

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:965

hash: Object
typeClass: DS.Model
snapshot: DS.Snapshot
options: Object

You can use this method to customize the root keys serialized into the JSON. By default the REST Serializer sends the modelName of a model, which is a camelized version of the name.

For example, your server may expect underscored root objects.

        
              app/serializers/application.js
            
              import DS from 'ember-data';

export default DS.RESTSerializer.extend({
  serializeIntoHash: function(data, type, record, options) {
    var root = Ember.String.decamelize(type.modelName);
    data[root] = this.serialize(record, options);
  }
});

app/serializers/application.js
1 2 3 4 5 6 7 8	import DS from 'ember-data'; export default DS.RESTSerializer.extend({ serializeIntoHash: function(data, type, record, options) { var root = Ember.String.decamelize(type.modelName); data[root] = this.serialize(record, options); } });

serializePolymorphicType (snapshot, json, relationship)

Module: ember-data

Defined in packages/ember-data/lib/serializers/rest-serializer.js:1059

snapshot: DS.Snapshot
json: Object
relationship: Object

You can use this method to customize how polymorphic objects are serialized. By default the JSON Serializer creates the key by appending Type to the attribute and value from the model's camelcased model name.

Class DS.RESTSerializer

Across the Board Normalization

extract (store, typeClass, payload, id, requestType) Object

extractArray (store, primaryTypeClass, rawPayload) Array

extractAttributes (modelClass, resourceHash) Object

extractCreateRecord (store, typeClass, payload, id, requestType) Object

extractDeleteRecord (store, typeClass, payload, id, requestType) Object

extractErrors (store, typeClass, payload, id) Object

extractFind (store, typeClass, payload, id, requestType) Object

extractFindAll (store, typeClass, payload, id, requestType) Array

extractFindBelongsTo (store, typeClass, payload, id, requestType) Object

extractFindHasMany (store, typeClass, payload, id, requestType) Array

extractFindMany (store, typeClass, payload, id, requestType) Array

extractFindQuery (store, typeClass, payload, id, requestType) Array

extractId (modelClass, resourceHash) String

extractMeta (store, typeClass, payload)

extractQueryRecord (store, typeClass, payload, id, requestType) Object

extractRelationship (relationshipModelName, relationshipHash) Object

extractRelationships (modelClass, resourceHash) Object

extractSave (store, typeClass, payload, id, requestType) Object

extractSingle (store, primaryTypeClass, rawPayload, recordId) Object

extractUpdateRecord (store, typeClass, payload, id, requestType) Object

keyForAttribute (key, method) String

keyForLink (key, kind) String

keyForRelationship (key, typeClass, method) String

modelNameFromPayloadKey (key) String

normalize (typeClass, hash, prop) Object

normalize (typeClass, hash) Object

normalizeArray (store, modelName, arrayHash, prop) Object

normalizeArrayResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeCreateRecordResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeDeleteRecordResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeFindAllResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeFindBelongsToResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeFindHasManyResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeFindManyResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeFindRecordResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeQueryRecordResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeQueryResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeSaveResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeSingleResponse (store, primaryModelClass, payload, id, requestType) Object

normalizeUpdateRecordResponse (store, primaryModelClass, payload, id, requestType) Object

payloadKeyFromModelName (modelName) String

pushPayload (store, rawPayload)

serialize (snapshot, options) Object

IDs

Customization

Customizing an App-Wide Serializer

Tweaking the Default JSON

serialize (record, options) Object

serializeAttribute (snapshot, json, key, attribute)

serializeBelongsTo (snapshot, json, relationship)

serializeHasMany (snapshot, json, relationship)

serializeIntoHash (hash, typeClass, snapshot, options)

serializePolymorphicType (snapshot, json, relationship)