doc: add docs for AssertionError

Fixes: nodejs#12274
daxlab · Jul 16, 2017 · d4c6b23 · d4c6b23
1 parent 5d3609d
commit d4c6b23
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 parameters.
+
+For example:
+
+```js
+assert.equal(1, 2);
+// AssertionError [ERR_ASSERTION]: 1 == 2
+```
+
 ## Class: RangeError
 
 A subclass of `Error` that indicates that a provided argument was not within the