chai 5.1.0 → 5.1.2

package/lib/chai/interface/assert.js

@@ -17,13 +17,13 @@ import {AssertionError} from 'assertion-error';
  *     assert('foo' !== 'bar', 'foo is not bar');
  *     assert(Array.isArray([]), 'empty arrays are arrays');
  *
- * @param {unknown} expression to test for truthiness
- * @param {String} message to display on error
+ * @param {unknown} express - expression to test for truthiness
+ * @param {string} errmsg - message to display on error
  * @name assert
  * @namespace Assert
  * @public
  */
-function assert(express, errmsg) {
+export function assert(express, errmsg) {
   var test = new Assertion(null, null, chai.assert, true);
   test.assert(
       express
@@ -32,8 +32,6 @@ function assert(express, errmsg) {
   );
 }
 
-export {assert};
-
 /**
  * ### .fail([message])
  * ### .fail(actual, expected, [message], [operator])
@@ -50,8 +48,8 @@ export {assert};
  * @name fail
  * @param {unknown} actual
  * @param {unknown} expected
- * @param {String} message
- * @param {String} operator
+ * @param {string} message
+ * @param {string} operator
  * @namespace Assert
  * @public
  */
@@ -81,8 +79,8 @@ assert.fail = function (actual, expected, message, operator) {
  *
  * @name isOk
  * @alias ok
- * @param {unknown} object to test
- * @param {String} message
+ * @param {unknown} val object to test
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -100,8 +98,8 @@ assert.isOk = function (val, msg) {
  *
  * @name isNotOk
  * @alias notOk
- * @param {unknown} object to test
- * @param {String} message
+ * @param {unknown} val object to test
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -117,9 +115,9 @@ assert.isNotOk = function (val, msg) {
  *     assert.equal(3, '3', '== coerces values to strings');
  *
  * @name equal
- * @param {unknown} actual
- * @param {unknown} expected
- * @param {String} message
+ * @param {unknown} act
+ * @param {unknown} exp
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -144,9 +142,9 @@ assert.equal = function (act, exp, msg) {
  *     assert.notEqual(3, 4, 'these numbers are not equal');
  *
  * @name notEqual
- * @param {unknown} actual
- * @param {unknown} expected
- * @param {String} message
+ * @param {unknown} act
+ * @param {unknown} exp
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -171,9 +169,9 @@ assert.notEqual = function (act, exp, msg) {
  *     assert.strictEqual(true, true, 'these booleans are strictly equal');
  *
  * @name strictEqual
- * @param {unknown} actual
- * @param {unknown} expected
- * @param {String} message
+ * @param {unknown} act
+ * @param {unknown} exp
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -189,9 +187,9 @@ assert.strictEqual = function (act, exp, msg) {
  *     assert.notStrictEqual(3, '3', 'no coercion for strict equality');
  *
  * @name notStrictEqual
- * @param {unknown} actual
- * @param {unknown} expected
- * @param {String} message
+ * @param {unknown} act
+ * @param {unknown} exp
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -207,9 +205,9 @@ assert.notStrictEqual = function (act, exp, msg) {
  *     assert.deepEqual({ tea: 'green' }, { tea: 'green' });
  *
  * @name deepEqual
- * @param {unknown} actual
- * @param {unknown} expected
- * @param {String} message
+ * @param {unknown} act
+ * @param {unknown} exp
+ * @param {string} msg
  * @alias deepStrictEqual
  * @namespace Assert
  * @public
@@ -226,9 +224,9 @@ assert.deepEqual = assert.deepStrictEqual = function (act, exp, msg) {
  *     assert.notDeepEqual({ tea: 'green' }, { tea: 'jasmine' });
  *
  * @name notDeepEqual
- * @param {unknown} actual
- * @param {unknown} expected
- * @param {String} message
+ * @param {unknown} act
+ * @param {unknown} exp
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -236,7 +234,7 @@ assert.notDeepEqual = function (act, exp, msg) {
   new Assertion(act, msg, assert.notDeepEqual, true).to.not.eql(exp);
 };
 
- /**
+/**
  * ### .isAbove(valueToCheck, valueToBeAbove, [message])
  *
  * Asserts `valueToCheck` is strictly greater than (>) `valueToBeAbove`.
@@ -244,9 +242,9 @@ assert.notDeepEqual = function (act, exp, msg) {
  *     assert.isAbove(5, 2, '5 is strictly greater than 2');
  *
  * @name isAbove
- * @param {unknown} valueToCheck
- * @param {unknown} valueToBeAbove
- * @param {String} message
+ * @param {unknown} val
+ * @param {unknown} abv
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -254,7 +252,7 @@ assert.isAbove = function (val, abv, msg) {
   new Assertion(val, msg, assert.isAbove, true).to.be.above(abv);
 };
 
- /**
+/**
  * ### .isAtLeast(valueToCheck, valueToBeAtLeast, [message])
  *
  * Asserts `valueToCheck` is greater than or equal to (>=) `valueToBeAtLeast`.
@@ -263,9 +261,9 @@ assert.isAbove = function (val, abv, msg) {
  *     assert.isAtLeast(3, 3, '3 is greater or equal to 3');
  *
  * @name isAtLeast
- * @param {unknown} valueToCheck
- * @param {unknown} valueToBeAtLeast
- * @param {String} message
+ * @param {unknown} val
+ * @param {unknown} atlst
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -273,7 +271,7 @@ assert.isAtLeast = function (val, atlst, msg) {
   new Assertion(val, msg, assert.isAtLeast, true).to.be.least(atlst);
 };
 
- /**
+/**
  * ### .isBelow(valueToCheck, valueToBeBelow, [message])
  *
  * Asserts `valueToCheck` is strictly less than (<) `valueToBeBelow`.
@@ -281,9 +279,9 @@ assert.isAtLeast = function (val, atlst, msg) {
  *     assert.isBelow(3, 6, '3 is strictly less than 6');
  *
  * @name isBelow
- * @param {unknown} valueToCheck
- * @param {unknown} valueToBeBelow
- * @param {String} message
+ * @param {unknown} val
+ * @param {unknown} blw
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -291,7 +289,7 @@ assert.isBelow = function (val, blw, msg) {
   new Assertion(val, msg, assert.isBelow, true).to.be.below(blw);
 };
 
- /**
+/**
  * ### .isAtMost(valueToCheck, valueToBeAtMost, [message])
  *
  * Asserts `valueToCheck` is less than or equal to (<=) `valueToBeAtMost`.
@@ -300,9 +298,9 @@ assert.isBelow = function (val, blw, msg) {
  *     assert.isAtMost(4, 4, '4 is less than or equal to 4');
  *
  * @name isAtMost
- * @param {unknown} valueToCheck
- * @param {unknown} valueToBeAtMost
- * @param {String} message
+ * @param {unknown} val
+ * @param {unknown} atmst
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -319,8 +317,8 @@ assert.isAtMost = function (val, atmst, msg) {
  *     assert.isTrue(teaServed, 'the tea has been served');
  *
  * @name isTrue
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -337,8 +335,8 @@ assert.isTrue = function (val, msg) {
  *     assert.isNotTrue(tea, 'great, time for tea!');
  *
  * @name isNotTrue
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -355,8 +353,8 @@ assert.isNotTrue = function (val, msg) {
  *     assert.isFalse(teaServed, 'no tea yet? hmm...');
  *
  * @name isFalse
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -373,8 +371,8 @@ assert.isFalse = function (val, msg) {
  *     assert.isNotFalse(tea, 'great, time for tea!');
  *
  * @name isNotFalse
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -390,8 +388,8 @@ assert.isNotFalse = function (val, msg) {
  *     assert.isNull(err, 'there was no error');
  *
  * @name isNull
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -408,8 +406,8 @@ assert.isNull = function (val, msg) {
  *     assert.isNotNull(tea, 'great, time for tea!');
  *
  * @name isNotNull
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -425,8 +423,8 @@ assert.isNotNull = function (val, msg) {
  *     assert.isNaN(NaN, 'NaN is NaN');
  *
  * @name isNaN
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -443,11 +441,12 @@ assert.isNaN = function (val, msg) {
  *
  * @name isNotNaN
  * @param {unknown} value
- * @param {String} message
+ * @param {string} message
  * @namespace Assert
  * @public
- */assert.isNotNaN = function (val, msg) {
-  new Assertion(val, msg, assert.isNotNaN, true).not.to.be.NaN;
+ */
+assert.isNotNaN = function (value, message) {
+  new Assertion(value, message, assert.isNotNaN, true).not.to.be.NaN;
 };
 
 /**
@@ -456,12 +455,11 @@ assert.isNaN = function (val, msg) {
  * Asserts that the target is neither `null` nor `undefined`.
  *
  *     var foo = 'hi';
- *
  *     assert.exists(foo, 'foo is neither `null` nor `undefined`');
  *
  * @name exists
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -475,14 +473,14 @@ assert.exists = function (val, msg) {
  * Asserts that the target is either `null` or `undefined`.
  *
  *     var bar = null
- *       , baz;
+ *     , baz;
  *
  *     assert.notExists(bar);
  *     assert.notExists(baz, 'baz is either null or undefined');
  *
  * @name notExists
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -499,8 +497,8 @@ assert.notExists = function (val, msg) {
  *     assert.isUndefined(tea, 'no tea defined');
  *
  * @name isUndefined
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -517,8 +515,8 @@ assert.isUndefined = function (val, msg) {
  *     assert.isDefined(tea, 'tea has been defined');
  *
  * @name isDefined
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -536,11 +534,12 @@ assert.isDefined = function (val, msg) {
  *
  * @name isCallable
  * @param {unknown} value
- * @param {String} message
+ * @param {string} message
  * @namespace Assert
  * @public
- */assert.isCallable = function (val, msg) {
-  new Assertion(val, msg, assert.isCallable, true).is.callable;
+ */
+assert.isCallable = function (value, message) {
+  new Assertion(value, message, assert.isCallable, true).is.callable;
 }
 
 /**
@@ -553,11 +552,12 @@ assert.isDefined = function (val, msg) {
  *
  * @name isNotCallable
  * @param {unknown} value
- * @param {String} message
+ * @param {string} message
  * @namespace Assert
  * @public
- */assert.isNotCallable = function (val, msg) {
-  new Assertion(val, msg, assert.isNotCallable, true).is.not.callable;
+ */
+assert.isNotCallable = function (value, message) {
+  new Assertion(value, message, assert.isNotCallable, true).is.not.callable;
 };
 
 /**
@@ -570,8 +570,8 @@ assert.isDefined = function (val, msg) {
  *     assert.isObject(selection, 'tea selection is an object');
  *
  * @name isObject
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -589,8 +589,8 @@ assert.isObject = function (val, msg) {
  *     assert.isNotObject(null, 'null is not an object');
  *
  * @name isNotObject
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -607,8 +607,8 @@ assert.isNotObject = function (val, msg) {
  *     assert.isArray(menu, 'what kind of tea do we want?');
  *
  * @name isArray
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -625,8 +625,8 @@ assert.isArray = function (val, msg) {
  *     assert.isNotArray(menu, 'what kind of tea do we want?');
  *
  * @name isNotArray
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -643,8 +643,8 @@ assert.isNotArray = function (val, msg) {
  *     assert.isString(teaOrder, 'order placed');
  *
  * @name isString
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -661,8 +661,8 @@ assert.isString = function (val, msg) {
  *     assert.isNotString(teaOrder, 'order placed');
  *
  * @name isNotString
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -679,8 +679,8 @@ assert.isNotString = function (val, msg) {
  *     assert.isNumber(cups, 'how many cups');
  *
  * @name isNumber
- * @param {Number} value
- * @param {String} message
+ * @param {number} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -697,8 +697,8 @@ assert.isNumber = function (val, msg) {
  *     assert.isNotNumber(cups, 'how many cups');
  *
  * @name isNotNumber
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -706,22 +706,60 @@ assert.isNotNumber = function (val, msg) {
   new Assertion(val, msg, assert.isNotNumber, true).to.not.be.a('number');
 };
 
- /**
- * ### .isFinite(value, [message])
+/**
+ * ### .isNumeric(value, [message])
  *
- * Asserts that `value` is a finite number. Unlike `.isNumber`, this will fail for `NaN` and `Infinity`.
+ * Asserts that `value` is a number or BigInt.
  *
  *     var cups = 2;
- *     assert.isFinite(cups, 'how many cups');
+ *     assert.isNumeric(cups, 'how many cups');
+ * 
+ *     var cups = 10n;
+ *     assert.isNumeric(cups, 'how many cups');
+ *
+ * @name isNumeric
+ * @param {unknown} val
+ * @param {string} msg
+ * @namespace Assert
+ * @public
+ */
+assert.isNumeric = function (val, msg) {
+  new Assertion(val, msg, assert.isNumeric, true).is.numeric;
+};
+
+/**
+ * ### .isNotNumeric(value, [message])
  *
- *     assert.isFinite(NaN); // throws
+ * Asserts that `value` is _not_ a number or BigInt.
  *
- * @name isFinite
- * @param {Number} value
- * @param {String} message
+ *     var cups = '2 cups please';
+ *     assert.isNotNumeric(cups, 'how many cups');
+ *
+ * @name isNotNumeric
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
+assert.isNotNumeric = function (val, msg) {
+  new Assertion(val, msg, assert.isNotNumeric, true).is.not.numeric;
+};
+
+ /**
+  * ### .isFinite(value, [message])
+  *
+  * Asserts that `value` is a finite number. Unlike `.isNumber`, this will fail for `NaN` and `Infinity`.
+  *
+  *     var cups = 2;
+  *     assert.isFinite(cups, 'how many cups');
+  *     assert.isFinite(NaN); // throws
+  *
+  * @name isFinite
+  * @param {number} val
+  * @param {string} msg
+  * @namespace Assert
+  * @public
+  */
 assert.isFinite = function (val, msg) {
   new Assertion(val, msg, assert.isFinite, true).to.be.finite;
 };
@@ -732,14 +770,14 @@ assert.isFinite = function (val, msg) {
  * Asserts that `value` is a boolean.
  *
  *     var teaReady = true
- *       , teaServed = false;
+ *     , teaServed = false;
  *
  *     assert.isBoolean(teaReady, 'is the tea ready');
  *     assert.isBoolean(teaServed, 'has tea been served');
  *
  * @name isBoolean
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -753,14 +791,14 @@ assert.isBoolean = function (val, msg) {
  * Asserts that `value` is _not_ a boolean.
  *
  *     var teaReady = 'yep'
- *       , teaServed = 'nope';
+ *     , teaServed = 'nope';
  *
  *     assert.isNotBoolean(teaReady, 'is the tea ready');
  *     assert.isNotBoolean(teaServed, 'has tea been served');
  *
  * @name isNotBoolean
- * @param {unknown} value
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -782,9 +820,9 @@ assert.isNotBoolean = function (val, msg) {
  *     assert.typeOf(undefined, 'undefined', 'we have an undefined');
  *
  * @name typeOf
- * @param {unknown} value
- * @param {String} name
- * @param {String} message
+ * @param {unknown} val
+ * @param {string} type
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -802,13 +840,13 @@ assert.typeOf = function (val, type, msg) {
  *
  * @name notTypeOf
  * @param {unknown} value
- * @param {String} typeof name
- * @param {String} message
+ * @param {string} type
+ * @param {string} message
  * @namespace Assert
  * @public
  */
-assert.notTypeOf = function (val, type, msg) {
-  new Assertion(val, msg, assert.notTypeOf, true).to.not.be.a(type);
+assert.notTypeOf = function (value, type, message) {
+  new Assertion(value, message, assert.notTypeOf, true).to.not.be.a(type);
 };
 
 /**
@@ -817,14 +855,14 @@ assert.notTypeOf = function (val, type, msg) {
  * Asserts that `value` is an instance of `constructor`.
  *
  *     var Tea = function (name) { this.name = name; }
- *       , chai = new Tea('chai');
+ *     , chai = new Tea('chai');
  *
  *     assert.instanceOf(chai, Tea, 'chai is an instance of tea');
  *
  * @name instanceOf
- * @param {Object} object
- * @param {Constructor} constructor
- * @param {String} message
+ * @param {object} val
+ * @param {object} type
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -838,14 +876,14 @@ assert.instanceOf = function (val, type, msg) {
  * Asserts `value` is not an instance of `constructor`.
  *
  *     var Tea = function (name) { this.name = name; }
- *       , chai = new String('chai');
+ *     , chai = new String('chai');
  *
  *     assert.notInstanceOf(chai, Tea, 'chai is not an instance of tea');
  *
  * @name notInstanceOf
- * @param {Object} object
- * @param {Constructor} constructor
- * @param {String} message
+ * @param {object} val
+ * @param {object} type
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -872,15 +910,15 @@ assert.notInstanceOf = function (val, type, msg) {
  * and strictly equal to the given property value. For instance:
  *
  *     var obj1 = {a: 1}
- *       , obj2 = {b: 2};
+ *     , obj2 = {b: 2};
  *     assert.include([obj1, obj2], obj1);
  *     assert.include({foo: obj1, bar: obj2}, {foo: obj1});
  *     assert.include({foo: obj1, bar: obj2}, {foo: obj1, bar: obj2});
  *
  * @name include
- * @param {Array|String} haystack
- * @param {unknown} needle
- * @param {String} message
+ * @param {Array | string} exp
+ * @param {unknown} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -907,15 +945,15 @@ assert.include = function (exp, inc, msg) {
  * property value. For instance:
  *
  *     var obj1 = {a: 1}
- *       , obj2 = {b: 2};
+ *     , obj2 = {b: 2};
  *     assert.notInclude([obj1, obj2], {a: 1});
  *     assert.notInclude({foo: obj1, bar: obj2}, {foo: {a: 1}});
  *     assert.notInclude({foo: obj1, bar: obj2}, {foo: obj1, bar: {b: 2}});
  *
  * @name notInclude
- * @param {Array|String} haystack
- * @param {unknown} needle
- * @param {String} message
+ * @param {Array | string} exp
+ * @param {unknown} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -931,15 +969,15 @@ assert.notInclude = function (exp, inc, msg) {
  * Deep equality is used.
  *
  *     var obj1 = {a: 1}
- *       , obj2 = {b: 2};
+ *     , obj2 = {b: 2};
  *     assert.deepInclude([obj1, obj2], {a: 1});
  *     assert.deepInclude({foo: obj1, bar: obj2}, {foo: {a: 1}});
  *     assert.deepInclude({foo: obj1, bar: obj2}, {foo: {a: 1}, bar: {b: 2}});
  *
  * @name deepInclude
- * @param {Array|String} haystack
- * @param {unknown} needle
- * @param {String} message
+ * @param {Array | string} exp
+ * @param {unknown} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -955,15 +993,15 @@ assert.deepInclude = function (exp, inc, msg) {
  * Deep equality is used.
  *
  *     var obj1 = {a: 1}
- *       , obj2 = {b: 2};
+ *     , obj2 = {b: 2};
  *     assert.notDeepInclude([obj1, obj2], {a: 9});
  *     assert.notDeepInclude({foo: obj1, bar: obj2}, {foo: {a: 9}});
  *     assert.notDeepInclude({foo: obj1, bar: obj2}, {foo: {a: 1}, bar: {b: 9}});
  *
  * @name notDeepInclude
- * @param {Array|String} haystack
- * @param {unknown} needle
- * @param {String} message
+ * @param {Array | string} exp
+ * @param {unknown} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -985,9 +1023,9 @@ assert.notDeepInclude = function (exp, inc, msg) {
  *     assert.nestedInclude({'a': {'[b]': 'x'}}, {'a.\\[b\\]': 'x'});
  *
  * @name nestedInclude
- * @param {Object} haystack
- * @param {Object} needle
- * @param {String} message
+ * @param {object} exp
+ * @param {object} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1009,9 +1047,9 @@ assert.nestedInclude = function (exp, inc, msg) {
  *     assert.notNestedInclude({'a': {'[b]': 'x'}}, {'a.\\[b\\]': 'y'});
  *
  * @name notNestedInclude
- * @param {Object} haystack
- * @param {Object} needle
- * @param {String} message
+ * @param {object} exp
+ * @param {object} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1034,9 +1072,9 @@ assert.notNestedInclude = function (exp, inc, msg) {
  *     assert.deepNestedInclude({'.a': {'[b]': {x: 1}}}, {'\\.a.\\[b\\]': {x: 1}});
  *
  * @name deepNestedInclude
- * @param {Object} haystack
- * @param {Object} needle
- * @param {String} message
+ * @param {object} exp
+ * @param {object} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1059,9 +1097,9 @@ assert.deepNestedInclude = function(exp, inc, msg) {
  *     assert.notDeepNestedInclude({'.a': {'[b]': {x: 1}}}, {'\\.a.\\[b\\]': {y: 2}});
  *
  * @name notDeepNestedInclude
- * @param {Object} haystack
- * @param {Object} needle
- * @param {String} message
+ * @param {object} exp
+ * @param {object} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1080,9 +1118,9 @@ assert.notDeepNestedInclude = function(exp, inc, msg) {
  *     assert.ownInclude({ a: 1 }, { a: 1 });
  *
  * @name ownInclude
- * @param {Object} haystack
- * @param {Object} needle
- * @param {String} message
+ * @param {object} exp
+ * @param {object} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1098,13 +1136,12 @@ assert.ownInclude = function(exp, inc, msg) {
  * object while ignoring inherited properties.
  *
  *     Object.prototype.b = 2;
- *
  *     assert.notOwnInclude({ a: 1 }, { b: 2 });
  *
  * @name notOwnInclude
- * @param {Object} haystack
- * @param {Object} needle
- * @param {String} message
+ * @param {object} exp
+ * @param {object} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1119,12 +1156,12 @@ assert.notOwnInclude = function(exp, inc, msg) {
  * Can be used to assert the inclusion of a subset of properties in an
  * object while ignoring inherited properties and checking for deep equality.
  *
- *      assert.deepOwnInclude({a: {b: 2}}, {a: {b: 2}});
+ *     assert.deepOwnInclude({a: {b: 2}}, {a: {b: 2}});
  *
  * @name deepOwnInclude
- * @param {Object} haystack
- * @param {Object} needle
- * @param {String} message
+ * @param {object} exp
+ * @param {object} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1133,19 +1170,19 @@ assert.deepOwnInclude = function(exp, inc, msg) {
     .deep.own.include(inc);
 };
 
- /**
+/**
  * ### .notDeepOwnInclude(haystack, needle, [message])
  *
- * Asserts that 'haystack' does not include 'needle'.
+ * Asserts that 'haystack' includes 'needle'.
  * Can be used to assert the absence of a subset of properties in an
  * object while ignoring inherited properties and checking for deep equality.
  *
- *      assert.notDeepOwnInclude({a: {b: 2}}, {a: {c: 3}});
+ *     assert.notDeepOwnInclude({a: {b: 2}}, {a: {c: 3}});
  *
  * @name notDeepOwnInclude
- * @param {Object} haystack
- * @param {Object} needle
- * @param {String} message
+ * @param {object} exp
+ * @param {object} inc
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1162,9 +1199,9 @@ assert.notDeepOwnInclude = function(exp, inc, msg) {
  *     assert.match('foobar', /^foo/, 'regexp matches');
  *
  * @name match
- * @param {unknown} value
- * @param {RegExp} regexp
- * @param {String} message
+ * @param {unknown} exp
+ * @param {RegExp} re
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1180,9 +1217,9 @@ assert.match = function (exp, re, msg) {
  *     assert.notMatch('foobar', /^foo/, 'regexp does not match');
  *
  * @name notMatch
- * @param {unknown} value
- * @param {RegExp} regexp
- * @param {String} message
+ * @param {unknown} exp
+ * @param {RegExp} re
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1200,9 +1237,9 @@ assert.notMatch = function (exp, re, msg) {
  *     assert.property({ tea: { green: 'matcha' }}, 'toString');
  *
  * @name property
- * @param {Object} object
- * @param {String} property
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1219,9 +1256,9 @@ assert.property = function (obj, prop, msg) {
  *     assert.notProperty({ tea: { green: 'matcha' }}, 'coffee');
  *
  * @name notProperty
- * @param {Object} object
- * @param {String} property
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1240,10 +1277,10 @@ assert.notProperty = function (obj, prop, msg) {
  *     assert.propertyVal({ tea: 'is good' }, 'tea', 'is good');
  *
  * @name propertyVal
- * @param {Object} object
- * @param {String} property
- * @param {unknown} value
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1263,10 +1300,10 @@ assert.propertyVal = function (obj, prop, val, msg) {
  *     assert.notPropertyVal({ tea: 'is good' }, 'coffee', 'is good');
  *
  * @name notPropertyVal
- * @param {Object} object
- * @param {String} property
- * @param {unknown} value
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1284,10 +1321,10 @@ assert.notPropertyVal = function (obj, prop, val, msg) {
  *     assert.deepPropertyVal({ tea: { green: 'matcha' } }, 'tea', { green: 'matcha' });
  *
  * @name deepPropertyVal
- * @param {Object} object
- * @param {String} property
- * @param {unknown} value
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1307,10 +1344,10 @@ assert.deepPropertyVal = function (obj, prop, val, msg) {
  *     assert.notDeepPropertyVal({ tea: { green: 'matcha' } }, 'coffee', { green: 'matcha' });
  *
  * @name notDeepPropertyVal
- * @param {Object} object
- * @param {String} property
- * @param {unknown} value
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1328,9 +1365,9 @@ assert.notDeepPropertyVal = function (obj, prop, val, msg) {
  *     assert.ownProperty({ tea: { green: 'matcha' }}, 'tea');
  *
  * @name ownProperty
- * @param {Object} object
- * @param {String} property
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {string} msg
  * @public
  */
 assert.ownProperty = function (obj, prop, msg) {
@@ -1348,9 +1385,9 @@ assert.ownProperty = function (obj, prop, msg) {
  *     assert.notOwnProperty({}, 'toString');
  *
  * @name notOwnProperty
- * @param {Object} object
- * @param {String} property
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {string} msg
  * @public
  */
 assert.notOwnProperty = function (obj, prop, msg) {
@@ -1368,10 +1405,10 @@ assert.notOwnProperty = function (obj, prop, msg) {
  *     assert.ownPropertyVal({ coffee: 'is good'}, 'coffee', 'is good');
  *
  * @name ownPropertyVal
- * @param {Object} object
- * @param {String} property
+ * @param {object} obj
+ * @param {string} prop
  * @param {unknown} value
- * @param {String} message
+ * @param {string} msg
  * @public
  */
 assert.ownPropertyVal = function (obj, prop, value, msg) {
@@ -1390,10 +1427,10 @@ assert.ownPropertyVal = function (obj, prop, value, msg) {
  *     assert.notOwnPropertyVal({}, 'toString', Object.prototype.toString);
  *
  * @name notOwnPropertyVal
- * @param {Object} object
- * @param {String} property
+ * @param {object} obj
+ * @param {string} prop
  * @param {unknown} value
- * @param {String} message
+ * @param {string} msg
  * @public
  */
 assert.notOwnPropertyVal = function (obj, prop, value, msg) {
@@ -1411,10 +1448,10 @@ assert.notOwnPropertyVal = function (obj, prop, value, msg) {
  *     assert.deepOwnPropertyVal({ tea: { green: 'matcha' } }, 'tea', { green: 'matcha' });
  *
  * @name deepOwnPropertyVal
- * @param {Object} object
- * @param {String} property
+ * @param {object} obj
+ * @param {string} prop
  * @param {unknown} value
- * @param {String} message
+ * @param {string} msg
  * @public
  */
 assert.deepOwnPropertyVal = function (obj, prop, value, msg) {
@@ -1435,10 +1472,10 @@ assert.deepOwnPropertyVal = function (obj, prop, value, msg) {
  *     assert.notDeepOwnPropertyVal({}, 'toString', Object.prototype.toString);
  *
  * @name notDeepOwnPropertyVal
- * @param {Object} object
- * @param {String} property
+ * @param {object} obj
+ * @param {string} prop
  * @param {unknown} value
- * @param {String} message
+ * @param {string} msg
  * @public
  */
 assert.notDeepOwnPropertyVal = function (obj, prop, value, msg) {
@@ -1456,9 +1493,9 @@ assert.notDeepOwnPropertyVal = function (obj, prop, value, msg) {
  *     assert.nestedProperty({ tea: { green: 'matcha' }}, 'tea.green');
  *
  * @name nestedProperty
- * @param {Object} object
- * @param {String} property
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1477,9 +1514,9 @@ assert.nestedProperty = function (obj, prop, msg) {
  *     assert.notNestedProperty({ tea: { green: 'matcha' }}, 'tea.oolong');
  *
  * @name notNestedProperty
- * @param {Object} object
- * @param {String} property
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1498,10 +1535,10 @@ assert.notNestedProperty = function (obj, prop, msg) {
  *     assert.nestedPropertyVal({ tea: { green: 'matcha' }}, 'tea.green', 'matcha');
  *
  * @name nestedPropertyVal
- * @param {Object} object
- * @param {String} property
- * @param {unknown} value
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1521,10 +1558,10 @@ assert.nestedPropertyVal = function (obj, prop, val, msg) {
  *     assert.notNestedPropertyVal({ tea: { green: 'matcha' }}, 'coffee.green', 'matcha');
  *
  * @name notNestedPropertyVal
- * @param {Object} object
- * @param {String} property
- * @param {unknown} value
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1543,10 +1580,10 @@ assert.notNestedPropertyVal = function (obj, prop, val, msg) {
  *     assert.deepNestedPropertyVal({ tea: { green: { matcha: 'yum' } } }, 'tea.green', { matcha: 'yum' });
  *
  * @name deepNestedPropertyVal
- * @param {Object} object
- * @param {String} property
- * @param {unknown} value
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1567,10 +1604,10 @@ assert.deepNestedPropertyVal = function (obj, prop, val, msg) {
  *     assert.notDeepNestedPropertyVal({ tea: { green: { matcha: 'yum' } } }, 'tea.black', { matcha: 'yum' });
  *
  * @name notDeepNestedPropertyVal
- * @param {Object} object
- * @param {String} property
- * @param {unknown} value
- * @param {String} message
+ * @param {object} obj
+ * @param {string} prop
+ * @param {unknown} val
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1590,9 +1627,9 @@ assert.notDeepNestedPropertyVal = function (obj, prop, val, msg) {
  *     assert.lengthOf(new Map([['a',1],['b',2],['c',3]]), 3, 'map has size of 3');
  *
  * @name lengthOf
- * @param {unknown} object
- * @param {Number} length
- * @param {String} message
+ * @param {unknown} exp
+ * @param {number} len
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1613,9 +1650,9 @@ assert.lengthOf = function (exp, len, msg) {
  *     assert.hasAnyKeys(new Set([{foo: 'bar'}, 'anotherKey']), [{foo: 'bar'}, 'anotherKey']);
  *
  * @name hasAnyKeys
- * @param {unknown} object
- * @param {Array|Object} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {Array | object} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1636,9 +1673,9 @@ assert.hasAnyKeys = function (obj, keys, msg) {
  *     assert.hasAllKeys(new Set([{foo: 'bar'}, 'anotherKey']), [{foo: 'bar'}, 'anotherKey']);
  *
  * @name hasAllKeys
- * @param {unknown} object
- * @param {String[]} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {string[]} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1663,9 +1700,9 @@ assert.hasAllKeys = function (obj, keys, msg) {
  *     assert.containsAllKeys(new Set([{foo: 'bar'}, 'anotherKey']), [{foo: 'bar'}, 'anotherKey']);
  *
  * @name containsAllKeys
- * @param {unknown} object
- * @param {String[]} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {string[]} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1687,9 +1724,9 @@ assert.containsAllKeys = function (obj, keys, msg) {
  *     assert.doesNotHaveAnyKeys(new Set([{foo: 'bar'}, 'anotherKey']), [{one: 'two'}, 'example']);
  *
  * @name doesNotHaveAnyKeys
- * @param {unknown} object
- * @param {String[]} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {string[]} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1711,9 +1748,9 @@ assert.doesNotHaveAnyKeys = function (obj, keys, msg) {
  *     assert.doesNotHaveAllKeys(new Set([{foo: 'bar'}, 'anotherKey']), [{one: 'two'}, 'example']);
  *
  * @name doesNotHaveAllKeys
- * @param {unknown} object
- * @param {String[]} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {string[]} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1739,9 +1776,9 @@ assert.doesNotHaveAllKeys = function (obj, keys, msg) {
  *     assert.hasAnyDeepKeys(new Set([{one: 'one'}, {two: 'two'}]), [{one: 'one'}, {two: 'two'}]);
  *
  * @name hasAnyDeepKeys
- * @param {unknown} object
- * @param {Array|Object} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {Array | object} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1765,9 +1802,9 @@ assert.hasAnyDeepKeys = function (obj, keys, msg) {
  *     assert.hasAllDeepKeys(new Set([{one: 'one'}, {two: 'two'}]), [{one: 'one'}, {two: 'two'}]);
  *
  * @name hasAllDeepKeys
- * @param {unknown} object
- * @param {Array|Object} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {Array | object} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1791,9 +1828,9 @@ assert.hasAllDeepKeys = function (obj, keys, msg) {
  *     assert.containsAllDeepKeys(new Set([{one: 'one'}, {two: 'two'}]), [{one: 'one'}, {two: 'two'}]);
  *
  * @name containsAllDeepKeys
- * @param {unknown} object
- * @param {Array|Object} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {Array | object} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1817,9 +1854,9 @@ assert.containsAllDeepKeys = function (obj, keys, msg) {
  *     assert.doesNotHaveAnyDeepKeys(new Set([{one: 'one'}, {two: 'two'}]), [{twenty: 'twenty'}, {fifty: 'fifty'}]);
  *
  * @name doesNotHaveAnyDeepKeys
- * @param {unknown} object
- * @param {Array|Object} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {Array | object} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1843,9 +1880,9 @@ assert.doesNotHaveAnyDeepKeys = function (obj, keys, msg) {
  *     assert.doesNotHaveAllDeepKeys(new Set([{one: 'one'}, {two: 'two'}]), [{one: 'one'}, {fifty: 'fifty'}]);
  *
  * @name doesNotHaveAllDeepKeys
- * @param {unknown} object
- * @param {Array|Object} keys
- * @param {String} message
+ * @param {unknown} obj
+ * @param {Array | object} keys
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1877,9 +1914,10 @@ assert.doesNotHaveAllDeepKeys = function (obj, keys, msg) {
  * @alias throw
  * @alias Throw
  * @param {Function} fn
- * @param {ErrorConstructor|Error} errorLike
- * @param {RegExp|String} errMsgMatcher
- * @param {String} message
+ * @param {Error} errorLike
+ * @param {RegExp | string} errMsgMatcher
+ * @param {string} msg
+ * @returns {unknown}
  * @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
  * @namespace Assert
  * @public
@@ -1916,20 +1954,20 @@ assert.throws = function (fn, errorLike, errMsgMatcher, msg) {
  *
  * @name doesNotThrow
  * @param {Function} fn
- * @param {ErrorConstructor} errorLike
- * @param {RegExp|String} errMsgMatcher
- * @param {String} message
+ * @param {Error} errorLike
+ * @param {RegExp | string} errMsgMatcher
+ * @param {string} message
  * @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
  * @namespace Assert
  * @public
  */
-assert.doesNotThrow = function (fn, errorLike, errMsgMatcher, msg) {
+assert.doesNotThrow = function (fn, errorLike, errMsgMatcher, message) {
   if ('string' === typeof errorLike || errorLike instanceof RegExp) {
     errMsgMatcher = errorLike;
     errorLike = null;
   }
 
-  new Assertion(fn, msg, assert.doesNotThrow, true)
+  new Assertion(fn, message, assert.doesNotThrow, true)
     .to.not.throw(errorLike, errMsgMatcher);
 };
 
@@ -1942,10 +1980,10 @@ assert.doesNotThrow = function (fn, errorLike, errMsgMatcher, msg) {
  *     assert.operator(1, '>', 2, 'this will fail');
  *
  * @name operator
- * @param {unknown} val1
- * @param {String} operator
+ * @param {unknown} val
+ * @param {string} operator
  * @param {unknown} val2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -1999,10 +2037,10 @@ assert.operator = function (val, operator, val2, msg) {
  *     assert.closeTo(1.5, 1, 0.5, 'numbers are close');
  *
  * @name closeTo
- * @param {Number} actual
- * @param {Number} expected
- * @param {Number} delta
- * @param {String} message
+ * @param {number} act
+ * @param {number} exp
+ * @param {number} delta
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2018,10 +2056,10 @@ assert.closeTo = function (act, exp, delta, msg) {
  *     assert.approximately(1.5, 1, 0.5, 'numbers are close');
  *
  * @name approximately
- * @param {Number} actual
- * @param {Number} expected
- * @param {Number} delta
- * @param {String} message
+ * @param {number} act
+ * @param {number} exp
+ * @param {number} delta
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2041,7 +2079,7 @@ assert.approximately = function (act, exp, delta, msg) {
  * @name sameMembers
  * @param {Array} set1
  * @param {Array} set2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2061,7 +2099,7 @@ assert.sameMembers = function (set1, set2, msg) {
  * @name notSameMembers
  * @param {Array} set1
  * @param {Array} set2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2081,7 +2119,7 @@ assert.notSameMembers = function (set1, set2, msg) {
  * @name sameDeepMembers
  * @param {Array} set1
  * @param {Array} set2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2101,7 +2139,7 @@ assert.sameDeepMembers = function (set1, set2, msg) {
  * @name notSameDeepMembers
  * @param {Array} set1
  * @param {Array} set2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2121,7 +2159,7 @@ assert.notSameDeepMembers = function (set1, set2, msg) {
  * @name sameOrderedMembers
  * @param {Array} set1
  * @param {Array} set2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2141,7 +2179,7 @@ assert.sameOrderedMembers = function (set1, set2, msg) {
  * @name notSameOrderedMembers
  * @param {Array} set1
  * @param {Array} set2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2161,7 +2199,7 @@ assert.notSameOrderedMembers = function (set1, set2, msg) {
  * @name sameDeepOrderedMembers
  * @param {Array} set1
  * @param {Array} set2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2182,7 +2220,7 @@ assert.sameDeepOrderedMembers = function (set1, set2, msg) {
  * @name notSameDeepOrderedMembers
  * @param {Array} set1
  * @param {Array} set2
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2202,7 +2240,7 @@ assert.notSameDeepOrderedMembers = function (set1, set2, msg) {
  * @name includeMembers
  * @param {Array} superset
  * @param {Array} subset
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2222,7 +2260,7 @@ assert.includeMembers = function (superset, subset, msg) {
  * @name notIncludeMembers
  * @param {Array} superset
  * @param {Array} subset
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2242,7 +2280,7 @@ assert.notIncludeMembers = function (superset, subset, msg) {
  * @name includeDeepMembers
  * @param {Array} superset
  * @param {Array} subset
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2262,7 +2300,7 @@ assert.includeDeepMembers = function (superset, subset, msg) {
  * @name notIncludeDeepMembers
  * @param {Array} superset
  * @param {Array} subset
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2283,7 +2321,7 @@ assert.notIncludeDeepMembers = function (superset, subset, msg) {
  * @name includeOrderedMembers
  * @param {Array} superset
  * @param {Array} subset
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2305,7 +2343,7 @@ assert.includeOrderedMembers = function (superset, subset, msg) {
  * @name notIncludeOrderedMembers
  * @param {Array} superset
  * @param {Array} subset
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2326,7 +2364,7 @@ assert.notIncludeOrderedMembers = function (superset, subset, msg) {
  * @name includeDeepOrderedMembers
  * @param {Array} superset
  * @param {Array} subset
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2349,7 +2387,7 @@ assert.includeDeepOrderedMembers = function (superset, subset, msg) {
  * @name notIncludeDeepOrderedMembers
  * @param {Array} superset
  * @param {Array} subset
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2368,7 +2406,7 @@ assert.notIncludeDeepOrderedMembers = function (superset, subset, msg) {
  * @name oneOf
  * @param {*} inList
  * @param {Array<*>} list
- * @param {String} message
+ * @param {string} msg
  * @namespace Assert
  * @public
  */
@@ -2387,7 +2425,7 @@ assert.oneOf = function (inList, list, msg) {
  * @param {unknown} obj
  * @param {string} [msg]
  * @namespace Assert
- * @api public
+ * @public
  */
 assert.isIterable = function(obj, msg) {
   if (obj == undefined || !obj[Symbol.iterator]) {
@@ -2413,10 +2451,10 @@ assert.isIterable = function(obj, msg) {
  *     assert.changes(fn, obj, 'val');
  *
  * @name changes
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2429,7 +2467,7 @@ assert.changes = function (fn, obj, prop, msg) {
   new Assertion(fn, msg, assert.changes, true).to.change(obj, prop);
 }
 
- /**
+/**
  * ### .changesBy(function, object, property, delta, [message])
  *
  * Asserts that a function changes the value of a property by an amount (delta).
@@ -2439,11 +2477,11 @@ assert.changes = function (fn, obj, prop, msg) {
  *     assert.changesBy(fn, obj, 'val', 2);
  *
  * @name changesBy
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {Number} change amount (delta)
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @param {number} delta msg change amount (delta)
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2461,20 +2499,21 @@ assert.changesBy = function (fn, obj, prop, delta, msg) {
     .to.change(obj, prop).by(delta);
 }
 
- /**
+/**
  * ### .doesNotChange(function, object, property, [message])
  *
  * Asserts that a function does not change the value of a property.
  *
- *     var obj = { val: 10 };
- *     var fn = function() { console.log('foo'); };
- *     assert.doesNotChange(fn, obj, 'val');
+ *   var obj = { val: 10 };
+ *   var fn = function() { console.log('foo'); };
+ *   assert.doesNotChange(fn, obj, 'val');
  *
  * @name doesNotChange
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @param {string} msg _optional_
+ * @returns {unknown}
  * @namespace Assert
  * @public
  */
@@ -2498,11 +2537,11 @@ assert.doesNotChange = function (fn, obj, prop, msg) {
  *     assert.changesButNotBy(fn, obj, 'val', 5);
  *
  * @name changesButNotBy
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {Number} change amount (delta)
- * @param {String} message _optional_
+ * @param {Function} fn - modifier function
+ * @param {object} obj - object or getter function
+ * @param {string} prop - property name _optional_
+ * @param {number} delta - change amount (delta)
+ * @param {string} msg - message _optional_
  * @namespace Assert
  * @public
  */
@@ -2529,13 +2568,14 @@ assert.changesButNotBy = function (fn, obj, prop, delta, msg) {
  *     var fn = function() { obj.val = 13 };
  *     assert.increases(fn, obj, 'val');
  *
- * @name increases
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {String} message _optional_
- * @namespace Assert
  * @public
+ * @namespace Assert
+ * @name increases
+ * @param {Function} fn - modifier function
+ * @param {object} obj - object or getter function
+ * @param {string} prop - property name _optional_
+ * @param {string} msg - message _optional_
+ * @returns {unknown}
  */
 assert.increases = function (fn, obj, prop, msg) {
   if (arguments.length === 3 && typeof obj === 'function') {
@@ -2556,14 +2596,14 @@ assert.increases = function (fn, obj, prop, msg) {
  *     var fn = function() { obj.val += 10 };
  *     assert.increasesBy(fn, obj, 'val', 10);
  *
+ * @public
  * @name increasesBy
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {Number} change amount (delta)
- * @param {String} message _optional_
  * @namespace Assert
- * @public
+ * @param {Function} fn - modifier function
+ * @param {object} obj - object or getter function
+ * @param {string} prop - property name _optional_
+ * @param {number} delta - change amount (delta)
+ * @param {string} msg - message _optional_
  */
 assert.increasesBy = function (fn, obj, prop, delta, msg) {
   if (arguments.length === 4 && typeof obj === 'function') {
@@ -2589,10 +2629,11 @@ assert.increasesBy = function (fn, obj, prop, delta, msg) {
  *     assert.doesNotIncrease(fn, obj, 'val');
  *
  * @name doesNotIncrease
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @returns {Assertion}
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2616,11 +2657,11 @@ assert.doesNotIncrease = function (fn, obj, prop, msg) {
  *     assert.increasesButNotBy(fn, obj, 'val', 10);
  *
  * @name increasesButNotBy
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {Number} change amount (delta)
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @param {number} delta change amount (delta)
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2648,10 +2689,11 @@ assert.increasesButNotBy = function (fn, obj, prop, delta, msg) {
  *     assert.decreases(fn, obj, 'val');
  *
  * @name decreases
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @returns {Assertion}
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2675,11 +2717,11 @@ assert.decreases = function (fn, obj, prop, msg) {
  *     assert.decreasesBy(fn, obj, 'val', 5);
  *
  * @name decreasesBy
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {Number} change amount (delta)
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @param {number} delta change amount (delta)
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2707,10 +2749,11 @@ assert.decreasesBy = function (fn, obj, prop, delta, msg) {
  *     assert.doesNotDecrease(fn, obj, 'val');
  *
  * @name doesNotDecrease
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @returns {Assertion}
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2734,11 +2777,12 @@ assert.doesNotDecrease = function (fn, obj, prop, msg) {
  *     assert.doesNotDecreaseBy(fn, obj, 'val', 1);
  *
  * @name doesNotDecreaseBy
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {Number} change amount (delta)
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @param {number} delta change amount (delta)
+ * @returns {Assertion}
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2766,11 +2810,11 @@ assert.doesNotDecreaseBy = function (fn, obj, prop, delta, msg) {
  *     assert.decreasesButNotBy(fn, obj, 'val', 1);
  *
  * @name decreasesButNotBy
- * @param {Function} modifier function
- * @param {Object} object or getter function
- * @param {String} property name _optional_
- * @param {Number} change amount (delta)
- * @param {String} message _optional_
+ * @param {Function} fn modifier function
+ * @param {object} obj object or getter function
+ * @param {string} prop property name _optional_
+ * @param {number} delta change amount (delta)
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2799,7 +2843,7 @@ assert.decreasesButNotBy = function (fn, obj, prop, delta, msg) {
  *     assert.ifError(err); // Rethrows err!
  *
  * @name ifError
- * @param {Object} object
+ * @param {object} val
  * @namespace Assert
  * @public
  */
@@ -2818,8 +2862,8 @@ assert.ifError = function (val) {
  *
  * @name isExtensible
  * @alias extensible
- * @param {Object} object
- * @param {String} message _optional_
+ * @param {object} obj
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2842,8 +2886,8 @@ assert.isExtensible = function (obj, msg) {
  *
  * @name isNotExtensible
  * @alias notExtensible
- * @param {Object} object
- * @param {String} message _optional_
+ * @param {object} obj
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2865,8 +2909,8 @@ assert.isNotExtensible = function (obj, msg) {
  *
  * @name isSealed
  * @alias sealed
- * @param {Object} object
- * @param {String} message _optional_
+ * @param {object} obj
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2883,8 +2927,8 @@ assert.isSealed = function (obj, msg) {
  *
  * @name isNotSealed
  * @alias notSealed
- * @param {Object} object
- * @param {String} message _optional_
+ * @param {object} obj
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2903,8 +2947,8 @@ assert.isNotSealed = function (obj, msg) {
  *
  * @name isFrozen
  * @alias frozen
- * @param {Object} object
- * @param {String} message _optional_
+ * @param {object} obj
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2921,8 +2965,8 @@ assert.isFrozen = function (obj, msg) {
  *
  * @name isNotFrozen
  * @alias notFrozen
- * @param {Object} object
- * @param {String} message _optional_
+ * @param {object} obj
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2946,8 +2990,8 @@ assert.isNotFrozen = function (obj, msg) {
  *
  * @name isEmpty
  * @alias empty
- * @param {Object|Array|String|Map|Set} target
- * @param {String} message _optional_
+ * @param {object | Array | string | Map | Set} val
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2971,8 +3015,8 @@ assert.isEmpty = function(val, msg) {
  *
  * @name isNotEmpty
  * @alias notEmpty
- * @param {Object|Array|String|Map|Set} target
- * @param {String} message _optional_
+ * @param {object | Array | string | Map | Set} val
+ * @param {string} msg _optional_
  * @namespace Assert
  * @public
  */
@@ -2982,6 +3026,10 @@ assert.isNotEmpty = function(val, msg) {
 
 /**
  * Aliases.
+ *
+ * @param {unknown} name
+ * @param {unknown} as
+ * @returns {unknown}
  */
 (function alias(name, as){
   assert[as] = assert[name];