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

@grandchaman/cval

v1.0.3

Published

A better way to validate API request

Downloads

4

Readme

CVal

This projet has goal to make request validation much easier

Initialization

You can inizialize cval with a custom version of joi like that

const cval = require("@grandchaman/cval")({
	required: true, /** Throw error if field with tag is missing **/
	}, /** require("custom_joi") **/);

Usage

When an error occur, cval will throw an error. Don't forget to use try catch

Prototype

cval.create(schema, data); // => validate and trimmed object
cval.read(schema, data); // => validate and trimmed object
cval.update(schema, data); // => validate and trimmed object
cval.delete(schema, data); // => validate and trimmed object
cval.validate(method, schema, data); // => validate and trimmed object
cval.express.query(method, schema); // => express middleware for query
cval.express.params(method, schema); // => express middleware for params
cval.express.body(method, schema); // => express middleware for body

Normal

You can validate content normally using the following methods :

  • create ("c")
  • read ("r")
  • update ("u")
  • delete ("d")

Then use it like that :

const Joi = require("joi");


const schema = {
	a: Joi.string().length(10).required().tags(['c']),
	b: Joi.number().tags(['d'])
}

var res = cval.create(schema, 
	{
		a: "HelloWorld",
		b: 5
	});
/**
 * res = {
 *	a: "HelloWorld"
 * }
 */

// You can also you custom method like that
res = cval.validate('d', schema, 
	{
		a: "HelloWorld",
		b: 5
	});
/**
 * res = {
 *	b: 5
 * }
 */

Express

You can use cval as an express middleware like so:

const schema = {
	id: Joi.number().min(0).max(10).required()
};

router.get('/user/:id', cval.express.query('r', schema), (req, res) =>
{
	/**
	 * Your code here
	 */
});