Skip to content
This repository has been archived by the owner on Aug 11, 2021. It is now read-only.

Commit

Permalink
Remove options from tree()
Browse files Browse the repository at this point in the history
The `level` option of `tree()` is a premature optimization which
wasn't even implemented by many formats. To keep the API surface
small, remove that option.

Now no option is left, hence the whole `options` argument can be
removed.
  • Loading branch information
vmx committed Jun 22, 2018
1 parent d962c09 commit ee86ce9
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,10 @@ If `path` is the root `/`, the result is a nested object that contains all paths

Numbers within a path are interpreted as an array.

#### `resolver.tree(binaryBlob[, options], callback)`
#### `resolver.tree(binaryBlob, callback)`

> returns all the paths available in this block.
Options include:
- level: 0 to n - how many levels deep should the traversal go.

`callback` must have the signature `function (err, result)`, where `err` is an Error if the function fails and `result` is a list of path such as `["/foo", "/bar", "/author/name", ...]`.

### Properties
Expand Down

0 comments on commit ee86ce9

Please sign in to comment.