# git-object-tree

> parse and create git tree objects

Latest version **1.0.0** (published 2016-06-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install git-object-tree
pnpm add git-object-tree
yarn add git-object-tree
bun add git-object-tree
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-06-18 |
| First published | 2013-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Chris Dickinson |
| Maintainers | chrisdickinson |
| Keywords | git, tree, object |

## Links

- npm: https://www.npmjs.com/package/git-object-tree
- Repository: https://github.com/chrisdickinson/git-object-tree
- Homepage: https://github.com/chrisdickinson/git-object-tree#readme
- Issues: https://github.com/chrisdickinson/git-object-tree/issues
- npm.io page: https://npm.io/package/git-object-tree

## Dependencies (1)

- [bops](https://npm.io/package/bops.md) ~0.0.6

## Recent versions

- 1.0.0 (latest) — 2016-06-18
- 0.0.5 — 2013-05-27
- 0.0.4 — 2013-05-06
- 0.0.3 — 2013-05-04
- 0.0.2 — 2013-04-04
- 0.0.1 — 2013-03-18
- 0.0.0 — 2013-03-18

## README

# git-object-tree

git tree objects as javascript objects.

tree objects are immutable once created.

```javascript
var Buffer = require('buffer').Buffer
  , tree = require('git-object-tree')

var b = tree.create(new Buffer(...))

b = tree.read(<some git buffer>)

```

## API

#### tree.read(<git buffer>) -> Tree

read a tree from some git buffer data.

#### tree.create(members) -> Tree

create a tree from some source data.

members should be a list of `{id: sha, mode: file mode number, name: string}` objects.

all fields (save for message) may be arrays.

#### Tree.prototype.entries() -> [entry list]

return a list of tree entries: 

```javascript
{ mode: number
, name: string
, hash: Buffer(20) }
```

## License

MIT

---
_Source: https://npm.io/package/git-object-tree · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._