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

args-checker-js

v1.1.3

Published

a lightweight javascript function's arguments checker

Downloads

21

Readme

args-checker-js

Build Status npm version Downloads

a lightweight function's arguments checker in javascript.

Version

1.1.0

Installation

via npm

NPM

via bower

$ bower install args-checker-js

The Problem

We all know javascript doesn't support strict typing unlike other languages. So if a function, like the one shown below, expects it's arguments to be of certain types, we must implement type checking inside the function to make sure that the arguments are of valid types. This type checking can easily make our code too long. And imagine if the function expects too many arguments (although it's a bad practice)?

function run(stringOrNumber, anObject, aFunction) {
	if ((typeof stringOrNumber !== 'string') && (typeof stringOrNumber !== 'number')) {
		throw "Argument number 1 must be a string or a number!"
	}

	if (typeof anObject !== 'object') {
		throw "Argument number 2 must be an object!"
	}

	if (typeof aFunction !== 'function') {
		throw "Argument number 3 must be a function!"
	}
	
	// arguments are now valid. do something here..
}

it can get ugly, right?

The Solution

Args-checker-js is a tiny javascript object that's designed to fix this problem. This has solved mine, so i'm hoping it can solve yours.

Here's a sample snippet..

function run(stringOrNumber, anObject, aFunction) {
	
	// by default, if an argument is not of the right type, Exceptions will be thrown.
	args.expect(arguments, ['string|number', 'object', 'function']);
	
	// arguments are now valid. do something here..
}

Usage

<script src="args-checker/dist/args-checker.min.js"></script>

API

args.expect([function arguments], [expectations], callback)

  • function arguments - The arguments object is an Array-like object corresponding to the arguments passed to a function
  • expectations - An array of strings which corresponds the the expected arguments. Valid syntax for expectations are any the following: object, function, array, string, number, boolean and *. An argument may contain multiple expectations: args.expect(arguments, ['string|object|function|number']);. The * expectation means that an argument expects any data type, it can also be used if an argument may be optional.
  • callback - if callback function was specified, args-checker will no longer throw exceptions if an error was found. This function receives a single parameter: The results object which contains all the information regarding the arguments passed during runtime.

See Examples

Maintainers

License

(C) Karl Patrick Espiritu 2015, released under the MIT license