docs: expand, rephrase some docstrings and comments

This commit is contained in:
Anton Strogonoff 2021-11-30 22:18:27 +01:00
parent a71d6dc1f4
commit 1403b87f6b
2 changed files with 5 additions and 2 deletions

View file

@ -34,7 +34,7 @@ export default async function downloadBlobFromPointer(
? getAuthHeader(auth) ? getAuthHeader(auth)
: {}; : {};
// Request LFS metadata // Request LFS transfer
const lfsInfoRequestData = { const lfsInfoRequestData = {
operation: 'download', operation: 'download',

View file

@ -2,14 +2,17 @@ import path from 'path';
interface PointerInfo { interface PointerInfo {
/** SHA256 hash of the actual blob contents. */
oid: string; oid: string;
/** Actual blob size in bytes. */
size: number; size: number;
} }
export interface Pointer { export interface Pointer {
info: PointerInfo; info: PointerInfo;
/** Path to blob in LFS cache. */ /** Absolute path to actual blob in LFS cache. */
objectPath: string; objectPath: string;
} }