Merge pull request #3035 from Dremora/key_serializer_docs

Add method argument to key serialization docs
emberjs · May 1, 2015 · 8c81d41 · 8c81d41
2 parents 6d47319 + e23bcea
commit 8c81d41
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 10 deletions.
diff --git a/packages/ember-data/lib/serializers/json-serializer.js b/packages/ember-data/lib/serializers/json-serializer.js
@@ -554,7 +554,7 @@ export default Serializer.extend({
       var payloadKey =  this._getMappedKey(key);
 
       if (payloadKey === key && this.keyForAttribute) {
-        payloadKey = this.keyForAttribute(key);
+        payloadKey = this.keyForAttribute(key, 'serialize');
       }
 
       json[payloadKey] = value;
@@ -671,7 +671,7 @@ export default Serializer.extend({
       serializePolymorphicType: function(snapshot, json, relationship) {
         var key = relationship.key,
             belongsTo = snapshot.belongsTo(key);
-        key = this.keyForAttribute ? this.keyForAttribute(key) : key;
+        key = this.keyForAttribute ? this.keyForAttribute(key, "serialize") : key;
 
         if (Ember.isNone(belongsTo)) {
           json[key + "_type"] = null;
@@ -1032,42 +1032,44 @@ export default Serializer.extend({
 
    ```javascript
    App.ApplicationSerializer = DS.RESTSerializer.extend({
-     keyForAttribute: function(attr) {
+     keyForAttribute: function(attr, method) {
        return Ember.String.underscore(attr).toUpperCase();
      }
    });
    ```
 
    @method keyForAttribute
    @param {String} key
+   @param {String} method
    @return {String} normalized key
   */
-  keyForAttribute: function(key) {
+  keyForAttribute: function(key, method) {
     return key;
   },
 
   /**
    `keyForRelationship` can be used to define a custom key when
-   serializing relationship properties. By default `JSONSerializer`
-   does not provide an implementation of this method.
+   serializing and deserializing relationship properties. By default
+   `JSONSerializer` does not provide an implementation of this method.
 
    Example
 
     ```javascript
     App.PostSerializer = DS.JSONSerializer.extend({
-      keyForRelationship: function(key, relationship) {
-         return 'rel_' + Ember.String.underscore(key);
+      keyForRelationship: function(key, relationship, method) {
+        return 'rel_' + Ember.String.underscore(key);
       }
     });
     ```
 
    @method keyForRelationship
    @param {String} key
    @param {String} relationship typeClass
+   @param {String} method
    @return {String} normalized key
   */
 
-  keyForRelationship: function(key, typeClass) {
+  keyForRelationship: function(key, typeClass, method) {
     return key;
   },
 

diff --git a/packages/ember-data/lib/serializers/rest-serializer.js b/packages/ember-data/lib/serializers/rest-serializer.js
@@ -40,7 +40,7 @@ function coerceId(id) {
 
   ```js
   App.ApplicationSerializer = DS.RESTSerializer.extend({
-    keyForAttribute: function(attr) {
+    keyForAttribute: function(attr, method) {
       return Ember.String.underscore(attr).toUpperCase();
     }
   });