isogit-lfs/README.adoc

22 lines
631 B
Plaintext
Raw Normal View History

2021-11-25 12:27:33 +00:00
Aspirationally, it is a set of low-level helpers
to simplify working with Git LFS via Isomorphic Git.
As of 0.1.0, support is limited to:
- `readPointer({ dir, gitdir, content })`
+
where `dir`, `gitdir` behavior mimics that of Isomorphic Git,
2021-11-25 12:28:41 +00:00
and `content` is a `Buffer`.
2021-11-25 12:27:33 +00:00
- `downloadBlobFromPointer({ http, headers, url }, lfsPointer)`
+
where `http` is an `HttpClient` as supported by Isomorphic Git,
URL is repository URL
2021-11-25 12:29:04 +00:00
and `lfsPointer` is an object returned by `readPointer()`.
2021-11-25 12:27:33 +00:00
- `populateCache(workDir, ref?)`
+
where `workDir` is a path to working directory,
and `ref` should probably be left at the default `"HEAD"`.