Skip to content
This repository was archived by the owner on Feb 4, 2018. It is now read-only.

Commit ffce876

Browse files
author
blond
committed
docs(jsdoc): add jsdoc to EntityTypeError
1 parent 03fd60a commit ffce876

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

index.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@ const TYPES = {
1717
ELEM: 'elem',
1818
ELEM_MOD: 'elemMod'
1919
};
20-
20+
/**
21+
* The EntityTypeError object represents an error when a value is not valid BEM entity.
22+
*/
2123
class EntityTypeError extends ExtendableError {
2224
/**
2325
* @param {object} obj — not valid object
24-
* @param {str} [reason] — reason why object is not valid
26+
* @param {string} [reason] — human-readable reason why object is not valid
2527
*/
2628
constructor(obj, reason) {
2729
const str = util.inspect(obj, { depth: 1 });

0 commit comments

Comments
 (0)