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

indicatrice

v0.4.1

Published

A library for validating data cleanly

Downloads

2

Readme

indicatrice

This is a library for cleanly validating the type of data.

Please, send issues if you find any bugs or want any improvement on the library. Thank you for using indicatrice !

Definition of JSON-able

It is a value that is either:

  • a string
  • a number
  • a boolean
  • null or undefined
  • an array of JSON-able
  • an object of JSON-able with string keys

Unlike the official one, we allow undefined

API

List of available indicator function:

All the functions below take a value, test whether it is of the proper type. If it is, it returns it as is, if not it throws an Error

  • indicatrice.json: JSON-able values
  • indicatrice.number: Number
  • indicatrice.string: String
  • indicatrice.boolean: Boolean
  • indicatrice.object.type: Object (that is not an Array or a Function)
  • indicatrice.array.type: Array

indicatrice.object

Takes an object of indicator functions and returns a function that test whether a piece of data is an object of the given shape.

Example

const validator = object({
  firstname: string,
  lastname: string,
  accountant: object({
    firstname: string,
    lastname: string,
  }),
  bankDetails: object({
    iban: string,
    bic: string,
  }),
});

const data = // some data
validator(data);

indicatrice.array

Takes an object of indicator functions and returns a function that tests whether a piece of data is an array with values of a given type.

Example

const validator = array(object({
  husband: object({
    id: number,
    firstname: string,
    lastname: string
  }),
  wife: object({
    id: number,
    firstname: string,
    lastname: string,
  }),
  numberOfChildren: number,
  childrenId: array(number), 
}));

const data = // some data
validator(data);

Twitter api example

I propose to use this library for API response validation. Sometimes, API can be modified or can be maliciously hacked, it is a good security measure to have it validated by some light type validation method. I have prepared an example using a Twitter API response.

Check out the example directory to analyze how I suggest you use this library.

Things to know about types

This section will be filled with information about types in Javascript. This is just to contextualize you on how types work in JS. It's made for new people so that they understand why some weird things can happen.