https://github.com/tj/better-assert

c-style assert() for nodejs, reporting the expression string as the error message
https://github.com/tj/better-assert

Last synced: 28 days ago
JSON representation

c-style assert() for nodejs, reporting the expression string as the error message

• Host: GitHub
• URL: https://github.com/tj/better-assert
• Owner: tj
• License: mit
• Created: 2011-11-30T03:00:18.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2018-12-11T21:13:28.000Z (about 6 years ago)
• Last Synced: 2024-11-07T07:24:14.640Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 10.7 KB
• Stars: 288
• Watchers: 9
• Forks: 24
• Open Issues: 8
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - better-assert - C-style assert() for nodejs, reporting the expression string as the error message.  (Repository / Testing)
• awesome-node-modules - better-assert - C-style assert() for nodejs, reporting the expression string as the error message. (Uncategorized / Uncategorized)

README

        

# better-assert

  Better c-style assertions using [callsite](https://github.com/visionmedia/callsite) for

  self-documenting failure messages.

## Installation

    $ npm install better-assert

## Example

 By default assertions are enabled, however the __NO_ASSERT__ environment variable 

 will deactivate them when truthy.

```js

var assert = require('better-assert');

test();

function test() {

  var user = { name: 'tobi' };

  assert('tobi' == user.name);

  assert('number' == typeof user.age);

}

AssertionError: 'number' == typeof user.age

    at test (/Users/tj/projects/better-assert/example.js:9:3)

    at Object. (/Users/tj/projects/better-assert/example.js:4:1)

    at Module._compile (module.js:449:26)

    at Object.Module._extensions..js (module.js:467:10)

    at Module.load (module.js:356:32)

    at Function.Module._load (module.js:312:12)

    at Module.runMain (module.js:492:10)

    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 <[email protected]>

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.