doc: add docs for AssertionError

Fixes: #12274 PR-URL: #14261 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Khaidi Chu <[email protected]>
nodejs · Aug 10, 2017 · d3b0722 · d3b0722
1 parent c94f346
commit d3b0722
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/doc/api/errors.md b/doc/api/errors.md
@@ -358,6 +358,18 @@ loop tick.
 System-level errors are generated as augmented `Error` instances, which are
 detailed [here](#errors_system_errors).
 
+## Class: AssertionError
+
+A subclass of `Error` that indicates the failure of an assertion. Such errors
+commonly indicate inequality of actual and expected value.
+
+For example:
+
+```js
+assert.strictEqual(1, 2);
+// AssertionError [ERR_ASSERTION]: 1 === 2
+```
+
 ## Class: RangeError
 
 A subclass of `Error` that indicates that a provided argument was not within the