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

conformant

v1.0.1

Published

Conformant exports three functions:

Downloads

7

Readme

Conformant

Conformant exports three functions:

  • conform
  • check
  • instrument

Each of those functions takes three values:

  • specs: a map of spec ids to specs
  • spec: either an id from the map, or a spec
  • value: some value which is checked against the spec

specs

a spec can be one of three things:

  • a string, which is a reference to another spec
  • a function, which is passed a value and returns true or false
  • a formal spec using a command

commands

All specs can be resolved to a command, and all other specs can be resolved to the 'predicate' command.

A spec that uses a command is called a 'formal spec'. It is an array containing the command followed by its arguments.

Here are some examples of formal specs:

['predicate', value => value === 'Bob Zucchini'] ['keys', 'staleness', 'crustiness', 'yeast']

commands are passed an object with:

args

check

specs

predicate

Predicate takes one argument: a function.

Here's an example predicate: ['predicate', v => v === true]

function

A function spec takes one argument, a config object with up to three keys:

  • args: a spec describing the arguments to the function
  • ret: a spec describing the return value of the function
  • fn: a predicate function passed ([...args], returnValue) describing the relationship between them

None of those keys are checkable until apply-time, so function specs are mostly useful with the provided instrument function, rather than check and conform.

or

and

keys

tuple

every

conformant.check

conformant.check takes three arguments, which may be passed separately:

  • specs
  • spec
  • value

it returns true or false

conformant.conform

takes three arguments:

  • specs
  • spec
  • value and returns either the value, if it satisfies the spec, or the string "conform/invalid"

conformant.instrument

instrument takes three arguments:

  • specs
  • spec -- must be a 'function' command spec
  • function

it returns a modified function that checks its arguments, return value, and their relationshp against the config provided in the spec, and throws if they aren't satisfied.