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

opzet

v0.5.7

Published

Object validation and transformation

Downloads

28

Readme

Opzet - JavaScript object validation

Node version NPM Downloads Minified size License: MIT

A lightweight library that allows for object schema validation. A schema is an object where the keys match the keys of the object you want to validate. Within the schema, each key has an array of 'rules' attached. A rule is simply something that returns nothing or a 'string' indicating the error.

type ValidationError = string;
type Rule = (value: unknown, obj?: object) => ValidationError | null;
type Schema = Record<string, Rule[]>;

Opzet validates each individual rule in the schema. If a key of an object does not comply with one or more rules, all error messages are returned. This allows you to add an order to the rules as well.

import { validate, string, required } from "opzet";
const obj = { key: "value" };
const schema = { key: [string.type], required: [required, string.type] };
validate(obj, schema);
// returns { required: 'required' };

Default rules

Opzet has a set of default rules build in.

import { string, number, boolean, object, array, required } from "opzet";
  • required: checks if the value exists or not. If invalid, returns 'required';
  • <string|number|boolean|object|array|datetime>.type: checks if the value is of the correct type. If invalid, returns 'type';
  • <string|number|array|datetime>.min(num: number | date): checks the (inclusive) minimum value/length (e.g. array.length <= num). Should be applied as array.min(3). If invalid, returns '.min';
  • <string|number|array|datetime>.max(num: number | date): checks the (inclusive) maximum value/length (e.g. array.length <= num). Should be applied as array.max(3). If invalid, returns '.max';
  • string.<email|url|uuid|iban>: checks if the value is within the correct format. If invalid, returns 'string.';
  • string.enum(allowed: string[]): checks if the value is one of the allowed string values. If invalid, returns 'string.enum';

For examples, check the tests.