node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »



Bookshelf plugin for simpler model validation and field format convertion.

Please look at bookshelf-schema - plugin that does the same and many more!

What exactly it does

First of all when plugged in with call to db.plugin it (re)defines several db.Model methods:

  • validate - perform validation of model with CheckIt. It uses instance array 'validations' for field-level validation and array 'model_validations' for validating the whole model.

  • format/parse - for each field defined in model applys its format/parse method

Then when field is applyed to a model it

  • stores the itself in the models __meta.fields array

  • may add some validation rules to validations of model_validations arrays

  • defines property with the same name. By default this property only calls basic set and get methods. You may prevent creation of property by passing dont_create_properties: true or create_properties: false to Fields.plugin or as an option of the field

And finally when called to enable_validation it redefines models initialize method, adding subscription to event 'saving' to perform validation.

Basic usage

First you need to require bookshelf-fields and apply exported plugin to an initialized database instance:

Fields = require 'bookshelf-fields'
db.plugin Fields.plugin(options)

Now you are ready to add fields information to models. There are two equivalent ways to do it: with exported functions 'field', 'fields' and 'enableValidation' and with the same methods, mixed into a Model prototype. If you choose the second way you need to pass option augement_model: true to plugin.

Provided helpers

  • db.Checkit - Checkit module used for validation

  • plugin(options) - method that mixes Fields functionality into a Bookshelf Model

    db.plugin Fields.plugin()

  • enable_validation(model, options) - actually turn on validation for a specified model. Options are stored in Model.prototype.validation_options and passed to Checkit when validation applied.


  • field(model, field_class, name, options) - add field to a model

    field(User, Fields.StringField, 'username', {max_length: 64})

  • fields(model, field_definitions...) - add a bunch of fields to a model. field_definitions is one or more arrays like [field_class, name, options]


Common options

  • required: boolean - field must be provided and not empty

  • exists: boolean - field must not be undefined

  • choices: [array or hash] - field must have one of provided values

    choices may be defined as an array (['foo', 'bar']) or as a hash ({foo: 'foo description', bar: bar description'}). If hash used then field value is compared with hash keys.

  • comparator: function - used with choices to provide custom equality checker.

    Useful if fields value is an object and simple '==' is not adequate.

  • message: used as a default error message.

  • label: used as a default field label and substituted to error message. Look at tgriesser/checkit for details.


  • min_length | minLength: integer
  • max_length | maxLength: integer


StringField with simple check that value looks like a email address


Does no any validation - use IntField or FloatField instead!

  • gt | greater_than | greaterThan: integer
  • gte | greater_than_equal_to | greaterThanEqualTo | min: integer
  • 'lt|less_than|lessThan`: integer
  • lte | less_than_equal_to | lessThanEqualTo | max: integer


NumberField checked to be Integer. Applys parseInt when loaded.


NumberField checked to be Float. Applys parseFloat when loaded.


Casts value to Boolean on parse and format.


Validates that value is a Date or a string than can be parsed as Date. Converts value to Date on parse and format.


DateTimeField with stripped Time part.


Validates that value is object or a valid JSON string. Parses string from JSON when loaded and stringifies to JSON when formatted.

Advanced validation

  • you may assign object instead of value to validation options:

    mix_length: {value: 10, message: '{{label}} is too short to be valid!'}

    Additional options will be passed to checkit.

  • you may add complete Checkit validation rules to field with validations option:

    @field StringField 'username', validations: [{rule: 'minLength:5'}]

Add custom behaviour

You can add extra validations to models arrays validations and model_validations. Just make sure that you doesn't throw away validations added by fields. If you redefine initialize method call parent initialize or manage calling validate method on model saving. You can also redefine validate method.



Bookshelf = require 'bookshelf'
Fields = require 'bookshelf-fields'
db = Bookshelf.initialize
    client: 'sqlite'
        filename: './test.db'
db.plugin Fields.plugin(augement_model: true)
class User extends db.Model
    tableName: 'users'
    @field Fields.StringField'username'max_length: 32
    @field Fields.EmailField'email'
new User(username: 'bogus'email: '').save()
    .otherwise (errors) ->
        console.log errors.toJSON()
        throw errors
    .then (user) ->
        console.log user.username # username is a property, calling @get('username') in getter 
 = 'invalid-email' # calls @set('email', 'invalid-email') in setter 
 (errors) ->
            console.log errors.toJSON() # { email: 'The email must contain a valid email address' } 


Bookshelf = require('bookshelf');
Fields = require('bookshelf-fields');
var db = Bookshelf.initialize({
    client: 'sqlite',
    connection: { filename: './test.db' }
User = db.Model.extend({ tableName: 'users' });
    [Fields.StringField, 'username', {max_length: 32}],
    [Fields.EmailField, 'email']
new User({username: 'bogus', email: ''}).save()
    .otherwise(function(errors) {
        throw errors;
    }).then(function(user) {
        console.log(user.username); // username is a property, calling @get('username') in getter 
 = 'invalid-email'; // calls @set('email', 'invalid-email') in setter 
            console.log(errors.toJSON()); // { email: 'The email must contain a valid email address' }