Repository files navigation

This plugin adds the ability to whitelist or blacklists model properties.

npm install objection-visibility

You can enable this plugin by either setting the static propertyhidden orvisible to your model.

It is possible to have a model which have both properties defined, note that thevisible method is called first and thehidden method second.

To enable blacklisting on your model add the static propertyhidden on your model and return an array with the fields you want to blacklist.

The listed fields are gone after being serialized to json

constModel=require('objection').ModelconstvisibilityPlugin=require('objection-visibility').default;classUserextendsvisibilityPlugin(Model){staticgethidden(){return['hashed_password'];}}

To enable whitelisting on your model add a static propertyvisible on your model and return an array with the fields you want to be whitelisted

The listed fields will be the only properties available after being serialized to json

constModel=require('objection').ModelconstvisibilityPlugin=require('objection-visibility').default;classUserextendsvisibilityPlugin(Model){staticgetvisible(){return['firstName','id']}}

Can be used on a base model and have it readily available on all your models

Models that dont have the static propertiesvisible orhidden will remain untouched.

// base.jsclassBaseModelextendsvisibilityPlugin(Model){}// post.jsclassPostextendsBaseModel{staticgetvisible(){return['description','title']}}// user.jsclassUserextendsBaseModel{staticgethidden(){return['hashedPassword']}}