unpack

Type Aliases

FileEntry

type FileEntry = object;

Defined in: unpack.ts:93

A file parsed out of a tarball, at its destination path.

Type declaration

Functions

checkFs()

function checkFs(
   h, 
   tarDir, 
   target): h is { path: string }

Defined in: unpack.ts:201

Parameters

Returns

h is { path: string }

storeLayout()

function storeLayout(tarData, dir): object

Defined in: unpack.ts:508

What a gzipped or raw tarball explodes to in the global store at dir: its sidecar index, files and package.json bin target paths. Same parsing and path safety as unpackSync. No IO. Throws if the tarball has no valid package.json.

Parameters

Returns

object

tmpName()

function tmpName(target): string

Defined in: unpack.ts:270

Sibling temp path used to build target before renaming it in.

Parameters

Returns

string

unpack()

function unpack(tarData, target): Promise<void>

Defined in: unpack.ts:238

Parameters

Returns

Promise<void>

unpackFileSync()

function unpackFileSync(
   file, 
   target, 
   offset): void

Defined in: unpack.ts:263

Unpack a tarball straight from a file on disk, skipping offset leading bytes. Used to extract from a cache entry in place, so the tarball never lands in the registry client's in-memory cache.

Parameters

Returns

void

unpackSync()

function unpackSync(tarData, target): void

Defined in: unpack.ts:253

Same as unpack, but blocking. Faster: the async writers pay a libuv round trip per file, which costs more than the IO itself.

Parameters

Returns

void

unpackToStoreSync()

function unpackToStoreSync(tarData, dir): object

Defined in: unpack.ts:570

Explode a gzipped or raw tarball into dir for the global store and return its sidecar index (see storeLayout), written straight into dir (which must not exist; the caller renames it into place). Same modes as unpackSync followed by reify's bin chmod. Throws, writing nothing, without a valid package.json. Removes dir on failure.

Parameters

Returns

object