Contents

• Installation
• Basic Usage
• Extras
  • Domain
  • Custom Error Messages

Installation

npm add yooda

Basic Usage

import validator from "yooda";

const requestBodySchema = {
	name: {
		type: "string",
		required: true
	},
	age: {
		type: "number",
		required: true
	}
};

const requestBody = {
	name: "Ademola Adegbuyi",
	age: 23
};

try {
	const validate = validator(requestBodySchema);
	validate(requestBody);
} catch (err) {
	res.status(500).send(err);
}

That's it, really. If the value doesn't meet the requirement, it throws an error and you can handle it as you want.

Extras

Domain

This is more like a plugin, to ensure some other personal requirements are met asides from the regular "required" and "type". We definitely cannot offer a way to solve all kinds of edge-cases so we're giving you a buffet; Be your own boss, control the nature of the validation.

Here's how to use it:

const shouldStartWithA = value => value.startsWith("a");
// attach it to your schema
const requestBodySchema = {
	name: {
		type: "string",
		required: true,
		domain: [shouldStartWithA]
	}
};
const validate = validator(requestBodySchema);
validate(requestBody);

The convention you decide to pick is up to you. The one used in the example above is a function that is used on the fly. You could just create an object of domains as done in the test file. You could also have them in a separate file and import only the ones needed.

Custom Error Messages

You could define how errors will be thrown based on the supported error types (requiredError, typeError, and domainError), and it's very easy to use! A short example:

const schema: Schema = {
	age: {
		type: "number",
		required: true,
		domain: [domains.IS_POSITIVE]
	}
};

const customErrorHandlers: CustomErrorHandlers = {
	domainError: ({ value, domain }) =>
		`${value} doesn't satify the ${domain} requirement`
};

const validate = validator(schema, customErrorHandlers);

Props available to the error types:

Note that: only the props required will be suggested to you via intellisense 🙏

type RequiredErrorProps = {
	key: string;
};

type TypeErrorProps = {
	key: string;
	type: string;
	value: any;
};

type DomainErrorProps = {
	key: string;
	type: string;
	value: any;
	domain: string;
};

LICENSE

MIT