aboutsummaryrefslogtreecommitdiffhomepage
path: root/node_modules/better-assert/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/better-assert/Readme.md')
-rw-r--r--node_modules/better-assert/Readme.md61
1 files changed, 61 insertions, 0 deletions
diff --git a/node_modules/better-assert/Readme.md b/node_modules/better-assert/Readme.md
new file mode 100644
index 0000000..d8d3a63
--- /dev/null
+++ b/node_modules/better-assert/Readme.md
@@ -0,0 +1,61 @@
+
+# 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.<anonymous> (/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)
+```
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2012 TJ Holowaychuk &lt;tj@vision-media.ca&gt;
+
+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. \ No newline at end of file