# git-walk-refs

> create a readable stream of git commits

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

## Install

```sh
npm install git-walk-refs
pnpm add git-walk-refs
yarn add git-walk-refs
bun add git-walk-refs
```

## 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-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Chris Dickinson |
| Maintainers | chrisdickinson |
| Keywords | git, commit, walk, stream |

## Links

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

## Dependencies (2)

- [through](https://npm.io/package/through.md) ~2.2.7
- [git-parse-human](https://npm.io/package/git-parse-human.md) ^1.0.0

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-06-18
- 0.0.2 — 2014-05-14
- 0.0.1 — 2013-03-23

## README

# git-walk-refs

given a function to lookup hashes, a list of hashes
to walk, and an optional hash to stop at, return
a readable stream of git commits in (largely) reverse
chronological order.

```javascript
var load = require('git-fs-repo')
  , walk = require('git-walk-refs')
  , fs = require('fs')

load(fs, function(err, git) {
  var hashes = git.refs().map(function(ref) {
    return ref.hash
  })

  walk(git.find.bind(git), hashes)
    .on('data', console.log)
})

```

## API

#### walk(find function(hash, ready), hash array[, untilhash]) -> walk-stream

create a readable/writable stream of git commits.

#### walk-stream.write(hash)

mark a hash as "seen" arbitrarily. this is useful for the git smart
pack protocol.

## License

MIT

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