Return a stringified version of the value with indentation and colors where applicable
(Any)
The value to inspect
([Object]
(default {}
)
)
The options to pass to util.inspect
string
:
The inspected string of the value
Return a highlighted comparison between the new data and the old data
string
:
The highlighted comparison
Return a highlighted comparison between the new data and the old data
string
:
The highlighted comparison
Log the inspected values of each of the arguments to stdout
(...Any)
The arguments to inspect and log
void
:
Same as assert.equal in that it performs a strict equals check, but if a failure occurs it will output detailed information
(Any)
The result data
(Any)
The anticipated data
([string]
(default 'equal comparison'
)
)
The name of the test
([Function])
An optional completion callback to pass the error to rather than throwing
void
:
Same as assert.deepEQual in that it performs a deep equals check, but if a failure occurs it will output detailed information
(Any)
The result data
(Any)
The anticipated data
([string]
(default 'deep equal assertion'
)
)
The name of the test
([Function])
An optional completion callback to pass the error to rather than throwing
void
:
Checks to see if the actual result contains the expected result
(Any)
The result data
(Any)
The anticipated data
([string]
(default 'contains assertion'
)
)
The name of the test
([Function])
An optional completion callback to pass the error to rather than throwing
void
:
Checks to see if an error was as expected, if a failure occurs it will output detailed information
(Error)
The result error
([string]
(default 'error equal assertion'
)
)
The name of the test
([Function])
An optional completion callback to pass the error to rather than throwing
void
:
Generate a callback that will return the specified result
(Any)
The result that the callback should return
Function
:
The callback that will return the specified result
Generate a callback that will receive a completion callback and call it with the specified result after the specified delay
(Any)
The result that the callback should pass to the completion callback
([Number]
(default 100
)
)
The delay in milliseconds that we should wait before calling the completion callback
Function
:
The callback that will provide the specified result
Generate a callback that return an error instance with the specified message/error
Function
:
The callback that will return the specified result
Generate a callback that throw an error instance with the specified message/error
Function
:
The callback that will throw the specified error
Generate a callback that will check the arguments it received with the arguments specified, if a failure occurs it will output detailed information
(...Any)
The arguments that we expect the callback to receive when it is called
Function
:
The callback that will check the arguments it receives for the expected arguments
Generate a callback that will check the error (if any) it receives for the expected error (if any), if a failure occurs it will output detailed information
(Any)
The error instance or message string that we expected, passed as the second argument to
errorEqual
([string]
(default 'expect error via callback assertion'
)
)
The name of the test
([Function])
An optional completion callback to call with the result of the compairson, if not specified and a failure occurs, the error will be thrown
Function
:
The callback that will check the error (if any) it receives for the expected error (if any)
Expect the passed function to throw an error at some point
(Any)
The error instance or message string that we expected, passed as the second argument to
errorEqual
(Function)
The function that we will call and expect to throw or emit the passed error
([string]
(default 'expect error via function assertion'
)
)
The name of the test
([Function])
An optional completion callback to call with the result of the compairson, if not specified and a failure occurs, the error will be thrown
void
: