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 & FileSystem<this>
- ZipFS

Index

Constructors

constructor

new ZipFS<TBuffer extends ArrayBufferLike = ArrayBuffer>(
    label: string,
    data: ZipDataSource<TBuffer>,
    options: ZipOptions<TBuffer>,
): ZipFS<TBuffer>
Type Parameters
- TBuffer extends ArrayBufferLike = ArrayBuffer
Parameters
- label: string
- data: ZipDataSource<TBuffer>
- options: ZipOptions<TBuffer>
Returns ZipFS<TBuffer>
Overrides Readonly(FileSystem).constructor
- Defined in src/zip/fs.ts:161

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.

`Readonly`attributes

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

See

FileSystemAttributes

`Protected`data

data: ZipDataSource<TBuffer>

`Protected`directories

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

`Protected`eocd

eocd: Header<TBuffer>

`Protected`files

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

`Protected`inodes

inodes: Map<string, Inode> = ...

Inodes for each path.

Zip files do not have inodes, so they are created on demand and kept. This gives every file a stable, unique ino, which the VFS needs to tell files apart. Keeping them also means metadata changes are not lost, though this file system is read-only.

label

label: string

`Readonly`name

name: string

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

`Readonly` `Internal`options

options: ZipOptions<TBuffer>

`Readonly`type

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}`
Inherited from Readonly(FileSystem).uuid
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:150

Methods

createFile

createFile(path: string, flag: string, mode: number): Promise<never>
Parameters
- path: string
- flag: string
- mode: number
Returns Promise<never>
Inherited from Readonly(FileSystem).createFile
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:10
createFile(path: string, options: CreationOptions): Promise<InodeLike<number>>
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike<number>>
Inherited from Readonly(FileSystem).createFile
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:186

createFileSync

createFileSync(path: string, flag: string, mode: number): never
Parameters
- path: string
- flag: string
- mode: number
Returns never
Inherited from Readonly(FileSystem).createFileSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:11
createFileSync(path: string, options: CreationOptions): InodeLike
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Inherited from Readonly(FileSystem).createFileSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:190

exists

exists(path: string): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from Readonly(FileSystem).exists
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:202

existsSync

existsSync(path: string): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from Readonly(FileSystem).existsSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:206

`Protected`inodeFor

inodeFor(path: string, create: () => Partial<InodeLike>): Inode
Gets the inode for a path, creating it with create if it does not exist yet
Parameters
- path: string
- create: () => Partial<InodeLike>
Returns Inode
- Defined in src/zip/fs.ts:84

link

link(srcpath: string, dstpath: string): Promise<never>
Parameters
- srcpath: string
- dstpath: string
Returns Promise<never>
Inherited from Readonly(FileSystem).link
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:18
link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Inherited from Readonly(FileSystem).link
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:207

linkSync

linkSync(srcpath: string, dstpath: string): never
Parameters
- srcpath: string
- dstpath: string
Returns never
Inherited from Readonly(FileSystem).linkSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:19
linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Inherited from Readonly(FileSystem).linkSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:208

mkdir

mkdir(path: string, mode: number): Promise<never>
Parameters
- path: string
- mode: number
Returns Promise<never>
Inherited from Readonly(FileSystem).mkdir
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:16
mkdir(path: string, options: CreationOptions): Promise<InodeLike<number>>
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike<number>>
Inherited from Readonly(FileSystem).mkdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:195

mkdirSync

mkdirSync(path: string, mode: number): never
Parameters
- path: string
- mode: number
Returns never
Inherited from Readonly(FileSystem).mkdirSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:17
mkdirSync(path: string, options: CreationOptions): InodeLike
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Inherited from Readonly(FileSystem).mkdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:196

read

read(
    path: string,
    buffer: Uint8Array,
    offset: 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!
- offset: number
- end: number
  The position in the file to stop reading
Returns Promise<void>
Overrides Readonly(FileSystem).read
- Defined in src/zip/fs.ts:226

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides Readonly(FileSystem).readdir
- Defined in src/zip/fs.ts:206

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Overrides Readonly(FileSystem).readdirSync
- Defined in src/zip/fs.ts:216

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
Overrides Readonly(FileSystem).readSync
- Defined in src/zip/fs.ts:237

ready

ready(): Promise<void>
Returns Promise<void>
Overrides Readonly(FileSystem).ready
- Defined in src/zip/fs.ts:100

readySync

readySync(): void
Returns void
Inherited from Readonly(FileSystem).readySync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:174

rename

rename(oldPath: string, newPath: string): Promise<never>
Parameters
- oldPath: string
- newPath: string
Returns Promise<never>
Inherited from Readonly(FileSystem).rename
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:8
rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Inherited from Readonly(FileSystem).rename
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:175

renameSync

renameSync(oldPath: string, newPath: string): never
Parameters
- oldPath: string
- newPath: string
Returns never
Inherited from Readonly(FileSystem).renameSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:9
renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Inherited from Readonly(FileSystem).renameSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:176

rmdir

rmdir(path: string): Promise<never>
Parameters
- path: string
Returns Promise<never>
Inherited from Readonly(FileSystem).rmdir
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:14
rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from Readonly(FileSystem).rmdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:193

rmdirSync

rmdirSync(path: string): never
Parameters
- path: string
Returns never
Inherited from Readonly(FileSystem).rmdirSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:15
rmdirSync(path: string): void
Parameters
- path: string
Returns void
Inherited from Readonly(FileSystem).rmdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:194

stat

stat(path: string): Promise<Inode>
Parameters
- path: string
Returns Promise<Inode>
Overrides Readonly(FileSystem).stat
- Defined in src/zip/fs.ts:177

statSync

statSync(path: string): Inode
Parameters
- path: string
Returns Inode
Overrides Readonly(FileSystem).statSync
- Defined in src/zip/fs.ts:181

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from Readonly(FileSystem).streamRead
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:241

streamWrite

streamWrite(path: string, options: StreamOptions): WritableStream
Write a file using stream.
Parameters
- path: string
- options: StreamOptions
Returns WritableStream
Inherited from Readonly(FileSystem).streamWrite
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:246

sync

sync(): Promise<never>
Returns Promise<never>
Inherited from Readonly(FileSystem).sync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:22
sync(): Promise<void>
Returns Promise<void>
Inherited from Readonly(FileSystem).sync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:209

syncSync

syncSync(): never
Returns never
Inherited from Readonly(FileSystem).syncSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:23
syncSync(): void
Returns void
Inherited from Readonly(FileSystem).syncSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:210

toString

toString(): string
Returns string
Inherited from Readonly(FileSystem).toString
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:166

touch

touch(path: string, metadata: Readonly<InodeLike>): Promise<never>
Parameters
- path: string
- metadata: Readonly<InodeLike>
Returns Promise<never>
Inherited from Readonly(FileSystem).touch
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:20
touch(path: string, metadata: Partial<InodeLike>): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns Promise<void>
Inherited from Readonly(FileSystem).touch
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:180

touchSync

touchSync(path: string, metadata: Readonly<InodeLike>): never
Parameters
- path: string
- metadata: Readonly<InodeLike>
Returns never
Inherited from Readonly(FileSystem).touchSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:21
touchSync(path: string, metadata: Partial<InodeLike>): void
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns void
Inherited from Readonly(FileSystem).touchSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:182

unlink

unlink(path: string): Promise<never>
Parameters
- path: string
Returns Promise<never>
Inherited from Readonly(FileSystem).unlink
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:12
unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from Readonly(FileSystem).unlink
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:191

unlinkSync

unlinkSync(path: string): never
Parameters
- path: string
Returns never
Inherited from Readonly(FileSystem).unlinkSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:13
unlinkSync(path: string): void
Parameters
- path: string
Returns void
Inherited from Readonly(FileSystem).unlinkSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:192

usage

usage(): UsageInfo
Experimental
Default implementation.

Returns UsageInfo

Todo
Implement
Overrides Readonly(FileSystem).usage
- Defined in src/zip/fs.ts:170

write

write(path: string, buffer: Uint8Array, offset: number): Promise<never>
Parameters
- path: string
- buffer: Uint8Array
- offset: number
Returns Promise<never>
Inherited from Readonly(FileSystem).write
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:24
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>
Inherited from Readonly(FileSystem).write
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:230

writeSync

writeSync(path: string, buffer: Uint8Array, offset: number): never
Parameters
- path: string
- buffer: Uint8Array
- offset: number
Returns never
Inherited from Readonly(FileSystem).writeSync
- Defined in node_modules/@zenfs/core/dist/mixins/readonly.d.ts:25
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
Inherited from Readonly(FileSystem).writeSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:236

Class ZipFS<TBuffer>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZipFS<TBuffer>

Properties

Protected Optional Internal_mountPoint

Protected_time

Protected Internal_uuid

Readonlyattributes

See

Protecteddata

Protecteddirectories

Protectedeocd

Protectedfiles

Protectedinodes

label

Readonlyname

Readonly Internaloptions

Readonlytype

Accessors

uuid

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

Methods

createFile

Parameters

Returns Promise<never>

Parameters

Returns Promise<InodeLike<number>>

createFileSync

Parameters

Returns never

Parameters

Returns InodeLike

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

ProtectedinodeFor

Parameters

Returns Inode

link

Parameters

Returns Promise<never>

Parameters

Returns Promise<void>

linkSync

Parameters

Returns never

Parameters

Returns void

mkdir

Parameters

Returns Promise<never>

Parameters

Returns Promise<InodeLike<number>>

mkdirSync

Parameters

Returns never

Parameters

Returns InodeLike

read

Parameters

Returns Promise<void>

readdir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

`Protected` `Optional` `Internal`_mountPoint

`Protected`_time

`Protected` `Internal`_uuid

`Readonly`attributes

`Protected`data

`Protected`directories

`Protected`eocd

`Protected`files

`Protected`inodes

`Readonly`name

`Readonly` `Internal`options

`Readonly`type

`Protected`inodeFor