Joi noChange Plugin
A Joi plugin that validates the field it is attached to matches a sister object at the same path. This is extremely helpful when validating JSON Patches.
Installing
npm install joi-nochange --save
v3 Breaking Changes
Instead of having joi-nochange
extend Joi when required, v3 allows an instance of Joi to be passed in. This fixes an issue where other uses of Joi.extend
would become innefective if used before requiring joi-nochange
.
To migrate, change
const Joi = ;
to
const Joi = ;
Usage
const Joi = ; const origObj = id: 'k1773y' name: 'Cuddles' favoriteToys: 'string' meta: born: 1452474481612 weight: 21 // pounds ; const kitty = JSON; // clone kittymetaweight += 10; // Cuddles has been eating a lotkittyfavoriteToys; // and also likes catnipkittyid = 'best-cat-ever'; // but really isn't allowed to change ids const schema = Joiobjectlabel'cat'; const result = schema;// check and throw if there is an error (there is)if resulterror throw resulterror; // Joi Error: "child "cat" fails because ["id" is not allowed to change]"// object is available at `result.value`
Compatible Joi versions
This plugin works with multiple versions of Joi. Compatibility chart:
joi version | joi-nochange version |
---|---|
< 9.0.0 | < 1.0.0 (joi-pre-v9 branch) |
9.0.0 - 10.2.2 | 1.x.x (joi-v9 branch) |
10.x.x | 2.x.x (joi-v10 branch) |
11.0.0 + | > 3.0.0 (master branch) |
Finding Compatible Versions
There is a find-compatible.js
script that tests the currently checked out branch of joi-nochange
against all versions of joi>6
.