Merge pull request #2 from mystand/omit_in_schema

add omit to schema

README.md

@@ -108,6 +108,21 @@ serialize.user(test_users)
 //    photo: [[Object], [Object]],
 //    name: 'Tester2',
 //    password: '12345678' }]
+
+// If you always want to get all fields of object excluding some of them, use omit in schema
+serialize.add('omitUserPassword', {
+  omit: ['password']
+})
+
+const plainUser = {
+  name: 'Tester',
+  email: '[email protected]',
+  password: '12345'
+}
+
+console.log(serialize.omitUserPassword(plainUser))
+// ==>
+// { name: 'Tester', email: '[email protected]' }
 ```
 
 ### Options

index.js

@@ -76,6 +76,10 @@ class Serializer {
           }
         }
 
+        if (Array.isArray(schema.omit)) {
+          attributes = attributes.filter(attribute => !schema.omit.includes(attribute))
+        }
+
         if (!_.isObject(options)) {
           throw new WrongTypeError('options', 'object', options)
         }

test.js

@@ -44,7 +44,7 @@ serialize.add('photo', {
   }
 })
 
-// If you want to add all fields of object with some formatters and don't want to 
+// If you want to add all fields of object with some formatters and don't want to
 // write all fields in attributes option, you can use extraAttributes option.
 serialize.add('userThroughExtraAttributes', {
   extraAttributes: ['email1', 'email2'],
@@ -198,3 +198,18 @@ console.log(serialize.testGetters(galleryWithGettersValues).map(el => el.gallery
 //     { url: '/test/path/img41337.png1337', test: [Object] }
 //   ]
 // ]
+
+// If you always want to get all fields of object excluding some of them, use omit in schema
+serialize.add('omitUserPassword', {
+  omit: ['password']
+})
+
+const plainUser = {
+  name: 'Tester',
+  email: '[email protected]',
+  password: '12345'
+}
+
+console.log(serialize.omitUserPassword(plainUser))
+// ==>
+// { name: 'Tester', email: '[email protected]' }