rename megapost to compound

Author: nicosefer

README.md

@@ -85,7 +85,7 @@ class ListItemSerializer extends JSONAPISerializer {
 }
 
 
-new ListItemSerializer.serialize({data,meta,lang,includeWhitelistKeys, megapost})
+new ListItemSerializer.serialize({data,meta,lang,includeWhitelistKeys, compound})
 ```
 
 #### Available serialize config params
@@ -94,7 +94,7 @@ new ListItemSerializer.serialize({data,meta,lang,includeWhitelistKeys, megapost}
 - **meta**: (optional) object to set as meta response
 - **lang**: (optional) string for i18n purposes
 - **includeWhitelistKeys**: (optional) csv string for bounding included entities. If not set all entities will be set on included array response
-- **megapost**: (optional default:false) serialize as megapost
+- **compound**: (optional default:false) serialize as megapost
 
 #### Available serializerConfig return object props
 
@@ -296,7 +296,7 @@ const listItemSerializer = new ListItemSerializer();
 // nested with includes
 const output = listItemSerializer.serialize({
   data: inputData,
-  megapost: true,
+  compound: true,
 });
 
 console.log(output);

src/index.ts

@@ -302,7 +302,7 @@ export class JSONAPISerializer {
     serializedEntities: JSONApiResource[],
     lang: string,
     includeWhitelistKeys: string[] | null,
-    megapost: boolean
+    compound: boolean
   ): JSONApiResource {
     const entityId = get(data, "id");
     const entityType = get(data, "type") || config.type;
@@ -398,10 +398,10 @@ export class JSONAPISerializer {
               serializedEntities,
               lang,
               newIncludeWhitelistKeys,
-              megapost
+              compound
             );
 
-            if (megapost) {
+            if (compound) {
               output.relationships[dashCaseKey].data[i] = serializedEntity;
             } else {
               this.addToIncluded(includedEntities, serializedEntity);
@@ -427,10 +427,10 @@ export class JSONAPISerializer {
             serializedEntities,
             lang,
             newIncludeWhitelistKeys,
-            megapost
+            compound
           );
 
-          if (megapost) {
+          if (compound) {
             output.relationships[dashCaseKey].data = serializedEntity;
           } else {
             this.addToIncluded(includedEntities, serializedEntity);
@@ -494,7 +494,7 @@ export class JSONAPISerializer {
     meta,
     lang,
     includeWhitelistKeys,
-    megapost,
+    compound,
   }) {
     const output: any = {};
     let entities;
@@ -512,7 +512,7 @@ export class JSONAPISerializer {
           serializedEntities,
           lang,
           includeWhitelistKeys,
-          megapost
+          compound
         );
       });
     } else {
@@ -523,7 +523,7 @@ export class JSONAPISerializer {
         serializedEntities,
         lang,
         includeWhitelistKeys,
-        megapost
+        compound
       );
     }
 
@@ -546,15 +546,15 @@ export class JSONAPISerializer {
       meta,
       lang,
       includeWhitelistKeys,
-      megapost = false,
+      compound = false,
     } = request;
     return this._serialize({
       data,
       config: this.serializerConfig(),
       meta,
       lang,
       includeWhitelistKeys,
-      megapost,
+      compound,
     });
   }
 }

src/types.ts

@@ -57,5 +57,5 @@ export type SerializeRequest = {
   meta?: any;
   lang?: string;
   includeWhitelistKeys?: string;
-  megapost?: boolean;
+  compound?: boolean;
 };