From d8e69d31b398a22cae696182f837ad5ffec25efd Mon Sep 17 00:00:00 2001 From: Micheil Smith Date: Fri, 18 Dec 2009 16:17:10 +0100 Subject: [PATCH] Documentation for the assert module --- doc/api.txt | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/doc/api.txt b/doc/api.txt index c5a4d1d4710..84ee58c9b2d 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -1430,7 +1430,39 @@ Each DNS query can return an error code. - +dns.NOMEM+: out of memory while processing. - +dns.BADQUERY+: the query is malformed. +=== Assert Module +This module is used for writing unit tests for your applications, you can access it with +require("assert")+. + ++assert.fail(actual, expected, message, operator)+:: +Tests if +actual+ is equal to +expected+ using the operator provided. + ++assert.ok(value, message)+:: +Tests if value is a +true+ value, it is equivilant to +assert.equal(true, value, message);+ + ++assert.equal(actual, expected, message)+:: +Tests shallow, coercive equality with the equal comparison operator ( +==+ ). + ++assert.notEqual(actual, expected, message)+:: +Tests shallow, coercive non-equality with the not equal comparison operator ( +!=+ ). + ++assert.deepEqual(actual, expected, message)+:: +Tests for deep equality. + ++assert.notDeepEqual(actual, expected, message)+:: +Tests for any deep inequality. + ++assert.strictEqual(actual, expected, message)+:: +Tests strict equality, as determined by bitwise equality operator ( +===+ ) + ++assert.notStrictEqual(actual, expected, message)+:: +Tests strict non-equality, as determined by bitwise not equal operator ( +!==+ ) + ++assert.throws(block, error, message)+:: +Expects +block+ to throw an error. + ++assert.doesNotThrow(block, error, message)+:: +Expects +block+ not to throw an error. == REPL