2020-02-10 12:50:13 -07:00

45 lines
1.0 KiB
Markdown

# `nanoassert`
[![Build Status](https://travis-ci.org/emilbayes/nanoassert.svg?branch=master)](https://travis-ci.org/emilbayes/nanoassert)
> Nanoscale assertion module
## Usage
```js
var assert = require('nanoassert')
assert(a !== b, `${a} !== ${b}`)
```
## API
### `assert(declaration, [message])`
Assert that `declaration` is truthy otherwise throw `AssertionError` with
optional `message`. In Javascript runtimes that use v8, you will get a nicer
stack trace with this error.
If you want friendlier messages you can use template strings to show the
assertion made like in the example above.
## Why
I like to write public facing code very defensively, but have reservations about
the size incurred by the `assert` module. I only use the top-level `assert`
method anyway.
## `nanoassert@^1.1.0`
Docs for the previous version, which is used by many modules on npm, can be
[found here](https://github.com/emilbayes/nanoassert/tree/v1.1.0)
## Install
```sh
npm install nanoassert
```
## License
[ISC](LICENSE)