Class ZipFS<TBuffer>

A file system backend by a zip file. 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.

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.

Type Parameters

  • TBuffer extends ArrayBufferLike = ArrayBuffer

Hierarchy

  • ReadonlyMixin & AsyncFSMethods & FileSystem<this>
    • ZipFS

Constructors

constructor

Properties

_mountPoint? _time _uuid attributes data directories eocd files label name type

Accessors

uuid

Methods

createFile createFileSync exists existsSync link linkSync mkdir mkdirSync read readdir readdirSync readSync ready rename renameSync rmdir rmdirSync stat statSync streamRead streamWrite sync syncSync toString touch touchSync unlink unlinkSync usage write writeSync

Constructors

constructor

  • new ZipFS<TBuffer extends ArrayBufferLike = ArrayBuffer>(
        label: string,
        data: Uint8Array<TBuffer>,
    ): ZipFS<TBuffer>

  • Type Parameters

    • TBuffer extends ArrayBufferLike = ArrayBuffer

    Parameters

    • label: string
    • data: Uint8Array<TBuffer>

    Returns ZipFS<TBuffer>

Properties

Protected Optional Internal_mountPoint

_mountPoint?: string

The last place this file system was mounted

Protected_time

_time: number = ...

Protected Internal_uuid

_uuid: `${string}-${string}-${string}-${string}-${string}`

The UUID of the file system.

Readonlyattributes

attributes: ConstMap<FileSystemAttributes, keyof FileSystemAttributes, void> & Map<
    string,
    any,
>

See

FileSystemAttributes

Protecteddata

data: Uint8Array<TBuffer>

Protecteddirectories

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

Protected Readonlyeocd

eocd: Header<TBuffer>

Protectedfiles

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

label

label: string

Readonlyname

name: string

The name for this file system. For example, tmpfs for an in memory one

Readonlytype

type: number

A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something

Accessors

uuid

  • get uuid(): `${string}-${string}-${string}-${string}-${string}`

  • Returns `${string}-${string}-${string}-${string}-${string}`

Methods

createFile

  • createFile(path: string, flag: string, mode: number): Promise<never>

  • Parameters

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

    Returns Promise<never>

  • createFile(path: string, options: CreationOptions): Promise<InodeLike>

  • Create the file at path with the given options.

    Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<InodeLike>

createFileSync

  • createFileSync(path: string, flag: string, mode: number): never

  • Parameters

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

    Returns never

  • createFileSync(path: string, options: CreationOptions): InodeLike

  • Create the file at path with the given options.

    Parameters

    • path: string
    • options: CreationOptions

    Returns InodeLike

exists

  • exists(path: string): Promise<boolean>

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns Promise<boolean>

existsSync

  • existsSync(path: string): boolean

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns boolean

link

  • link(srcpath: string, dstpath: string): Promise<never>

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns Promise<never>

  • link(target: string, link: string): Promise<void>

  • Parameters

    • target: string
    • link: string

    Returns Promise<void>

linkSync

  • linkSync(srcpath: string, dstpath: string): never

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns never

  • linkSync(target: string, link: string): void

  • Parameters

    • target: string
    • link: string

    Returns void

mkdir

  • mkdir(path: string, mode: number): Promise<never>

  • Parameters

    • path: string
    • mode: number

    Returns Promise<never>

  • mkdir(path: string, options: CreationOptions): Promise<InodeLike>

  • Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<InodeLike>

mkdirSync

  • mkdirSync(path: string, mode: number): never

  • Parameters

    • path: string
    • mode: number

    Returns never

  • mkdirSync(path: string, options: CreationOptions): InodeLike

  • Parameters

    • path: string
    • options: CreationOptions

    Returns InodeLike

Abstractread

  • read(
        path: string,
        buffer: Uint8Array,
        start: number,
        end: number,
    ): Promise<void>

  • Reads into a buffer

    Parameters

    • path: string
    • buffer: Uint8Array

      The buffer to read into. You must set the byteOffset and byteLength appropriately!

    • start: number

      The offset into the file to start reading from

    • end: number

      The position in the file to stop reading

    Returns Promise<void>

Abstractreaddir

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

  • Parameters

    • path: string

    Returns Promise<string[]>

