Skip to content

Latest commit

 

History

History
150 lines (110 loc) · 3.31 KB

File metadata and controls

150 lines (110 loc) · 3.31 KB
layout default
menu_item api
title TreeEntry
description Version 0.5.0
return_to
API Documentation Index
/api/
sections
#getBlob #getTree #isBlob #isDirectory #isFile #isTree #path #sha #toString FILEMODE Instance Variables
#getBlob
#getTree
#isBlob
#isDirectory
#isFile
#isTree
#path
#sha
#toString
#FILEMODE
#ivars

TreeEntry#getBlob Async

treeEntry.getBlob().then(function(blob) {
  // Use blob
});

Retrieve the tree for this entry. Make sure to call isTree first!

Returns
Blob

TreeEntry#getTree Async

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

Retrieve the tree for this entry. Make sure to call isTree first!

Returns
Tree

TreeEntry#isBlob Sync

var boolean = treeEntry.isBlob();

Is this TreeEntry a blob? Alias for isFile

Returns
Boolean

TreeEntry#isDirectory Sync

var boolean = treeEntry.isDirectory();

Is this TreeEntry a directory? Alias for isTree

Returns
Boolean

TreeEntry#isFile Sync

var boolean = treeEntry.isFile();

Is this TreeEntry a blob? (i.e., a file)

Returns
Boolean

TreeEntry#isTree Sync

var boolean = treeEntry.isTree();

Is this TreeEntry a tree? (i.e., a directory)

Returns
Boolean

TreeEntry#path Sync

var string = treeEntry.path();

Returns the path for this entry.

Returns
String

TreeEntry#sha Sync

var string = treeEntry.sha();

Retrieve the SHA for this TreeEntry.

Returns
String

TreeEntry#toString Sync

treeEntry.toString();

Alias for path

TreeEntry.FILEMODE ENUM

| Flag | Value | | --- | --- | --- | | TreeEntry.FILEMODE.UNREADABLE | 0 | | TreeEntry.FILEMODE.TREE | 16384 | | TreeEntry.FILEMODE.BLOB | 33188 | | TreeEntry.FILEMODE.EXECUTABLE | 33261 | | TreeEntry.FILEMODE.LINK | 40960 | | TreeEntry.FILEMODE.COMMIT | 57344 |

Instance Variables

Variable Type
attr Number
filename String
filenameLen Number
oid Oid