Class ZipFS

Zip file-backed filesystem Implemented according to the standard: http://pkware.com/documents/casestudies/APPNOTE.TXT

While there are a few zip libraries for JavaScript (e.g. JSZip and zip.js), they are not a good match for ZenFS. In particular, these libraries perform a lot of unneeded data copying, and eagerly decompress every file in the zip file upon loading to check the CRC32. They also eagerly decode strings. Furthermore, these libraries duplicate functionality already present in ZenFS (e.g. UTF-8 decoding and binary data manipulation).

When the filesystem is instantiated, we determine the directory structure of the zip file as quickly as possible. We lazily decompress and check the CRC32 of files. We do not cache decompressed files; if this is a desired feature, it is best implemented as a generic file system wrapper that can cache data from arbitrary file systems.

Current limitations:

  • No encryption.
  • No ZIP64 support.
  • Read-only. Write support would require that we:
    • Keep track of changed/new files.
    • Compress changed files, and generate appropriate metadata for each.
    • Update file offsets for other files in the zip file.
    • Stream it out to a location. This isn't that bad, so we might do this at a later date.

Hierarchy

  • {
        createFile(path: string, flag: string, mode: number): Promise<File>;
        createFileSync(path: string, flag: string, mode: number): File;
        link(srcpath: string, dstpath: string): Promise<void>;
        linkSync(srcpath: string, dstpath: string): void;
        metadata(): FileSystemMetadata;
        mkdir(path: string, mode: number): Promise<void>;
        mkdirSync(path: string, mode: number): void;
        rename(oldPath: string, newPath: string): Promise<void>;
        renameSync(oldPath: string, newPath: string): void;
        rmdir(path: string): Promise<void>;
        rmdirSync(path: string): void;
        sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
        syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
        unlink(path: string): Promise<void>;
        unlinkSync(path: string): void;
    } & ExtractProperties<FileSystem, ((...args: any[]) => Promise<unknown>)> & FileSystem<this>
    • ZipFS

Constructors

constructor

Properties

_disableSync? _time data directories eocd files name

Accessors

endOfCentralDirectory numberOfCentralDirectoryEntries

Methods

createFile createFileSync exists existsSync link linkSync metadata mkdir mkdirSync openFile openFileSync readdir readdirSync ready rename renameSync rmdir rmdirSync stat statSync sync syncSync unlink unlinkSync computeEOCD

Constructors

constructor

  • new ZipFS(name, data): ZipFS

  • Parameters

    • name: string
    • data: ArrayBufferLike

    Returns ZipFS

Properties

Protected Optional Internal_disableSync

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

Protected_time

_time: number = ...

Protecteddata

data: ArrayBufferLike

Protecteddirectories

directories: Map<string, Set<string>> = ...

Readonlyeocd

eocd: Header

Protectedfiles

files: Map<string, FileEntry> = ...

Readonlyname

name: string

Accessors

endOfCentralDirectory

numberOfCentralDirectoryEntries

  • get numberOfCentralDirectoryEntries(): number

  • Returns number

Methods

createFile

  • createFile(path, flag, mode): Promise<File>

  • Parameters

    • path: string
    • flag: string
    • mode: number

    Returns Promise<File>

createFileSync

  • createFileSync(path, flag, mode): File

  • Parameters

    • path: string
    • flag: string
    • mode: number

    Returns File

exists

  • exists(path): Promise<boolean>

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns Promise<boolean>

existsSync

  • existsSync(path): boolean

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns boolean

link

  • link(srcpath, dstpath): Promise<void>

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns Promise<void>

linkSync

  • linkSync(srcpath, dstpath): void

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

metadata

  • metadata(): FileSystemMetadata

  • Get metadata about the current file system

    Returns FileSystemMetadata

mkdir

  • mkdir(path, mode): Promise<void>

  • Parameters

    • path: string
    • mode: number

    Returns Promise<void>

mkdirSync

  • mkdirSync(path, mode): void

  • Parameters

    • path: string
    • mode: number

    Returns void

AbstractopenFile

  • openFile(path, flag): Promise<File>

  • Opens the file at path with flag. The file must exist.

    Parameters

    • path: string

      The path to open.

    • flag: string

      The flag to use when opening the file.

    Returns Promise<File>

openFileSync

  • openFileSync(path, flag): NoSyncFile<ZipFS>

  • Opens the file at path with flag. The file must exist.

    Parameters

    • path: string

      The path to open.

    • flag: string

      The flag to use when opening the file.

    Returns NoSyncFile<ZipFS>

Abstractreaddir

  • readdir(path): Promise<string[]>

  • Parameters

    • path: string

    Returns Promise<string[]>

readdirSync

  • readdirSync(path): string[]

  • Parameters

    • path: string

    Returns string[]

ready

  • ready(): Promise<void>

  • Returns Promise<void>

rename

  • rename(oldPath, newPath): Promise<void>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

renameSync

  • renameSync(oldPath, newPath): void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

rmdirSync

  • rmdirSync(path): void

  • Parameters

    • path: string

    Returns void

Abstractstat

  • stat(path): Promise<Stats>

  • Parameters

    • path: string

    Returns Promise<Stats>

statSync

  • statSync(path): Stats

  • Parameters

    • path: string

    Returns Stats

sync

  • sync(path, data, stats): Promise<void>

  • Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns Promise<void>

syncSync

  • syncSync(path, data, stats): void

  • Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns void

unlink

  • unlink(path): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

unlinkSync

  • unlinkSync(path): void

  • Parameters

    • path: string

    Returns void

Protected StaticcomputeEOCD

  • computeEOCD(data): Header

  • Locates the end of central directory record at the end of the file. Throws an exception if it cannot be found.

    Parameters

    • data: ArrayBufferLike

    Returns Header

    Remarks

    Unfortunately, the comment is variable size and up to 64K in size. We assume that the magic signature does not appear in the comment, and in the bytes between the comment and the signature. Other ZIP implementations make this same assumption, since the alternative is to read thread every entry in the file.

    Offsets in this function are negative (i.e. from the end of the file).

    There is no byte alignment on the comment

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods