This repository was archived by the owner on Feb 4, 2018. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +13
-7
lines changed Expand file tree Collapse file tree 2 files changed +13
-7
lines changed Original file line number Diff line number Diff line change @@ -37,7 +37,7 @@ const entityName = new BemEntityName({ block: 'button', elem: 'text' });
37
37
38
38
entityName .block ; // button
39
39
entityName .elem ; // text
40
- entityName .mod ; // {}
40
+ entityName .mod ; // undefined
41
41
42
42
entityName .id ; // button__elem
43
43
entityName .type ; // elem
@@ -143,13 +143,16 @@ name.elem; // text
143
143
144
144
The modifier of this entity.
145
145
146
- If entity is not modifier then returns empty object .
146
+ ** Important: ** If entity is not a modifier then returns ` undefined ` .
147
147
148
148
``` js
149
149
const BemEntityName = require (' bem-entity-name' );
150
- const name = new BemEntityName ({ block: ' button' , mod: ' disabled' });
151
150
152
- name .mod ; // { name: 'disabled', val: true }
151
+ const blockName = new BemEntityName ({ block: ' button' });
152
+ const modName = new BemEntityName ({ block: ' button' , mod: ' disabled' });
153
+
154
+ modName .mod ; // { name: 'disabled', val: true }
155
+ blockName .mod ; // undefined
153
156
```
154
157
155
158
### id
Original file line number Diff line number Diff line change @@ -76,13 +76,16 @@ module.exports = class BemEntityName {
76
76
/**
77
77
* Returns the modifier of this entity.
78
78
*
79
- * If entity is not modifier then returns empty object .
79
+ * Important: If entity is not a modifier then returns `undefined` .
80
80
*
81
81
* @example
82
82
* const BemEntityName = require('bem-entity-name');
83
- * const name = new BemEntityName({ block: 'button', mod: 'disabled' });
84
83
*
85
- * console.log(name.mod); // { name: 'disabled', val: true }
84
+ * const blockName = new BemEntityName({ block: 'button' });
85
+ * const modName = new BemEntityName({ block: 'button', mod: 'disabled' });
86
+ *
87
+ * console.log(modName.mod); // { name: 'disabled', val: true }
88
+ * console.log(blockName.mod); // undefined
86
89
*
87
90
* @returns {{mod: string, val: *} } entity modifier.
88
91
*/
You can’t perform that action at this time.
0 commit comments