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

simple-validate

v0.0.1

Published

Simple object validator.

Downloads

1

Readme

validate

Simple argument validator.

Install

$ npm install simple-validate

Run the specs

$ jasmine-node spec/

Usage

var validate = require('simple-validate');

var pattern = {
  title       : validate.required(isString)
  description : validate.isAll(isString, hasLengthGreaterThan(5)),
  isActive    : isBoolean,
  tags        : isArray
};

validate(pattern, {
  title       : 'Hi There',
  description : 'This is a great post.',
  isActive    : true
  // tags are undefined - but that is ok, validator treats them as optional
});
// => true

The validator runs each argument against the defined validation pattern, asserting a true outcome for each. Properties defined in the validation pattern are assumed to be optional unless declared otherwise.

Note, this module is best used with a functional library to provide predicates (isString, isNull, etc.), such as lodash or ramda.

A more advanced example can also be found in the examples directory.

Available Methods

validate

Object -> Object -> Boolean

Validates arguments against the provided pattern.

validate(<pattern>, <args>) -> Boolean

Logical Utilities

Note: all logical utilities must be called incrementally (fn(v1)(v2)) as shown in the examples below.

validate.required

Predicate -> Predicate

Returns a predicate that is satisfied if the supplied predicate is satisfied and the provided value is not undefined. This should be used to denote that a property is required, since otherwise properties as assumed to be optional.

validate.required(p) -> Function
validate.required(p)(<value>) -> Boolean

validate.optional

Predicate -> Predicate

Returns a predicate that is satisfied if the supplied predicate is satisfied or the provided value is undefined. Note: using this utility is probably not necessary to use often, since validate assumes all properties are optional by default. This is the shorthand equivalent to isAny(isUndefined, p).

validate.optional(p) -> Function
validate.optional(p)(<value>) -> Boolean

validate.isAll

Predicates -> Predicate

Returns a predicate that is satisfied if all supplied predicates are satisfied for the provided value.

validate.isAll(p1, p2, ...) -> Function
validate.isAll(p1, p2, ...)(<value>) -> Boolean

validate.isAny

Predicates -> Predicate

Returns a predicate that is satisfied if any of the supplied predicates are satisfied for the provided value.

validate.isAny(p1, p2, ...) -> Function
validate.isAny(p1, p2, ...)(<value>) -> Boolean

validate.isNot

Predicate -> Predicate

Returns a predicate that inverts the supplied predicate.

validate.isNot(p) -> Function
validate.isNot(p)(<value>) -> Boolean

TODO

  • Add custom error handling validate.withErrors(<pattern>, <values>). Consider adding getErrors, etc. Will probably include helper method to map pattern values for general usage.
  • Document new error handling methods.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request