Skip to content

Fix tree walk example #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix tree walk example #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion api/tree/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ Return the path of this tree, like `/lib/foo/bar`
## <a name="walk"></a><span>Tree#</span>walk <span class="tags"><span class="sync">Sync</span></span>

```js
var eventEmitter = tree.walk([blobsOnly);
var eventEmitter = tree.walk();

eventEmitter.on('entry', function(tree) {
// Use tree
Expand All @@ -347,6 +347,9 @@ eventEmitter.on('end', function(trees) {
eventEmitter.on('error', function(error) {
// Use error
});

// start walking the tree
eventEmitter.start()
```

Recursively walk the tree in breadth-first order. Fires an event for each
Expand Down