workshopper-browser-guide

<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>Assert Node.js v0.10.35 Manual & Documentation</title> <link rel="stylesheet" href="assets/style.css"> <link rel="stylesheet" href="assets/sh.css"> <link rel="canonical" href="http://nodejs.org/api/assert.html"> <script type="text/javascript" src="//use.typekit.net/mse5tqx.js"></script> <script type="text/javascript">try{Typekit.load();}catch(e){}</script> </head> <body class="alt apidoc int docs" id="docs"> <div id="nav"> <img id="logo" src="assets/logo.svg" alt="node.js"> <ul> <li><a href="http://nodejs.org">Home</a></li> <li><a href="http://nodejs.org/download/">Downloads</a></li> <li class="active"><a href="http://nodejs.org/documentation/">Docs</a></li> <li><a href="http://nodejs.org/community/">Community</a></li> <li><a href="http://nodejs.org/about/">About</a></li> <li><a href="http://jobs.nodejs.org">Jobs</a></li> <li><a href="http://blog.nodejs.org">Blog</a></li> </ul> </div> <div id="content-wrap"> <div id="content" class="clearfix"> <div id="column2" class="interior">  <ul class="docs-nav"> <li><a href="http://nodejs.org/documentation/">About Docs</a></li> <li><a href="http://nodejs.org/documentation/tutorials/">Tutorials</a></li> <li><a href="http://nodejs.org/documentation/contributing/">Contributing</a></li> <li><a href="http://nodejs.org/documentation/localization/">Localization</a></li> <li class="active"><a href="http://nodejs.org/api/">API Docs</a></li> </ul> </div> <div id="column1" class="interior"> <header> <h1>Node.js v0.10.35 Manual & Documentation</h1> <div id="gtoc"> <p> <a href="index.html" name="toc">Index</a> | <a href="all.html">View on single page</a> | <a href="assert.json">View as JSON</a> </p> </div> <hr> </header> <div id="toc"> <h2>Table of Contents</h2> <ul> <li><a href="#assert_assert">Assert</a><ul> <li><a href="#assert_assert_fail_actual_expected_message_operator">assert.fail(actual, expected, message, operator)</a></li> <li><a href="#assert_assert_value_message_assert_ok_value_message">assert(value, message), assert.ok(value, [message])</a></li> <li><a href="#assert_assert_equal_actual_expected_message">assert.equal(actual, expected, [message])</a></li> <li><a href="#assert_assert_notequal_actual_expected_message">assert.notEqual(actual, expected, [message])</a></li> <li><a href="#assert_assert_deepequal_actual_expected_message">assert.deepEqual(actual, expected, [message])</a></li> <li><a href="#assert_assert_notdeepequal_actual_expected_message">assert.notDeepEqual(actual, expected, [message])</a></li> <li><a href="#assert_assert_strictequal_actual_expected_message">assert.strictEqual(actual, expected, [message])</a></li> <li><a href="#assert_assert_notstrictequal_actual_expected_message">assert.notStrictEqual(actual, expected, [message])</a></li> <li><a href="#assert_assert_throws_block_error_message">assert.throws(block, [error], [message])</a></li> <li><a href="#assert_assert_doesnotthrow_block_message">assert.doesNotThrow(block, [message])</a></li> <li><a href="#assert_assert_iferror_value">assert.ifError(value)</a></li> </ul> </li> </ul> </div> <div id="apicontent"> <h1>Assert<span><a class="mark" href="#assert_assert" id="assert_assert">#</a></span></h1> <pre class="api_stability_5">Stability: 5 - Locked</pre><p>This module is used for writing unit tests for your applications, you can access it with <code>require('assert')</code>. </p> <h2>assert.fail(actual, expected, message, operator)<span><a class="mark" href="#assert_assert_fail_actual_expected_message_operator" id="assert_assert_fail_actual_expected_message_operator">#</a></span></h2> <p>Throws an exception that displays the values for <code>actual</code> and <code>expected</code> separated by the provided operator. </p> <h2>assert(value, message), assert.ok(value, [message])<span><a class="mark" href="#assert_assert_value_message_assert_ok_value_message" id="assert_assert_value_message_assert_ok_value_message">#</a></span></h2> <p>Tests if value is truthy, it is equivalent to <code>assert.equal(true, !!value, message);</code> </p> <h2>assert.equal(actual, expected, [message])<span><a class="mark" href="#assert_assert_equal_actual_expected_message" id="assert_assert_equal_actual_expected_message">#</a></span></h2> <p>Tests shallow, coercive equality with the equal comparison operator ( <code>==</code> ). </p> <h2>assert.notEqual(actual, expected, [message])<span><a class="mark" href="#assert_assert_notequal_actual_expected_message" id="assert_assert_notequal_actual_expected_message">#</a></span></h2> <p>Tests shallow, coercive non-equality with the not equal comparison operator ( <code>!=</code> ). </p> <h2>assert.deepEqual(actual, expected, [message])<span><a class="mark" href="#assert_assert_deepequal_actual_expected_message" id="assert_assert_deepequal_actual_expected_message">#</a></span></h2> <p>Tests for deep equality. </p> <h2>assert.notDeepEqual(actual, expected, [message])<span><a class="mark" href="#assert_assert_notdeepequal_actual_expected_message" id="assert_assert_notdeepequal_actual_expected_message">#</a></span></h2> <p>Tests for any deep inequality. </p> <h2>assert.strictEqual(actual, expected, [message])<span><a class="mark" href="#assert_assert_strictequal_actual_expected_message" id="assert_assert_strictequal_actual_expected_message">#</a></span></h2> <p>Tests strict equality, as determined by the strict equality operator ( <code>===</code> ) </p> <h2>assert.notStrictEqual(actual, expected, [message])<span><a class="mark" href="#assert_assert_notstrictequal_actual_expected_message" id="assert_assert_notstrictequal_actual_expected_message">#</a></span></h2> <p>Tests strict non-equality, as determined by the strict not equal operator ( <code>!==</code> ) </p> <h2>assert.throws(block, [error], [message])<span><a class="mark" href="#assert_assert_throws_block_error_message" id="assert_assert_throws_block_error_message">#</a></span></h2> <p>Expects <code>block</code> to throw an error. <code>error</code> can be constructor, <code>RegExp</code> or validation function. </p> <p>Validate instanceof using constructor: </p> <pre><code>assert.throws( function() { throw new Error("Wrong value"); }, Error );</code></pre> <p>Validate error message using RegExp: </p> <pre><code>assert.throws( function() { throw new Error("Wrong value"); }, /value/ );</code></pre> <p>Custom error validation: </p> <pre><code>assert.throws( function() { throw new Error("Wrong value"); }, function(err) { if ( (err instanceof Error) && /value/.test(err) ) { return true; } }, "unexpected error" );</code></pre> <h2>assert.doesNotThrow(block, [message])<span><a class="mark" href="#assert_assert_doesnotthrow_block_message" id="assert_assert_doesnotthrow_block_message">#</a></span></h2> <p>Expects <code>block</code> not to throw an error, see <code>assert.throws</code> for details. </p> <h2>assert.ifError(value)<span><a class="mark" href="#assert_assert_iferror_value" id="assert_assert_iferror_value">#</a></span></h2> <p>Tests if value is not a false value, throws if it is a true value. Useful when testing the first argument, <code>error</code> in callbacks. </p> </div> </div> </div> </div> <div id="footer"> <div class="foot-1"> <a href="http://www.joyent.com"><h5>The Node.js Project is Sponsored by</h5> <img src="assets/joyent-footer.svg" width="200"> <p class="tag">Production Node +<br>High Performance Infrastructure</p></a> <a href="https://my.joyent.com/landing/signup/701800000015696" class="button getstarted">Get Started</a> </div> <div class="foot-2"> <div class="foot-nav"> <ul> <li><a href="http://nodejs.org/download/">Downloads</a></li> </ul> <ul> <li><a href="http://nodejs.org/documentation/">Documentation</a></li> <li><a href="http://nodejs.org/api/">API Docs</a></li> <li><a href="http://nodejs.org/documentation/tutorials/">Tutorials</a></li> <li><a href="http://nodejs.org/documentation/localization/">Localization</a></li> </ul> <ul> <li><a href="http://nodejs.org/community/">Community</a></li> <li><a href="https://github.com/joyent/node/issues">Github Issues</a></li> <li><a href="http://groups.google.com/group/nodejs">Mailing List</a></li> <li><a href="http://webchat.freenode.net/?channels=node.js">IRC</a></li> <li><a href="https://twitter.com/nodejs">Twitter</a></li> </ul> <ul> <li><a href="http://nodejs.org/about/">About</a></li> <li><a href="http://nodejs.org/about/organization/">Organization</a></li> <li><a href="http://nodejs.org/about/core-team/">Core Team</a></li> <li><a href="http://nodejs.org/about/resources/">Resources</a></li> </ul> <ul> <li><a href="http://blog.nodejs.org">Blog</a></li> </ul> </div> <p class="copyright">Copyright 2014 <a href="http://joyent.com/">Joyent, Inc</a>, Node.js is a <a href="https://nodejs.org/images/trademark-policy.pdf">trademark</a> of Joyent, Inc. <a href="https://raw.github.com/joyent/node/v0.10.35/LICENSE">View license</a>.</p> </div> </div> <script src="/sh_main.js"></script> <script src="/sh_javascript.min.js"></script> <script>highlight(undefined, undefined, 'pre');</script> <script> window._gaq = [['_setAccount', 'UA-10874194-2'], ['_trackPageview']]; (function(d, t) { var g = d.createElement(t), s = d.getElementsByTagName(t)[0]; g.src = '//www.google-analytics.com/ga.js'; s.parentNode.insertBefore(g, s); }(document, 'script')); </script> </body> </html>