Monastery-js NPM

npm.io

Features

User friendly API design
Simple CRUD methods with model population
Model validation deriving from your schema
Custom error messages can be defined in your schema
Error response ready for client consumption
Automatic index setup
Lightweight

Install

This repository is distributed with NPM. After installing NPM, you can install Monastery via:

npm install --save monastery-js

Usage

// Require monastery
const monastery = require('monastery-js')

// Initalise a model
let user = monastery.model('user', {
  fields: {
    name: { type: 'string' },
    pets: [{ type: 'string' }],
    address: { city: { type: 'string', minLength: 20 } },
    points: [[{ type: 'number' }]]
  }
})

// Validate some data
user.validate({
  name: 'Ip Man', 
  pets: ['sparky', 'tiny'],
  address: { city: 'Christchurch' },
  points: [[1, 5], [3, 1]]

}).then(data => {
  // valid data..

}).catch(errs => {
  // [{
  //   detail: "Value needs to be at least 10 characters long.",
  //   status: "400",
  //   title: "city",
  //   meta: {
  //     model: "user",
  //     path: "address.city",
  //     rule: "minLength"
  //   }
  // }]
})