diff --git a/README.md b/README.md index d88191c..ed5c759 100644 --- a/README.md +++ b/README.md @@ -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.

The example below shows a JSON interface with elements that are in the response for the `walk` method. Objects and keys have sample values.

**Example**

{
"entity": { "block": "page" },
"level": "libs/bem-core/desktop.blocks",
"tech": "bemhtml",
"path": "libs/bem-core/desktop.blocks/page/page.bemhtml.js"
}

`entity` — BEM entity.
`level` — Directory path.
`tech` — Implementation technology.
`path` — Relative path to the file.| +|'data'|Returns a JavaScript object with information about a found file.

The example below shows a JSON interface with elements that are in the response for the `walk` method. Objects and keys have sample values.

**Example**

{
{ "cell": { "entity": { "block": "page" } },
"layer": "libs/bem-core/desktop.blocks",
"tech": "bemhtml" },
"path": "libs/bem-core/desktop.blocks/page/page.bemhtml.js"
}

`entity` — BEM entity.
`layer` — Directory path.
`tech` — Implementation technology.
`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. | @@ -221,11 +221,14 @@ const stream = walk(levels, { /* { button: - [ { entity: { block: 'button', mod: { name: 'togglable', val: 'radio' } }, - tech: 'spec.js', - path: 'libs/bem-components/common.blocks/button/_togglable/ - button_togglable_radio.spec.js', - level: 'libs/bem-components/common.blocks' } ], + [ BemFile { + cell: BemCell { + entity: BemEntityName { block: 'button', mod: { name: 'togglable', val: 'radio' } }, + tech: 'spec.js', + layer: 'libs/bem-components/common.blocks' + }, + path: 'libs/bem-components/common.blocks/button/_togglable/ + button_togglable_radio.spec.js' } ] }, ... } */ @@ -260,10 +263,14 @@ const stream = walk(levels, { .on('end', () => console.log(files)); /* -[{ entity: { block: 'popup', mod: { name: 'target', val: true } }, - tech: 'js', - path: 'libs/bem-components/common.blocks/popup/_target/popup_target.js', - level: 'libs/bem-components/common.blocks' }, +[BemFile { + cell: BemCell { + entity: BemEntityName { block: 'popup', mod: { name: 'target', val: true } }, + tech: 'js', + level: 'libs/bem-components/common.blocks' + }, + path: 'libs/bem-components/common.blocks/popup/_target/popup_target.js' +}, ... ] */ @@ -304,10 +311,12 @@ const stream = walk(levels, { .pipe(process.stdout); /* -[{"entity":{"block":"search","elem":"header"}, - "tech":"css", +[{"cell":{ + "entity":{"block":"search","elem":"header"}, + "tech":"css", + "level":"common.blocks" + }, "path":"common.blocks/search/__header/search__header.css", - "level":"common.blocks", "source":".search__header {\n\tdisplay: block;\n\tfont-size: 20px;\n\tcolor: rgba(0,0,0,0.84);\n\tmargin: 0;\n\tpadding: 0 0 16px;\n\n}\n\n"}, ...