Go to file
2023-05-16 19:56:12 -03:00
src 0.3.0 - usar fetch y coso 2023-05-16 19:48:26 -03:00
.gitignore chore: package with Babel 2021-11-25 14:10:31 +01:00
.npmrc @nulo registry 2022-12-07 12:51:27 -03:00
LICENSE Initial commit 2021-11-25 13:27:33 +01:00
package.json 0.3.1 - compilar para webpack4 2023-05-16 19:56:12 -03:00
pnpm-lock.yaml 0.2.0 pnpm 2022-12-07 20:39:32 -03:00
README.adoc docs(README): consistent syntax, mark tentative API 2021-12-02 19:11:58 +01:00
tsconfig.json 0.3.1 - compilar para webpack4 2023-05-16 19:56:12 -03:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Aspirationally, a set of helpers
to simplify working with Git LFS through Isomorphic Git.

== Installation

Peer dependencies:

- Isomorphic Git ^1.7.0
- @aws-crypto/sha256-universal ^2.0.0

== Usage

As of 0.1.6, API offers the following functions:

- `downloadBlobFromPointer({ http, headers, url, auth }, lfsPointer) => Buffer`
where `http` is an `HttpClient` as supported by Isomorphic Git,
URL is repository URL
and `lfsPointer` is an object returned by `readPointer()`.
Uses cache, if the object had been previously retrieved.

- `uploadBlob({ http, headers, url, auth }, buffer) => LFSPointerInfo`
where first argument is the same as for the download function,
and returned pointer info can be used to write a pointer file in place
of actual object in Git repository (pass it through `formatPointerInfo()`).

- `readPointer({ dir, gitdir, content }) => LFSPointer`
where `dir`, `gitdir` behavior mimics that of Isomorphic Git,
and `content` is a `Buffer`.

- `readPointerInfo(buffer) => LFSPointerInfo`
reads a properly formatted LFS pointer within a Git repository.

- `formatPointerInfo(lfsPointerInfo) => Buffer`
converts pointer info to appropriately formatted blob
suitable to be stored in Git repository in place of actual object data.

- `populateCache(workDir, ref?)`
where `workDir` is a path to working directory,
and `ref` should probably be left at the default `"HEAD"`.
NOTE: Very tentative API.

== Known shortcomings

- Works in Node runtime only
- @aws-crypto/sha256-universal peer dependency is unnecessary.
If were Node-only we can probably achieve the same using Nodes `crypto` module,
and if not we should place it in actual `dependencies`.

== Considered within scope

- Implement batch uploads and downloads (parallelise requests? use native batch API?)
- Find a way to generalize UA header handling
- Make it work in browser runtime as well (if feasible?)