var result = Tree.entryCmp(e1, e2);

Tree.lookup(repo, id, callback).then(function(tree) {
  // Use tree
});

Retrieves the tree pointed to by the oid

Tree.lookupPrefix(repo, id, len).then(function(tree) {
  // Use tree
});

var treeEntry = tree._entryByIndex(idx);

| Parameters | Type | | --- | --- | --- | | idx | Number | the position in the entry list |

var treeEntry = tree._entryByName(filename);

| Parameters | Type | | --- | --- | --- | | filename | String | the filename of the desired entry |

var treebuilder = tree.builder();

Make builder. This is helpful for modifying trees.

tree.createUpdated(repo, nupdates, updates).then(function(oid) {
  // Use oid
});

| Parameters | Type | | --- | --- | --- | | repo | Repository | the repository in which to create the tree, must be the same as for baseline | | nupdates | Number | the number of elements in the update list | | updates | Array | the list of updates to perform |

tree.diff(tree, callback).then(function(diffList) {
  // Use diffList
});

Diff two trees

| Parameters | Type | | --- | --- | --- | | tree | Tree | to diff against | | callback | Function | |

tree.diffWithOptions(tree, options, callback).then(function(diffList) {
  // Use diffList
});

Diff two trees with options

| Parameters | Type | | --- | --- | --- | | tree | Tree | to diff against | | options | Object | | | callback | Function | |

tree.dup().then(function(tree) {
  // Use tree
});

var arrayTreeEntry = tree.entries();

Return an array of the entries in this tree (excluding its children).

var treeEntry = tree.entryById(id);

| Parameters | Type | | --- | --- | --- | | id | Oid | the sha being looked for |

var treeEntry = tree.entryByIndex(i);

Get an entry at the ith position.

| Parameters | Type | | --- | --- | --- | | i | Number | |

var treeEntry = tree.entryByName(name);

Get an entry by name; if the tree is a directory, the name is the filename.

| Parameters | Type | | --- | --- | --- | | name | String | |

tree.entryByPath(path).then(function(treeEntry) {
  // Use treeEntry
});

| Parameters | Type | | --- | --- | --- | | path | String | Path to the contained entry |

var result = tree.entryCount();

tree.getEntry(filePath).then(function(treeEntry) {
  // Use treeEntry
});

Get an entry at a path. Unlike by name, this takes a fully qualified path, like /foo/bar/baz.javascript

| Parameters | Type | | --- | --- | --- | | filePath | String | |

var oid = tree.id();

var repository = tree.owner();

var string = tree.path();

Return the path of this tree, like /lib/foo/bar

var eventEmitter = tree.walk([blobsOnly);

eventEmitter.on('entry', function(tree) {
  // Use tree
});

eventEmitter.on('end', function(trees) {
  // Use trees
});

eventEmitter.on('error', function(error) {
  // Use error
});

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

| Parameters | Type | | --- | --- | --- | | [blobsOnly | Boolean | = true] True to emit only blob & blob executable entries. |

| Flag | Value | | --- | --- | --- | | Tree.UPDATE.UPSERT | 0 | | Tree.UPDATE.REMOVE | 1 |

| Flag | Value | | --- | --- | --- | | Tree.WALK_MODE.WALK_PRE | 0 | | Tree.WALK_MODE.WALK_POST | 1 |