---
layout: default
menu_item: api
title: TreeEntry
description: Version 0.26.1
menu_item: api
return_to:
  "API Documentation Index": /api/
sections:
  "#filemode": "#filemode"
  "#filemodeRaw": "#filemodeRaw"
  "#getBlob": "#getBlob"
  "#getTree": "#getTree"
  "#id": "#id"
  "#isBlob": "#isBlob"
  "#isDirectory": "#isDirectory"
  "#isFile": "#isFile"
  "#isSubmodule": "#isSubmodule"
  "#isTree": "#isTree"
  "#name": "#name"
  "#oid": "#oid"
  "#path": "#path"
  "#sha": "#sha"
  "#toObject": "#toObject"
  "#toString": "#toString"
  "#type": "#type"
  "FILEMODE": "#FILEMODE"
---

## <a name="filemode"></a><span>TreeEntry#</span>filemode <span class="tags"><span class="sync">Sync</span></span>

```js
var result = treeEntry.filemode();
```

| Returns |  |
| --- | --- |
| Number |  filemode as an integer |

## <a name="filemodeRaw"></a><span>TreeEntry#</span>filemodeRaw <span class="tags"><span class="sync">Sync</span></span>

```js
var result = treeEntry.filemodeRaw();
```

| Returns |  |
| --- | --- |
| Number |  filemode as an integer |

## <a name="getBlob"></a><span>TreeEntry#</span>getBlob <span class="tags"><span class="async">Async</span></span>

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

Retrieve the blob for this entry. Make sure to call `isBlob` first!

| Returns |  |
| --- | --- |
| [Blob](/api/blob/) |  |

## <a name="getTree"></a><span>TreeEntry#</span>getTree <span class="tags"><span class="async">Async</span></span>

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

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

| Returns |  |
| --- | --- |
| [Tree](/api/tree/) |  |

## <a name="id"></a><span>TreeEntry#</span>id <span class="tags"><span class="sync">Sync</span></span>

```js
var oid = treeEntry.id();
```

| Returns |  |
| --- | --- |
| [Oid](/api/oid/) |  the oid of the object |

## <a name="isBlob"></a><span>TreeEntry#</span>isBlob <span class="tags"><span class="sync">Sync</span></span>

```js
var boolean = treeEntry.isBlob();
```

Is this TreeEntry a blob? Alias for `isFile`

| Returns |  |
| --- | --- |
| Boolean |  |

## <a name="isDirectory"></a><span>TreeEntry#</span>isDirectory <span class="tags"><span class="sync">Sync</span></span>

```js
var boolean = treeEntry.isDirectory();
```

Is this TreeEntry a directory? Alias for `isTree`

| Returns |  |
| --- | --- |
| Boolean |  |

## <a name="isFile"></a><span>TreeEntry#</span>isFile <span class="tags"><span class="sync">Sync</span></span>

```js
var boolean = treeEntry.isFile();
```

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

| Returns |  |
| --- | --- |
| Boolean |  |

## <a name="isSubmodule"></a><span>TreeEntry#</span>isSubmodule <span class="tags"><span class="sync">Sync</span></span>

```js
var boolean = treeEntry.isSubmodule();
```

Is this TreeEntry a submodule?

| Returns |  |
| --- | --- |
| Boolean |  |

## <a name="isTree"></a><span>TreeEntry#</span>isTree <span class="tags"><span class="sync">Sync</span></span>

```js
var boolean = treeEntry.isTree();
```

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

| Returns |  |
| --- | --- |
| Boolean |  |

## <a name="name"></a><span>TreeEntry#</span>name <span class="tags"><span class="sync">Sync</span></span>

```js
var string = treeEntry.name();
```

| Returns |  |
| --- | --- |
| String |  the name of the file |

## <a name="oid"></a><span>TreeEntry#</span>oid <span class="tags"><span class="sync">Sync</span></span>

```js
var string = treeEntry.oid();
```

Retrieve the SHA for this TreeEntry. Alias for `sha`

| Returns |  |
| --- | --- |
| String |  |

## <a name="path"></a><span>TreeEntry#</span>path <span class="tags"><span class="sync">Sync</span></span>

```js
var string = treeEntry.path();
```

Returns the path for this entry.

| Returns |  |
| --- | --- |
| String |  |

## <a name="sha"></a><span>TreeEntry#</span>sha <span class="tags"><span class="sync">Sync</span></span>

```js
var string = treeEntry.sha();
```

Retrieve the SHA for this TreeEntry.

| Returns |  |
| --- | --- |
| String |  |

## <a name="toObject"></a><span>TreeEntry#</span>toObject <span class="tags"><span class="async">Async</span></span>

```js
treeEntry.toObject(repo).then(function(object) {
  // Use object
});
```

| Parameters | Type |
| --- | --- | --- |
| repo | [Repository](/api/repository/) | repository where to lookup the pointed object |

| Returns |  |
| --- | --- |
| [Object](/api/object/) |  |

## <a name="toString"></a><span>TreeEntry#</span>toString <span class="tags"><span class="sync">Sync</span></span>

```js
treeEntry.toString();
```

Alias for `path`

## <a name="type"></a><span>TreeEntry#</span>type <span class="tags"><span class="sync">Sync</span></span>

```js
var result = treeEntry.type();
```

| Returns |  |
| --- | --- |
| Number |  the type of the pointed object |

## <a name="FILEMODE"></a><span>TreeEntry.</span>FILEMODE <span class="tags"><span class="enum">ENUM</span></span>

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