Skip to content

Commit

Permalink
Update assert.markdown
Browse files Browse the repository at this point in the history
The current wording "This module is used for writing unit tests for your applications, you can access it with require('assert')." implies that this module should only be used in development while unit testing.

The article "Error Handling in Node.js" by Joyent (https://www.joyent.com/developers/node/design/errors) uses the assert module in an efficient way to validate required function arguments.

PR-URL: nodejs/node-v0.x-archive#25811
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
daveboivin authored and jasnell committed Aug 13, 2015
1 parent 89b22cc commit d384bf8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/assert.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Stability: 5 - Locked

This module is used for writing unit tests for your applications, you can
This module is used for testing actual values against expected values, you can
access it with `require('assert')`.

## assert.fail(actual, expected, message, operator)
Expand Down

0 comments on commit d384bf8

Please sign in to comment.