Skip to content

Commit

Permalink
docs: add missing assert parameters (#1023)
Browse files Browse the repository at this point in the history
  • Loading branch information
Hpauric authored and shvaikalesh committed Aug 9, 2017
1 parent 6e72c5a commit 7c1ca16
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions chai.js
Expand Up @@ -6967,7 +6967,7 @@ module.exports = function (chai, util) {
}

/*!
* ### .ifError(object)
* ### .ifError(object, [message])
*
* Asserts if value is not a false value, and throws if it is a true value.
* This is added to allow for chai to be a drop-in replacement for Node's
Expand All @@ -6978,6 +6978,7 @@ module.exports = function (chai, util) {
*
* @name ifError
* @param {Object} object
* @param {String} message _optional_
* @namespace Assert
* @api public
*/
Expand All @@ -6989,7 +6990,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isExtensible(object)
* ### .isExtensible(object, [message])
*
* Asserts that `object` is extensible (can have new properties added to it).
*
Expand All @@ -7008,7 +7009,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isNotExtensible(object)
* ### .isNotExtensible(object, [message])
*
* Asserts that `object` is _not_ extensible.
*
Expand All @@ -7033,7 +7034,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isSealed(object)
* ### .isSealed(object, [message])
*
* Asserts that `object` is sealed (cannot have new properties added to it
* and its existing properties cannot be removed).
Expand All @@ -7057,7 +7058,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isNotSealed(object)
* ### .isNotSealed(object, [message])
*
* Asserts that `object` is _not_ sealed.
*
Expand All @@ -7076,7 +7077,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isFrozen(object)
* ### .isFrozen(object, [message])
*
* Asserts that `object` is frozen (cannot have new properties added to it
* and its existing properties cannot be modified).
Expand All @@ -7097,7 +7098,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isNotFrozen(object)
* ### .isNotFrozen(object, [message])
*
* Asserts that `object` is _not_ frozen.
*
Expand All @@ -7116,7 +7117,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isEmpty(target)
* ### .isEmpty(target, [message])
*
* Asserts that the target does not contain any values.
* For arrays and strings, it checks the `length` property.
Expand All @@ -7142,7 +7143,7 @@ module.exports = function (chai, util) {
};

/**
* ### .isNotEmpty(target)
* ### .isNotEmpty(target, [message])
*
* Asserts that the target contains values.
* For arrays and strings, it checks the `length` property.
Expand Down

0 comments on commit 7c1ca16

Please sign in to comment.