readdirSync

  • readdirSync(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

readSync

  • readSync(path: string, buffer: Uint8Array, offset: number, end: number): void

  • Reads into a buffer

    Parameters

    • path: string
    • buffer: Uint8Array

      The buffer to read into. You must set the byteOffset and byteLength appropriately!

    • offset: number
    • end: number

      The position in the file to stop reading

    Returns void

ready

  • ready(): Promise<void>

  • Returns Promise<void>

rename

  • rename(oldPath: string, newPath: string): Promise<never>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<never>

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

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

renameSync

  • renameSync(oldPath: string, newPath: string): never

  • Parameters

    • oldPath: string
    • newPath: string

    Returns never

  • renameSync(oldPath: string, newPath: string): void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path: string): Promise<never>

  • Parameters

    • path: string

    Returns Promise<never>

  • rmdir(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

rmdirSync

  • rmdirSync(path: string): never

  • Parameters

    • path: string

    Returns never

  • rmdirSync(path: string): void

  • Parameters

    • path: string

    Returns void

Abstractstat

  • stat(path: string): Promise<InodeLike>

  • Parameters

    • path: string

    Returns Promise<InodeLike>

statSync

  • statSync(path: string): Inode

  • Parameters

    • path: string

    Returns Inode

streamRead

  • streamRead(path: string, options: StreamOptions): ReadableStream

  • Read a file using a stream.

    Parameters

    • path: string
    • options: StreamOptions

    Returns ReadableStream

streamWrite

  • streamWrite(path: string, options: StreamOptions): WritableStream

  • Write a file using stream.

    Parameters

    • path: string
    • options: StreamOptions

    Returns WritableStream

sync

  • sync(): Promise<never>

  • Returns Promise<never>

  • sync(): Promise<void>

  • Returns Promise<void>

syncSync

  • syncSync(): never

  • Returns never

  • syncSync(): void

  • Returns void

toString

  • toString(): string

  • Returns string

touch

  • touch(path: string, metadata: Readonly<InodeLike>): Promise<never>

  • Parameters

    • path: string
    • metadata: Readonly<InodeLike>

    Returns Promise<never>

  • touch(path: string, metadata: Partial<InodeLike>): Promise<void>

  • Modify metadata.

    Parameters

    • path: string
    • metadata: Partial<InodeLike>

    Returns Promise<void>

touchSync

  • touchSync(path: string, metadata: Readonly<InodeLike>): never

  • Parameters

    • path: string
    • metadata: Readonly<InodeLike>

    Returns never

  • touchSync(path: string, metadata: Partial<InodeLike>): void

  • Modify metadata.

    Parameters

    • path: string
    • metadata: Partial<InodeLike>

    Returns void

unlink

  • unlink(path: string): Promise<never>

  • Parameters

    • path: string

    Returns Promise<never>

  • unlink(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

unlinkSync

  • unlinkSync(path: string): never

  • Parameters

    • path: string

    Returns never

  • unlinkSync(path: string): void

  • Parameters

    • path: string

    Returns void

usage

  • usage(): UsageInfo
  • Experimental

    Default implementation.

    Returns UsageInfo

    Todo

    Implement

write

  • write(path: string, buffer: Uint8Array, offset: number): Promise<never>

  • Parameters

    • path: string
    • buffer: Uint8Array
    • offset: number

    Returns Promise<never>

  • write(path: string, buffer: Uint8Array, offset: number): Promise<void>

  • Writes a buffer to a file

    Parameters

    • path: string
    • buffer: Uint8Array

      The buffer to write. You must set the byteOffset and byteLength appropriately!

    • offset: number

      The offset in the file to start writing

    Returns Promise<void>

writeSync

  • writeSync(path: string, buffer: Uint8Array, offset: number): never

  • Parameters

    • path: string
    • buffer: Uint8Array
    • offset: number

    Returns never

  • writeSync(path: string, buffer: Uint8Array, offset: number): void

  • Writes a buffer to a file

    Parameters

    • path: string
    • buffer: Uint8Array

      The buffer to write. You must set the byteOffset and byteLength appropriately!

    • offset: number

      The offset in the file to start writing

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods