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

loudo-check

v7.0.2

Published

Add type/value safety checks to objects.

Downloads

87

Readme

loudo-check

Check is a small library for adding strict checks to objects.

import { Check } from "loudo-check"

class User extends Check.define({
  id: { v:1, min:1 },
  email:{ v:"[email protected]", regex:/[a-z0-9]+@[a-z]+\.[a-z]{2,3}/ },
  name:{ v:"Reba", min:1, max:100 }
}) {}

const inputJSON = `
{
  "id":1234,
  "email":"[email protected]",
  "name":"Flugelhorn"
}
`

const user = Check.parse(User, inputJSON)
const user2 = new User({
  id:1234,
  "email":"[email protected]",
  "name":"Flugelhorn",
})

Defining Checks

Use Check.define and pass in a schema consisting of various Check.Property objects that define the properties and the checks for that property.

Check.Property consists of the following fields:

  • The v field is a sample value for the property that should pass all of its checks. The v field is mandatory; every other field is optional.
  • The required field determines whether the property is required. If unspecified, it defaults to true. You can also use the special string value "default"; in that case, if the property is missing, the sample value (defined via v) will be used instead.
  • The min field is either the minimum value for the property (for numbers, Dates, and BigInts) or the minimum length/size of an array, arraylike, string, Set, or anything else that has a length or a size property. If unspecified, there is no minimum.
  • Similarly, the max field is either a maximum value (inclusive) or a maximum length/size (inclusive.) If unspecified, there is no maximum.
  • The allowed field is a set of discrete values that are allowed. If unspecified, all values are allowed (if they pass the other checks.)
  • The regex field is a regular expression that the string representation of the property must match. If unspecified, all values are allowed (if they pass the other checks.)
  • The integer field specifies whether or not a number property must be a safe integer. If unspecified, it defaults to true. If false, then real numbers, NaN, and infinities are allowed.

Check.define results in a class that consists of all the defined properties. You can use the class to directly construct instances, but the constructor will raise a CheckError if any of the checks you defined on the properties fail.

You can also pass the class to Check.run to see if checks would pass on input values, or to Check.parse to parse json.