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

Commit 776bfc0

Browse files
author
blond
committed
docs(isBemEntityName): add isBemEntityName method
1 parent 1f81308 commit 776bfc0

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ API
105105
* [isEqual(entityName)](#isequalentityname)
106106
* [toString()](#tostring)
107107
* [valueOf()](#valueof)
108+
* [isBemEntityName()](#isbementityname)
108109

109110
### constructor(obj)
110111

@@ -193,7 +194,6 @@ Parameter | Type | Description
193194
-------------|-----------------|-----------------------
194195
`entityName` | `BemEntityName` | The entity to compare.
195196

196-
197197
Determines whether specified entity is the deepEqual entity.
198198

199199
```js
@@ -233,6 +233,23 @@ name.valueOf();
233233
// ➜ { block: 'button', mod: { name: 'focused', value: true } }
234234
```
235235

236+
### isBemEntityName()
237+
238+
Determines whether specified entity is instance of BemEntityName.
239+
240+
Parameter | Type | Description
241+
-------------|-----------------|-----------------------
242+
`entityName` | `BemEntityName` | The entity to check.
243+
244+
```js
245+
const BemEntityName = require('@bem/entity-name');
246+
247+
const entityName = new BemEntityName({ block: 'input' });
248+
249+
BemEntityName.isBemEntityName(entityName); // true
250+
BemEntityName.isBemEntityName({}); // false
251+
```
252+
236253
Debuggability
237254
-------------
238255

0 commit comments

Comments
 (0)