nanocustomassert

nanocustomassert

assert your code + throw custom errors =

Install

npm i nanocustomassert

Usage

const assert = require('nanocustomassert')

// simple assert => AssertionError
assert('a' === 'a', 'should be equal')

// or custom errors => MyError
class MyError extends Error {}
const key1 = 'a1'
const key2 = 'b2'
assert(key1 === key2, MyError)

// or nanoerrors!!!
const nanoerror = require('nanoerror')
const CoolError = nanoerror('COOL_ERR', '🤖COOL ERROR FOUND: %s')
assert(false, CoolError, "Oops 🙈")

API

const assert = require('nanocustomassert')

assert

assert(expresion: JS expresion, message: string || function constructor, ...params)

Evaluates the expresion, if falsy throws an AssertionError or a custom error. See nanoerror.

• expression: the expresion to assert
• message: can be a string used as a message for the AssertionError or a function constructor. This is useful to throw a custom error. Optional
• params: these params are applied to the custom constructor function. Optional

Inspiration

This module is heavily inspired by nanoassert from Emil Bayes.

Issues

If you found an issue we encourage you to report it on github. Please specify your OS and the actions to reproduce it.

Contributing

Ideas and contributions to the project are welcome. You must follow this guideline.

License

MIT A GEUT project