JSPM

git-packed-ref-parse

0.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 44980
  • Score
    100M100P100Q173315F
  • License MIT

streaming git packed-ref parser

Package Exports

  • git-packed-ref-parse

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (git-packed-ref-parse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

git-packed-ref-parse

parse packed-ref file streams into javascript objects.

// after git gc in a git repo
var fs = require('fs')
  , parse = require('git-packed-ref-parse')

fs.createReadStream('.git/packed-refs')
  .pipe(parse())
  .on('data', console.log)

API

parse() -> parse stream

create a parse stream. when piped to, it will set the encoding of the source stream to utf8.

data event

the parse stream will emit data events for each ref contained in the packed-ref file.

they take this form:

{ "hash": "40 character git hash"
, "name": "ref name"
, "commit": null | "40 character git hash" }

commit will usually be null, except for annotated tag references.

License

MIT