[DOC] shorthand methods and quotes for json-api serializer (#4778)

* [DOC] shorthand methods and quotes for json-api serializer * Update example paths * Revert destructure
emberjs · Jan 27, 2017 · dc1a68c · dc1a68c
1 parent 4f1a7b1
commit dc1a68c
Showing 1 changed file with 22 additions and 26 deletions.
diff --git a/addon/serializers/json-api.js b/addon/serializers/json-api.js
@@ -24,30 +24,28 @@ const dasherize = Ember.String.dasherize;
 
   This serializer normalizes a JSON API payload that looks like:
 
-  ```js
-
-    // models/player.js
-    import DS from "ember-data";
-
-    export default DS.Model.extend({
-      name: DS.attr(),
-      skill: DS.attr(),
-      gamesPlayed: DS.attr(),
-      club: DS.belongsTo('club')
-    });
+  ```app/models/player.js
+  import DS from 'ember-data';
+
+  export default DS.Model.extend({
+    name: DS.attr('string'),
+    skill: DS.attr('string'),
+    gamesPlayed: DS.attr('number'),
+    club: DS.belongsTo('club')
+  });
+  ```
 
-    // models/club.js
-    import DS from "ember-data";
+  ```app/models/club.js
+  import DS from 'ember-data';
 
-    export default DS.Model.extend({
-      name: DS.attr(),
-      location: DS.attr(),
-      players: DS.hasMany('player')
-    });
+  export default DS.Model.extend({
+    name: DS.attr('string'),
+    location: DS.attr('string'),
+    players: DS.hasMany('player')
+  });
   ```
 
   ```js
-
     {
       "data": [
         {
@@ -104,7 +102,6 @@ const dasherize = Ember.String.dasherize;
 
   ```app/serializers/application.js
   export default JSONAPISerializer.extend({
-
     normalizeArrayResponse(store, primaryModelClass, payload, id, requestType) {
       let normalizedDocument = this._super(...arguments);
 
@@ -122,7 +119,6 @@ const dasherize = Ember.String.dasherize;
 
       return normalizedRelationship;
     }
-
   });
   ```
 
@@ -439,7 +435,7 @@ const JSONAPISerializer = JSONSerializer.extend({
    import DS from 'ember-data';
 
    export default DS.JSONAPISerializer.extend({
-     keyForAttribute: function(attr, method) {
+     keyForAttribute(attr, method) {
        return Ember.String.dasherize(attr).toUpperCase();
      }
    });
@@ -469,7 +465,7 @@ const JSONAPISerializer = JSONSerializer.extend({
     import DS from 'ember-data';
 
     export default DS.JSONAPISerializer.extend({
-      keyForRelationship: function(key, relationship, method) {
+      keyForRelationship(key, relationship, method) {
         return Ember.String.underscore(key);
       }
     });
@@ -653,7 +649,7 @@ if (isEnabled("ds-payload-type-hooks")) {
       `post` model should be used:
 
       ```app/serializers/application.js
-      import DS from "ember-data";
+      import DS from 'ember-data';
 
       export default DS.JSONAPISerializer.extend({
         modelNameFromPayloadType(payloadType) {
@@ -701,11 +697,11 @@ if (isEnabled("ds-payload-type-hooks")) {
       namespaces model name for the `post` should be used:
 
       ```app/serializers/application.js
-      import DS from "ember-data";
+      import DS from 'ember-data';
 
       export default JSONAPISerializer.extend({
         payloadTypeFromModelName(modelName) {
-          return "api::v1::" + modelName;
+          return 'api::v1::' + modelName;
         }
       });
       ```