aboutsummaryrefslogtreecommitdiff
path: root/node_modules/nanoassert/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/nanoassert/README.md')
-rw-r--r--node_modules/nanoassert/README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/node_modules/nanoassert/README.md b/node_modules/nanoassert/README.md
new file mode 100644
index 00000000..799060a5
--- /dev/null
+++ b/node_modules/nanoassert/README.md
@@ -0,0 +1,49 @@
+# `nanoassert`
+
+> Nanoscale assertion module
+
+## Usage
+
+```js
+var assert = require('nanoassert')
+
+assert(a !== b, `${a} !== ${b}`)
+```
+
+## API
+
+### `assert(declaration, [message])`
+### `assert.ok(declaration, [message])`
+
+Assert that `declaration` is truthy otherwise throw `Error` with
+optional `message`, which defaults to `AssertionError`.
+If you want friendlier messages you can use template strings to show the
+assertion made like in the example above.
+
+### `assert.notOk(declaration, [message])`
+
+Assert that `declaration` is not truthy.
+
+### `assert.equal(a, b, [message])`
+
+Assert that `a` is loosely equal to `b`. Uses `==` for the comparison.
+
+### `assert.notEqual(a, b, [message])`
+
+Assert that `a` is loosely not equal to `b`. Uses `==` for the comparison.
+
+## Why
+
+I like to write public facing code very defensively, but have complaints about
+the size incurred by the `assert` module. I only use the top-level `assert`
+method anyway, so this should make everyone happy :)
+
+## Install
+
+```sh
+npm install nanoassert
+```
+
+## License
+
+[ISC](LICENSE)