vlt / docs

  • PricingBenchmarks (opens in new window)Community (opens in new window)Feedback
  • Overview
    • Overview
    • index
    • Reference
    • unzip
  • Variables
  • __CODE_SPLIT_SCRIPT_NAME
  • Functions
  • default()
  1. Client
  2. /
  3. API Reference
  4. /
  5. @vltpkg/cache-unzip
  6. /
  7. unzip

unzip

Variables

__CODE_SPLIT_SCRIPT_NAME

TypeScript
const __CODE_SPLIT_SCRIPT_NAME: string;

Defined in: unzip.ts:11

Functions

default()

TypeScript
function default(
   path, 
   input, 
store?): Promise<boolean>

Defined in: unzip.ts:42

Explode the tarball cache entries at the keys read from input into the global store root store, if given, then rewrite the rest un-gzipped: entries this run exploded stay gzipped. VLT_CACHE_UNZIP=0 never un-gzips, =1 un-gzips every entry, before exploding. Keys are \0-separated, each optionally followed by \t and the integrity it is cached under. False on no path or a failed explode; throws on a corrupt gzip.

Parameters

ParameterTypeDefault value
pathundefined | stringundefined
inputEventEmitterprocess.stdin
store?stringundefined

Returns

Promise<boolean>


PreviousReferenceNext@vltpkg/cli-sdk

On this page

  • Variables
  • __CODE_SPLIT_SCRIPT_NAME
  • Functions
  • default()

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