Skip to content

Latest commit

 

History

History
118 lines (90 loc) · 3.24 KB

File metadata and controls

118 lines (90 loc) · 3.24 KB
layout default
menu_item api
title Treebuilder
description Version 0.4.0
return_to
API Documentation Index
/api/
sections
create #clear #entrycount #free #get #insert #remove #write
#create
#clear
#entrycount
#free
#get
#insert
#remove
#write

Treebuilder.create AsyncExperimental

Treebuilder.create(repo, source).then(function(treebuilder) {
  // Use treebuilder
});
Parameters Type
repo Repository Repository in which to store the object
source Tree Source tree to initialize the builder (optional)
Returns
Treebuilder the tree builder

Treebuilder#clear SyncExperimental

treebuilder.clear();

Treebuilder#entrycount SyncExperimental

var result = treebuilder.entrycount();
Returns
Number the number of entries in the treebuilder

Treebuilder#free SyncExperimental

treebuilder.free();

Treebuilder#get SyncExperimental

var treeEntry = treebuilder.get(filename);

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

Returns
TreeEntry

Treebuilder#insert AsyncExperimental

treebuilder.insert(filename, id, filemode).then(function(treeEntry) {
  // Use treeEntry
});

| Parameters | Type | | --- | --- | --- | | filename | String | Filename of the entry | | id | Oid | SHA1 oid of the entry | | filemode | Number | Folder attributes of the entry. This parameter must be valued with one of the following entries: 0040000, 0100644, 0100755, 0120000 or 0160000. |

Returns
TreeEntry

Treebuilder#remove SyncExperimental

var result = treebuilder.remove(filename);

| Parameters | Type | | --- | --- | --- | | filename | String | Filename of the entry to remove |

Returns
Number

Treebuilder#write SyncExperimental

var result = treebuilder.write(id);

| Parameters | Type | | --- | --- | --- | | id | Oid | Pointer to store the OID of the newly written tree |

Returns
Number 0 or an error code