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

Commit 2eb502a

Browse files
author
blond
committed
docs(api): update constructor view
1 parent fe3a7e0 commit 2eb502a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ new BemEntityName({
9696
API
9797
---
9898

99-
* [constructor(obj)](#constructorobj)
99+
* [constructor({ block, elem, mod })](#constructor-block-elem-mod-)
100100
* [block](#block)
101101
* [elem](#elem)
102102
* [mod](#mod)
@@ -107,15 +107,15 @@ API
107107
* [toString()](#tostring)
108108
* [valueOf()](#valueof)
109109

110-
### constructor(obj)
110+
### constructor({ block, elem, mod })
111111

112-
Parameter | Type | Description
113-
--------------|----------|------------------------------
114-
`obj.block` | `string` | The block name of entity.
115-
`obj.elem` | `string` | The element name of entity.
116-
`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 }`.
117-
`obj.mod.name`| `string` | The modifier name of entity.
118-
`obj.mod.val` | `*` | The modifier value of entity.
112+
Parameter | Type | Description
113+
----------|----------|------------------------------
114+
`block` | `string` | The block name of entity.
115+
`elem` | `string` | The element name of entity.
116+
`mod` | `string`, `object` | The modifier of entity.<br><br> If specified value is `string` then it will be equivalent to `{ name: string, val: true }`.
117+
`mod.name`| `string` | The modifier name of entity.
118+
`mod.val` | `*` | The modifier value of entity.
119119

120120
### block
121121

0 commit comments

Comments
 (0)