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

xarg

v1.0.11

Published

A small tool for validating arguments in JavaScript

Downloads

26

Readme

npm version CodeQL Build Status

xarg

A small tool for validating arguments in JavaScript

Install

npm install xarg --save

Usage

Every function will check if passed variable is defined and if it have a value of a specific type. This will throw an assertion error when values are not valid.

A list of available functions:

  • isArguments()
  • isArray()
  • isArrayBuffer()
  • isBoolean()
  • isBuffer()
  • isDate()
  • isDefined()
  • isEmpty()
  • isError()
  • isFinite()
  • isFunction()
  • isInteger()
  • isMap()
  • isNaN()
  • isNil()
  • isNull()
  • isNumber()
  • isObject()
  • isPlainObject()
  • isPromise()
  • isRegExp()
  • isSet()
  • isString()
  • isSymbol()
  • isTypedArray()
  • isWeakMap()
  • isWeakSet()

To test your arguments you need to pass an object with data. For example:

xarg.isArray({a: [], b:[1,2,3], c: {}})

Examples

Example #1

function hello(text, age) {
  xarg.isString({text});
  xarg.isNumber({age});
}
  
hello('John', 25); // OK
hello([]); // AssertionError [ERR_ASSERTION]: "text" should be of type String, but got: object
hello('John'); // AssertionError [ERR_ASSERTION]: "age" should be defined
hello('John', 'abc'); // AssertionError [ERR_ASSERTION]: "age" should be of type Number, but got: string

Example #2

class APIService {
  constructor(url) {
    xarg.isString({url});
  }

  post(json) {
    xarg.isObject({json});
  }
}

const service = new APIService('https://example.com');
service.post({ data: '123' }); // OK

new APIService([]); // AssertionError [ERR_ASSERTION]: "url" should be of type String, but got: object
new APIService({}); // AssertionError [ERR_ASSERTION]: "url" should be of type String, but got: object

const service = new APIService(123); // AssertionError [ERR_ASSERTION]: "age" should be of type Number, but got: string
service.post('123'); // AssertionError [ERR_ASSERTION]: "json" should be of type Object, but got: string

Tests

Run tests:

npm test

Run tests with code coverage:

npm run test-cov