vlt / docs

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

index

Functions

register()

TypeScript
function register(
   path, 
   key, 
   store?, 
   integrity?): void

Defined in: index.ts:23

Queue the cache entry at key in the cache folder path for the background child. Pass the global store root as store to also explode it there (only when VLT_STORE_LINKER enables the store), and the tarball's integrity if its entry may only be cached under that.

Parameters

ParameterType
pathstring
keystring
store?string
integrity?`sha512-${string}`

Returns

void


Previous@vltpkg/cache-unzipNextReference

On this page

  • Functions
  • register()

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