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

define-options

v0.1.3

Published

Define valid properties for an options litteral, and return a function that can validate the options

Downloads

39,710

Readme

define-options

Micro lib to define valid properties for an options litteral, and return a function that can validate the options.

The main benefit is self-documenting code. Users of your library doesn't have to scan through the code to see what properties from the options object that is used throughout the code. As a bonus you can easily throw an error early if a consumer is using an option with the wrong type, or a required option is missing. They will get a hint from the error message what they did wrong instead of searching for docs.

API

var defineOpts   = require('define-options');
var validateOpts = defineOpts({
        optionalParam   : '*             - This parameter can be null, undefined or any value',
        optionalString  : '?|string      - This is an optional string',
        aString         : 'string        - Required string. Can be blank.',
        aNumber         : 'number        - Required number. Can be 0.',
        aNumberOrString : 'number|string - Required number or string',
        aStringArray    : 'array         - Required array of any types',
        aStringArray    : 'string[]      - Required array with strings',
        aNumberArray    : 'number[]      - Required array with numbers',
        anObject        : 'object        - Required object',
        aFunction       : 'function      - Required function',
        aBboolean       : 'boolean       - Required boolean'
    });

function yourAPI(options) {
  validateOpts(options); // throws an error if options doesn't validate

  // do your stuff
}

Optional options object

If all options are optional, the null will not throw an error.

var validateOpts = defineOpts({ foo: '?|string' });
validateOpts();               //all OK
validateOpts({foo: 'bar'});   // all OK
validateOpts({foo: 123});     // Exception: foo has to be of type ?|string but was number

Valid types

'array', 'boolean', 'function', 'number', 'object', 'string'

Arrays with type

Just add [] after the type

'array[]', 'boolean[]', 'function[]', 'number[]', 'object[]', 'string[]'

Releasing

npm run build
git add dist/
git commit -m "Updated dist files"
npm version [<newversion> | major | minor | patch]
git push --follow-tags origin master
npm publish