better-assert

Better c-style assertions for self-documenting failure messages.

Note: This forked version adds support for simple error messages.

Installation

$ npm install git://github.com/tobius/better-assert.git

Example

By default assertions are enabled, however the NO_ASSERT environment variable will deactivate them when truthy.

1var assert = require('better-assert');
2
3test();
4
5function test() {
6  var user = { name: 'toby' };
7  assert('toby' == user.name);
8  assert('number' == typeof user.age, 'user age must be a number');
9}
10
11AssertionError: ('number' == typeof user.age) user age must be a number
12    at test (/Users/tj/projects/better-assert/example.js:9:3)
13    at Object.<anonymous> (/Users/tj/projects/better-assert/example.js:4:1)
14    at Module._compile (module.js:449:26)
15    at Object.Module._extensions..js (module.js:467:10)
16    at Module.load (module.js:356:32)
17    at Function.Module._load (module.js:312:12)
18    at Module.runMain (module.js:492:10)
19    at process.startup.processNextTick.process._tickCallback (node.js:244:9)

Browser support

See this fork for use in the browser: https://github.com/devinrhode2/better-assert-browser

License

(The MIT License)

Copyright (c) 2012 TJ Holowaychuk <tj@vision-media.ca>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.