mongoose-omit-common-fields
Array of common fields to emit for Mongoose toObject/toJSON (helpful for security)
Table of Contents
Install
npm:
npm install mongoose-omit-common-fields
yarn:
yarn add mongoose-omit-common-fields
Usage
const mongoose = ;const mongooseHidden = ;const omitCommonFields = ; const Schema = ; Schema;
If you want to add additional keys to be omitted:
Schema;
Reference
For more information on -
and object notation, please see http://mongoosejs.com/docs/api.html#query_Query-select and https://github.com/mblarsen/mongoose-hidden.
API
omitCommonFields.underscored.keys
'_id' '__v' 'ip' 'last_ips' 'email' 'api_token' 'group' 'attempts' 'last' 'hash' 'password' 'salt' 'reset_token_expires_at' 'reset_token' 'google_profile_id' 'google_access_token' 'google_refresh_token'
omitCommonFields.underscored.str
"-_id -__v -ip -last_ips -email -api_token -group -attempts -last -hash -password -salt -reset_token_expires_at -reset_token -google_profile_id -google_access_token -google_refresh_token"
omitCommonFields.underscored.obj
_id: 0 __v: 0 ip: 0 last_ips: 0 email: 0 api_token: 0 group: 0 attempts: 0 last: 0 hash: 0 password: 0 salt: 0 reset_token_expires_at: 0 reset_token: 0 google_profile_id: 0 google_access_token: 0 google_refresh_token: 0
omitCommonFields.underscored.objTrue
_id: true __v: true ip: true last_ips: true email: true api_token: true group: true attempts: true last: true hash: true password: true salt: true reset_token_expires_at: true reset_token: true google_profile_id: true google_access_token: true google_refresh_token: true
omitCommonFields.camelCased.keys
'id' 'v' 'ip' 'lastIps' 'email' 'apiToken' 'group' 'attempts' 'last' 'hash' 'password' 'salt' 'resetTokenExpiresAt' 'resetToken' 'googleProfileId' 'googleAccessToken' 'googleRefreshToken'
omitCommonFields.camelCased.str
"-id -v -ip -lastIps -email -apiToken -group -attempts -last -hash -password -salt -resetTokenExpiresAt -resetToken -googleProfileId -googleAccessToken -googleRefreshToken"
omitCommonFields.camelCased.obj
id: 0 v: 0 ip: 0 lastIps: 0 email: 0 apiToken: 0 group: 0 attempts: 0 last: 0 hash: 0 password: 0 salt: 0 resetTokenExpiresAt: 0 resetToken: 0 googleProfileId: 0 googleAccessToken: 0 googleRefreshToken: 0
omitCommonFields.camelCased.objTrue
id: true v: true ip: true lastIps: true email: true apiToken: true group: true attempts: true last: true hash: true password: true salt: true resetTokenExpiresAt: true resetToken: true googleProfileId: true googleAccessToken: true googleRefreshToken: true
Tips
Note that this package is already built-in to mongoose-common-plugin.
Contributors
Name | Website |
---|---|
Nick Baugh | http://niftylettuce.com/ |