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

Commit fe3a7e0

Browse files
author
blond
committed
docs(api): up isBemEntityName function
1 parent 31fb8be commit fe3a7e0

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ API
103103
* [id](#id)
104104
* [type](#type)
105105
* [isEqual(entityName)](#isequalentityname)
106+
* [isBemEntityName(entityName)](#isbementitynameentityname)
106107
* [toString()](#tostring)
107108
* [valueOf()](#valueof)
108-
* [isBemEntityName()](#isbementityname)
109109

110110
### constructor(obj)
111111

@@ -206,6 +206,23 @@ inputName.isEqual(buttonName); // false
206206
buttonName.isEqual(buttonName); // true
207207
```
208208

209+
### isBemEntityName(entityName)
210+
211+
Determines whether specified entity is instance of BemEntityName.
212+
213+
Parameter | Type | Description
214+
-------------|-----------------|-----------------------
215+
`entityName` | `BemEntityName` | The entity to check.
216+
217+
```js
218+
const BemEntityName = require('@bem/entity-name');
219+
220+
const entityName = new BemEntityName({ block: 'input' });
221+
222+
BemEntityName.isBemEntityName(entityName); // true
223+
BemEntityName.isBemEntityName({}); // false
224+
```
225+
209226
### toString()
210227

211228
Returns string representing the entity name.
@@ -233,23 +250,6 @@ name.valueOf();
233250
// ➜ { block: 'button', mod: { name: 'focused', value: true } }
234251
```
235252

236-
### isBemEntityName(entityName)
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-
253253
Debuggability
254254
-------------
255255

0 commit comments

Comments
 (0)