Skip to content

ExtractZipArchiveParams

Parameters for extractZipArchive.

Import:

import type { ExtractZipArchiveParams } from 'obsidian-dev-utils/desktop-zip-extractor';

Signature:

export interface ExtractZipArchiveParams

Properties

PropertyTypeDescription
archiveBufferThe raw ZIP archive bytes.
fileSystemZipExtractionFileSystemThe file-system implementation the extracted entries are written with.

Injected rather than imported so the caller chooses which fs writes the files. The demo-vault opener hands over Electron's original-fs (see ZipExtractionFileSystem).
targetDirectorystringThe directory to extract into. Created if it does not exist.

Links to this page: