chai 5.0.3 → 5.1.0

package/lib/chai/interface/expect.js

@@ -13,6 +13,7 @@ function expect(val, message) {
 }
 
 export {expect};
+
 /**
  * ### .fail([message])
  * ### .fail(actual, expected, [message], [operator])
@@ -27,14 +28,13 @@ export {expect};
  *     expect.fail(1, 2, undefined, ">");
  *
  * @name fail
- * @param {Mixed} actual
- * @param {Mixed} expected
+ * @param {unknown} actual
+ * @param {unknown} expected
  * @param {String} message
  * @param {String} operator
- * @namespace BDD
- * @api public
+ * @namespace expect
+ * @public
  */
-
 expect.fail = function (actual, expected, message, operator) {
   if (arguments.length < 2) {
       message = actual;

package/lib/chai/interface/should.js

@@ -57,14 +57,13 @@ function loadShould () {
    *
    *
    * @name fail
-   * @param {Mixed} actual
-   * @param {Mixed} expected
+   * @param {unknown} actual
+   * @param {unknown} expected
    * @param {String} message
    * @param {String} operator
    * @namespace BDD
-   * @api public
+   * @public
    */
-
   should.fail = function (actual, expected, message, operator) {
     if (arguments.length < 2) {
         message = actual;
@@ -87,13 +86,12 @@ function loadShould () {
    *     should.equal(3, '3', '== coerces values to strings');
    *
    * @name equal
-   * @param {Mixed} actual
-   * @param {Mixed} expected
+   * @param {unknown} actual
+   * @param {unknown} expected
    * @param {String} message
    * @namespace Should
-   * @api public
+   * @public
    */
-
   should.equal = function (val1, val2, msg) {
     new Assertion(val1, msg).to.equal(val2);
   };
@@ -119,9 +117,8 @@ function loadShould () {
    * @param {String} message
    * @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
    * @namespace Should
-   * @api public
+   * @public
    */
-
   should.Throw = function (fn, errt, errs, msg) {
     new Assertion(fn, msg).to.Throw(errt, errs);
   };
@@ -137,9 +134,8 @@ function loadShould () {
    *
    * @name exist
    * @namespace Should
-   * @api public
+   * @public
    */
-
   should.exist = function (val, msg) {
     new Assertion(val, msg).to.exist;
   }
@@ -155,13 +151,12 @@ function loadShould () {
    *     should.not.equal(3, 4, 'these numbers are not equal');
    *
    * @name not.equal
-   * @param {Mixed} actual
-   * @param {Mixed} expected
+   * @param {unknown} actual
+   * @param {unknown} expected
    * @param {String} message
    * @namespace Should
-   * @api public
+   * @public
    */
-
   should.not.equal = function (val1, val2, msg) {
     new Assertion(val1, msg).to.not.equal(val2);
   };
@@ -183,9 +178,8 @@ function loadShould () {
    * @param {String} message
    * @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
    * @namespace Should
-   * @api public
+   * @public
    */
-
   should.not.Throw = function (fn, errt, errs, msg) {
     new Assertion(fn, msg).to.not.Throw(errt, errs);
   };
@@ -201,9 +195,8 @@ function loadShould () {
    *
    * @name not.exist
    * @namespace Should
-   * @api public
+   * @public
    */
-
   should.not.exist = function (val, msg) {
     new Assertion(val, msg).to.not.exist;
   }

package/lib/chai/utils/addChainableMethod.js

@@ -4,17 +4,13 @@
  * MIT Licensed
  */
 
-/*!
- * Module dependencies
- */
-
 import {Assertion} from '../assertion.js';
 import {addLengthGuard} from './addLengthGuard.js';
 import {flag} from './flag.js';
 import {proxify} from './proxify.js';
 import {transferFlags} from './transferFlags.js';
 
-/*!
+/**
  * Module variables
  */
 

package/lib/chai/utils/compareByInspect.js

@@ -4,10 +4,6 @@
  * MIT Licensed
  */
 
-/*!
- * Module dependencies
- */
-
 import {inspect} from './inspect.js';
 
 /**

package/lib/chai/utils/getMessage.js

@@ -4,10 +4,6 @@
  * MIT Licensed
  */
 
-/*!
- * Module dependencies
- */
-
 import {flag} from './flag.js';
 import {getActual} from './getActual.js';
 import {objDisplay} from './objDisplay.js';

package/lib/chai/utils/getOwnEnumerableProperties.js

@@ -4,10 +4,6 @@
  * MIT Licensed
  */
 
-/*!
- * Module dependencies
- */
-
 import {getOwnEnumerablePropertySymbols} from './getOwnEnumerablePropertySymbols.js';
 
 /**

package/lib/chai/utils/index.js

@@ -4,171 +4,88 @@
  * MIT Licensed
  */
 
-/*!
- * Dependencies that are used for multiple exports are required here only once
- */
-
+// Dependencies that are used for multiple exports are required here only once
 import * as checkError from 'check-error';
 
-/*!
- * test utility
- */
-
+// test utility
 export {test} from './test.js';
 
-/*!
- * type utility
- */
-
+// type utility
 export {type} from './type-detect.js';
 
-/*!
- * expectTypes utility
- */
+// expectTypes utility
 export {expectTypes} from './expectTypes.js';
 
-/*!
- * message utility
- */
-
+// message utility
 export {getMessage} from './getMessage.js';
 
-/*!
- * actual utility
- */
-
+// actual utility
 export {getActual} from './getActual.js';
 
-/*!
- * Inspect util
- */
-
+// Inspect util
 export {inspect} from './inspect.js';
 
-/*!
- * Object Display util
- */
-
+// Object Display util
 export {objDisplay} from './objDisplay.js';
 
-/*!
- * Flag utility
- */
-
+// Flag utility
 export {flag} from './flag.js';
 
-/*!
- * Flag transferring utility
- */
-
+// Flag transferring utility
 export {transferFlags} from './transferFlags.js';
 
-/*!
- * Deep equal utility
- */
-
+// Deep equal utility
 export {default as eql} from 'deep-eql';
 
-/*!
- * Deep path info
- */
-
+// Deep path info
 export {getPathInfo, hasProperty} from 'pathval';
 
-/*!
- * Function name
- */
-
+// Function name
 export function getName(fn) {
   return fn.name
 }
 
-/*!
- * add Property
- */
-
+// add Property
 export {addProperty} from './addProperty.js';
 
-/*!
- * add Method
- */
-
+// add Method
 export {addMethod} from './addMethod.js';
 
-/*!
- * overwrite Property
- */
-
+// overwrite Property
 export {overwriteProperty} from './overwriteProperty.js';
 
-/*!
- * overwrite Method
- */
-
+// overwrite Method
 export {overwriteMethod} from './overwriteMethod.js';
 
-/*!
- * Add a chainable method
- */
-
+// Add a chainable method
 export {addChainableMethod} from './addChainableMethod.js';
 
-/*!
- * Overwrite chainable method
- */
-
+// Overwrite chainable method
 export {overwriteChainableMethod} from './overwriteChainableMethod.js';
 
-/*!
- * Compare by inspect method
- */
-
+// Compare by inspect method
 export {compareByInspect} from './compareByInspect.js';
 
-/*!
- * Get own enumerable property symbols method
- */
-
+// Get own enumerable property symbols method
 export {getOwnEnumerablePropertySymbols} from './getOwnEnumerablePropertySymbols.js';
 
-/*!
- * Get own enumerable properties method
- */
-
+// Get own enumerable properties method
 export {getOwnEnumerableProperties} from './getOwnEnumerableProperties.js';
 
-/*!
- * Checks error against a given set of criteria
- */
-
+// Checks error against a given set of criteria
 export {checkError};
 
-/*!
- * Proxify util
- */
-
+// Proxify util
 export {proxify} from './proxify.js';
 
-/*!
- * addLengthGuard util
- */
-
+// addLengthGuard util
 export {addLengthGuard} from './addLengthGuard.js';
 
-/*!
- * isProxyEnabled helper
- */
-
+// isProxyEnabled helper
 export {isProxyEnabled} from './isProxyEnabled.js';
 
-/*!
- * isNaN method
- */
-
+// isNaN method
 export {isNaN} from './isNaN.js';
 
-/*!
- * getOperator method
- */
-
+// getOperator method
 export {getOperator} from './getOperator.js';

package/lib/chai/utils/objDisplay.js

@@ -4,10 +4,6 @@
  * MIT Licensed
  */
 
-/*!
- * Module dependencies
- */
-
 import {inspect} from './inspect.js';
 import {config} from '../config.js';
 

package/lib/chai/utils/test.js

@@ -4,10 +4,6 @@
  * MIT Licensed
  */
 
-/*!
- * Module dependencies
- */
-
 import {flag} from './flag.js';
 
 /**

package/lib/chai.js

@@ -15,10 +15,7 @@ import {assert} from './chai/interface/assert.js';
 
 const used = [];
 
-/*!
- * Assertion Error
- */
-
+// Assertion Error
 export {AssertionError};
 
 /**
@@ -30,7 +27,6 @@ export {AssertionError};
  * @returns {this} for chaining
  * @api public
  */
-
 export function use(fn) {
   const exports = {
     AssertionError,
@@ -50,38 +46,20 @@ export function use(fn) {
   return exports;
 };
 
-/*!
- * Utility Functions
- */
-
+// Utility Functions
 export {util};
 
-/*!
- * Configuration
- */
-
+// Configuration
 export {config};
 
-/*!
- * Primary `Assertion` prototype
- */
-
+// Primary `Assertion` prototype
 export * from './chai/assertion.js';
 
-/*!
- * Expect interface
- */
-
+// Expect interface
 export * from './chai/interface/expect.js';
 
-/*!
- * Should interface
- */
-
+// Should interface
 export * from './chai/interface/should.js';
 
-/*!
- * Assert interface
- */
-
+// Assert interface
 export * from './chai/interface/assert.js';

package/package.json

@@ -18,7 +18,7 @@
     "Veselin Todorov <hi@vesln.com>",
     "John Firebaugh <john.firebaugh@gmail.com>"
   ],
-  "version": "5.0.3",
+  "version": "5.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/chaijs/chai"