objection-validator v0.0.3

validator-creator plugin for Objection.js

This is an Objection.js model mixin plugin that provides an alternate system for validation.

Validation is configured using rule collections from validator-creator.

class Validator:

Validator is a class mixin

// Person.js
import { Model } from "objection";
import { Validator } from "objection-validator";
import { required, email } from "./rules";

class Person extends Validator(Model) {
  static tablename = "person";

  static rules = {
    name: [required],
    email: [required, email]
  };

  static defaultAttributes = {
    // force 'required' rule to apply during insert() even if not provided
    name: ""
  };
}

API

static rules

A validator-creator rules collection that lists the validation rules to apply to each field.

static defaultAttributes

Set default values for model attributes during an insert. This is a useful way to ensure the attribute is validated even if not supplied.

$beforeValidatorValidate(rules, json, modelOptions, queryContext)

Before validation hook. Allows modifying the rules object before processing.

json contains the external representation of the model attributes to validate.

modelOptions contains update options if an update operation is being performed. For insert operations it is null. details

queryContext contains the query context and transaction instance. details

Return rules or undefined to make no change.

Return a new rule collection object to alter the rules.

$afterValidatorValidate(json, modelOptions, queryContext)

After validation hook

$validatorValidate(json, modelOptions, queryContext)

Called automatically from Model.$beforeInsert() and Model.$beforeUpdate()

$validatorToJson(modelOptions, queryContext)

Allows to override the json data to validate. The default implementation returns the model's $toJson() response.

class ValidatorError

If validation fails a ValidatorError exception is thrown.

import { ValidatorError } from "objection-validator";
try {
  await Person.query().insert({ name: "" });
} catch (error) {
  if (error instanceof ValidatorError) {
    // --> error.validation: [ {type: "required", prop: "title" }]
  }
}