vlt / docs

  • PricingBenchmarks (opens in new window)Community (opens in new window)Feedback
  • Overview
    • Overview
    • clonefile
    • git-archive-commit
    • link-tree
    • index
    • placement-pool
    • placement-worker
    • pool
    • Reference
    • store-entry
    • store-index
    • unpack
  • Functions
  • gitArchiveCommit()
  • gitArchiveSubmodules()
  1. Client
  2. /
  3. API Reference
  4. /
  5. @vltpkg/tar
  6. /
  7. git-archive-commit

git-archive-commit

Functions

gitArchiveCommit()

TypeScript
function gitArchiveCommit(tarData): undefined | string

Defined in: tar/src/git-archive-commit.ts:17

The commit a git archive tarball was made from: the comment of its leading pax global header. Takes a gzipped or raw tarball and inflates only its head. undefined when there is none (eg an npm tarball) or the data is not a tarball.

Parameters

ParameterType
tarDataBuffer

Returns

undefined | string


gitArchiveSubmodules()

TypeScript
function gitArchiveSubmodules(tarData): boolean

Defined in: tar/src/git-archive-commit.ts:50

Whether a tarball's root dir has a .gitmodules file: a git archive of a repo with submodules, which it leaves out. Takes a gzipped or raw tarball; false if it is not one.

Parameters

ParameterType
tarDataBuffer

Returns

boolean


PreviousclonefileNextlink-tree

On this page

  • Functions
  • gitArchiveCommit()
  • gitArchiveSubmodules()

Deploy your package on vlt.io

Publish scoped and private packages, manage organizations and access, and give every developer and CI environment a consistent source for public and private JavaScript dependencies.

Publish now