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

Commit

Permalink
fixup! docs(readme): update readme according to output format
Browse files Browse the repository at this point in the history
  • Loading branch information
qfox committed Feb 1, 2017
1 parent 2fd54c7 commit 102cc5f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Readable stream (`stream.Readable`) that has the following events:

| Event | Description |
|----------|-----|
|'data'|Returns a JavaScript object with information about a found file. </br></br>The example below shows a JSON interface with elements that are in the response for the `walk` method. Objects and keys have sample values.</br></br> **Example** </br></br><code> {</code></br><code>{ "cell": { "entity": { "block": "page" } },</code></br><code> "layer": "libs/bem-core/desktop.blocks",</code></br><code>"tech": "bemhtml" },</code></br><code>"path": "libs/bem-core/desktop.blocks/page/page.bemhtml.js"</code></br><code>}</code></br></br>`entity` — BEM entity.</br>`layer` — Directory path.</br>`tech` — Implementation technology.</br>`path` — Relative path to the file.|
|'data'|Returns a JavaScript object with information about a found file. <br><br>The example below shows a JSON interface with elements that are in the response for the `walk` method. Objects and keys have sample values.<br><br> **Example** <br><br><code> {</code><br><code> "cell": {</code><br><code> "entity": { "block": "page" },</code><br><code> "layer": "libs/bem-core/desktop.blocks",</code><br><code> "tech": "bemhtml"</code><br> },</code><br><code> "path": "libs/bem-core/desktop.blocks/page/page.bemhtml.js"</code><br><code>}</code><br><br>`entity` — BEM entity.<br>`layer` — Directory path.<br>`tech` — Implementation technology.<br>`path` — Relative path to the file.|
| 'error' | Generated if an error occurred while traversing the levels. Returns an object with the error description.|
| 'end' | Generated when `bem-walk` finishes traversing the levels defined in the `levels` object. |

Expand Down Expand Up @@ -267,7 +267,7 @@ const stream = walk(levels, {
cell: BemCell {
entity: BemEntityName { block: 'popup', mod: { name: 'target', val: true } },
tech: 'js',
level: 'libs/bem-components/common.blocks'
layer: 'libs/bem-components/common.blocks'
},
path: 'libs/bem-components/common.blocks/popup/_target/popup_target.js'
},
Expand Down Expand Up @@ -314,7 +314,7 @@ const stream = walk(levels, {
[{"cell":{
"entity":{"block":"search","elem":"header"},
"tech":"css",
"level":"common.blocks"
"layer":"common.blocks"
},
"path":"common.blocks/search/__header/search__header.css",
"source":".search__header {\n\tdisplay: block;\n\tfont-size: 20px;\n\tcolor:
Expand Down

0 comments on commit 102cc5f

Please sign in to comment.