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

Commit 97ce8b1

Browse files
authored
Merge pull request #56 from bem-sdk/docs/params
docs(readme): update params view
2 parents d90afd3 + 3637670 commit 97ce8b1

File tree

1 file changed

+11
-24
lines changed

1 file changed

+11
-24
lines changed

README.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -106,25 +106,13 @@ API
106106

107107
### constructor(obj)
108108

109-
#### obj.block
110-
111-
Type: `string`
112-
113-
The block name of entity.
114-
115-
#### obj.elem
116-
117-
Type: `string`
118-
119-
The element name of entity.
120-
121-
#### obj.mod
122-
123-
Type: `string`, `{ name: string, val: * }`
124-
125-
The modifier of entity.
126-
127-
If specified value is `string` then it will be equivalent to `{ name: string, val: true }`.
109+
Parameter | Type | Description
110+
--------------|----------|------------------------------
111+
`obj.block` | `string` | The block name of entity.
112+
`obj.elem` | `string` | The element name of entity.
113+
`obj.mod` | `string`, `object` | The modifier of entity.<br><br> If specified value is `string` then it will be equivalent to `{ name: string, val: true }`.
114+
`obj.mod.name`| `string` | The modifier name of entity.
115+
`obj.mod.val` | `*` | The modifier value of entity.
128116

129117
### block
130118

@@ -196,13 +184,12 @@ modName.type; // elemMod
196184

197185
### isEqual(entityName)
198186

199-
Determines whether specified entity is the deepEqual entity.
200-
201-
#### entityName
187+
Parameter | Type | Description
188+
-------------|-----------------|-----------------------
189+
`entityName` | `BemEntityName` | The entity to compare.
202190

203-
Type: `BemEntityName`
204191

205-
The entity to compare.
192+
Determines whether specified entity is the deepEqual entity.
206193

207194
```js
208195
const BemEntityName = require('bem-entity-name');

0 commit comments

Comments
 (0)