Skip to content

index.md

Latest commit

 

History

History
440 lines (327 loc) · 11.2 KB

index.md

File metadata and controls

440 lines (327 loc) · 11.2 KB
layout default
menu_item api
title Tree
description Version 0.10.0
return_to
API Documentation Index
/api/
sections
entryCmp entryDup entryFilemode entryFilemodeRaw entryId entryName entryToObject entryType lookup lookupPrefix #_entryByIndex #builder #diff #diffWithOptions #entries #entryById #entryByIndex #entryByName #entryByPath #entryCount #free #getEntry #id #owner #path #walk WALK_MODE
#entryCmp
#entryDup
#entryFilemode
#entryFilemodeRaw
#entryId
#entryName
#entryToObject
#entryType
#lookup
#lookupPrefix
#_entryByIndex
#builder
#diff
#diffWithOptions
#entries
#entryById
#entryByIndex
#entryByName
#entryByPath
#entryCount
#free
#getEntry
#id
#owner
#path
#walk
#WALK_MODE

Tree.entryCmp SyncExperimental

var result = Tree.entryCmp(e1, e2);
Parameters Type
e1 TreeEntry first tree entry
e2 TreeEntry second tree entry
Returns
Number
<
0 if e1 is before e2, 0 if e1 == e2, >0 if e1 is after e2

Tree.entryDup SyncExperimental

var result = Tree.entryDup(dest, source);
Parameters Type
dest TreeEntry pointer where to store the copy
source TreeEntry tree entry to duplicate
Returns
Number 0 or an error code

Tree.entryFilemode SyncExperimental

var result = Tree.entryFilemode(entry);
Parameters Type
entry TreeEntry a tree entry
Returns
Number filemode as an integer

Tree.entryFilemodeRaw SyncExperimental

var result = Tree.entryFilemodeRaw(entry);
Parameters Type
entry TreeEntry a tree entry
Returns
Number filemode as an integer

Tree.entryId SyncExperimental

var oid = Tree.entryId(entry);
Parameters Type
entry TreeEntry a tree entry
Returns
Oid the oid of the object

Tree.entryName SyncExperimental

var string = Tree.entryName(entry);
Parameters Type
entry TreeEntry a tree entry
Returns
String the name of the file

Tree.entryToObject SyncExperimental

var result = Tree.entryToObject(object_out, repo, entry);
Parameters Type
object_out Object pointer to the converted object
repo Repository repository where to lookup the pointed object
entry TreeEntry a tree entry
Returns
Number 0 or an error code

Tree.entryType SyncExperimental

var result = Tree.entryType(entry);
Parameters Type
entry TreeEntry a tree entry
Returns
Number the type of the pointed object

Tree.lookup Async

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

Retrieves the tree pointed to by the oid

Parameters Type
repo Repository The repo that the tree lives in
id String, Oid, Tree The tree to lookup
callback Function
Returns
Tree

Tree.lookupPrefix AsyncExperimental

Tree.lookupPrefix(repo, id, len).then(function(tree) {
  // Use tree
});
Parameters Type
repo Repository the repo to use when locating the tree.
id Oid identity of the tree to locate.
len Number the length of the short identifier
Returns
Tree

Tree#_entryByIndex SyncExperimental

var treeEntry = tree._entryByIndex(idx);

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

Returns
TreeEntry the tree entry; NULL if not found

Tree#builder Sync

var treebuilder = tree.builder();

Make builder. This is helpful for modifying trees.

Returns
Treebuilder

Tree#diff Async

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

Diff two trees

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

Returns
DiffList

Tree#diffWithOptions Async

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 | |

Returns
DiffList

Tree#entries Sync

var arrayTreeEntry = tree.entries();

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

Returns
Array<TreeEntry> an array of TreeEntrys

Tree#entryById SyncExperimental

var treeEntry = tree.entryById(id);

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

Returns
TreeEntry the tree entry; NULL if not found

Tree#entryByIndex Sync

var treeEntry = tree.entryByIndex(i);

Get an entry at the ith position.

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

Returns
TreeEntry

Tree#entryByName Sync

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 | |

Returns
TreeEntry

Tree#entryByPath AsyncExperimental

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

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

Returns
TreeEntry the tree entry

Tree#entryCount SyncExperimental

var result = tree.entryCount();
Returns
Number the number of entries in the tree

Tree#free SyncExperimental

tree.free();

Tree#getEntry Sync

var treeEntry = tree.getEntry(filePath);

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

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

Returns
TreeEntry

Tree#id SyncExperimental

var oid = tree.id();
Returns
Oid object identity for the tree.

Tree#owner SyncExperimental

var repository = tree.owner();
Returns
Repository Repository that contains this tree.

Tree#path Sync

var string = tree.path();

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

Returns
String

Tree#walk Sync

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. |

Fires Sends
entry Tree
end Array<Tree>
error Error
Returns
EventEmitter

Tree.WALK_MODE ENUM

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