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

check-verify

v1.0.2

Published

Parameter validation utility

Downloads

29

Readme

check-verify

Greenkeeper badge

Build Status Coverage Status Deps devDependency Status

NPM

A module for validating function and method parameters with support for deep references using dot notation. Supports throwing errors and rejecting promises.

Basic Usage

check-verify exports two functions: thrower and promiser. Both return a CheckVerify object with slightly different behaviour.

thrower()

The thrower() function can be used in two ways: FailFast mode and Verify mode.

FailFast mode is enabled by providing an object to the thrower function. If no object is supplied to will default to Verify mode. Verify mode will wait for verify() to be called before validating whereas FailFast mode with execute the check as they are declared.

A thrower in Verify mode can be assigned to a variable and reused.

FailFast Mode

const thrower = require("check-verify").thrower;

function addUser(id, person) {

	thrower({ id, person })
		.check("id").is.a.number() // an error will be thrown here
		.check("person.first").is.a.string()
		.check("person.last").is.a.string()
		.optional("person.title").is.a.string();

		// do stuff
}

addUser("123", { first: "john", last: "doe"});

Verify Mode

const thrower = require("check-verify").thrower;

function addUser(id, person) {

	thrower()
		.check("id").is.a.number()
		.check("person.first").is.a.string()
		.check("person.last").is.a.string()
		.optional("person.title").is.a.string()
		.verify({ id, person }); // an error will be thrown here

		// do stuff
}

addUser("123", { first: "john", last: "doe"});

promiser()

The promiser method returns a CheckVerify object that will reject a promise instead of throwing an error. It does not support FailFast mode.

const promiser = require("check-verify").promiser;

function addUser(id, person) {

	return promiser()
		.check("id").is.a.number()
		.check("person.first").is.a.string()
		.check("person.last").is.a.string()
		.optional("person.title").is.a.string()
		
		.verify({ id, person })
		.then(() => {
			// do stuff
		})
		.catch(error => {
			// deal with error
		});

}

addUser("123", { first: "john", last: "doe"});

CheckVerify Syntax and methods

Supported validations

  • boolean
  • string
  • number
  • array
  • object
  • url
  • date

Additional Grammar

  • a
  • an
  • is
  • that

For debugging purposes you can also use explain():

	const result = thrower()
		.check("id").is.a.number()
		.explain();

		console.log(result);
/*
 [ { field: 'id', tests: [ 'number' ] },
  { field: 'first', tests: [ 'string' ] } ]
*/

Road to v1

  • review documentation
  • improve keywords for npm search