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

Commit

Permalink
fixup! fixup! fixup! fixup! docs(readme): update readme according to …
Browse files Browse the repository at this point in the history
…output format
  • Loading branch information
qfox committed Feb 1, 2017
1 parent 53bfe31 commit 26e2268
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion 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": {</code><br><code>  "entity": { "block": "page" },</code><br><code>  "layer": "libs/bem-core/desktop.blocks",</code><br><code>  "tech": "bemhtml"</code><br><code> },</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>BemFile {</code><br><code> "cell": BemCell {</code><br><code>  "entity": BemEntityName { "block": "page" },</code><br><code>  "layer": "libs/bem-core/desktop.blocks",</code><br><code>  "tech": "bemhtml"</code><br><code> },</code><br><code> "path": "libs/bem-core/desktop.blocks/page/page.bemhtml.js"</code><br><code>}</code><br><br>`cell` — BEM cell instance.<br>`entity` — BEM entity name instance.<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

0 comments on commit 26e2268

Please sign in to comment.