npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

joi-nochange

v3.0.0

Published

Adds noChange() to Joi

Downloads

4

Readme

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.

Build Status

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 = require('joi-nochange');

to

const Joi = require('joi-nochange')(require('joi'));

Usage

const Joi = require('joi-nochange')(require('joi'));

const origObj = {
    id: 'k1773y',
    name: 'Cuddles',
    favoriteToys: ['string'],
    meta: {
        born: 1452474481612,
        weight: 2.1 // pounds
    }
};

const kitty = JSON.parse(JSON.stringify(origObj)); // clone

kitty.meta.weight += 10; // Cuddles has been eating a lot
kitty.favoriteToys.push('catnip'); // and also likes catnip
kitty.id = 'best-cat-ever'; // but really isn't allowed to change ids

const schema = Joi.object().keys({
    id: Joi.string().noChange(origObj).required().label('id'),
    name: Joi.string().required().label('name'),
    favoriteToys: Joi.array().items(Joi.string().label('toy')).default([]).label('favoriteToys'),
    meta: {
        born: Joi.number().positive().integer().noChange(origObj).required().label('born'),
        weight: Joi.number().positive().unit('pounds').label('weight')
    }
}).label('cat');

const result = schema.validate(kitty);
// check and throw if there is an error (there is)
if (result.error) {
    throw result.error; // 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.