Skip to content
nodepod

ExtractionOptions

Nodepod API

Nodepod API / src / npm / ExtractionOptions

Interface: ExtractionOptions

Section titled “Interface: ExtractionOptions”

Defined in: src/packages/archive-extractor.ts:58

Properties

Section titled “Properties”

expectedIntegrity?

Section titled “expectedIntegrity?”

optional expectedIntegrity?: string

Defined in: src/packages/archive-extractor.ts:66

npm lockfile SRI, e.g. sha512-<base64> — verified on main after download

expectedShasum?

Section titled “expectedShasum?”

optional expectedShasum?: string

Defined in: src/packages/archive-extractor.ts:64

expected sha1 hex from the npm registry, checked after download

filter?

Section titled “filter?”

optional filter?: (entryPath) => boolean

Defined in: src/packages/archive-extractor.ts:61

Parameters

Section titled “Parameters”
entryPath
Section titled “entryPath”

string

Returns

Section titled “Returns”

boolean

onFile?

Section titled “onFile?”

optional onFile?: (relativePath, data) => void

Defined in: src/packages/archive-extractor.ts:70

Sees every extracted file (path relative to the package) as it is written.

Parameters

Section titled “Parameters”
relativePath
Section titled “relativePath”

string

data
Section titled “data”

string | Uint8Array<ArrayBufferLike>

Returns

Section titled “Returns”

void

onProgress?

Section titled “onProgress?”

optional onProgress?: (msg) => void

Defined in: src/packages/archive-extractor.ts:62

Parameters

Section titled “Parameters”
msg
Section titled “msg”

string

Returns

Section titled “Returns”

void

profiler?

Section titled “profiler?”

optional profiler?: NodepodProfilerImpl | null

Defined in: src/packages/archive-extractor.ts:68

Internal opt-in profiler hook. Omitted on the default path.

stripComponents?

Section titled “stripComponents?”

optional stripComponents?: number

Defined in: src/packages/archive-extractor.ts:60