Class IsoFS

Mounts an ISO file as a read-only file system.

Supports:

Vanilla ISO9660 ISOs
Microsoft Joliet and Rock Ridge extensions to the ISO9660 standard

Hierarchy

ReadonlyMixin & AsyncFSMethods<this> & FileSystem<this>
- IsoFS

Index

Constructors

constructor

new IsoFS(options: IsoOptions): IsoFS
Constructs a read-only file system from the given ISO.
Parameters
- options: IsoOptions
Returns IsoFS
Overrides Readonly(Sync(FileSystem)).constructor
- Defined in src/iso/fs.ts:70

Properties

`Protected` `Optional` `Internal`_mountPoint

_mountPoint?: string

The last place this file system was mounted

`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: Uint8Array

`Protected`inodes

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

Inodes for each path.

ISO images 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.

`Optional`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: IsoOptions

`Protected`pvd

pvd: PrimaryVolumeDescriptor

`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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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 ZipFS.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(Sync(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/iso/fs.ts:54

link

link(srcpath: string, dstpath: string): Promise<never>
Parameters
- srcpath: string
- dstpath: string
Returns Promise<never>
Inherited from Readonly(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(FileSystem)).mkdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:196

`Abstract`read

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

`Abstract`readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Inherited from Readonly(Sync(FileSystem)).readdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:197

readdirSync

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

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(Sync(FileSystem)).readSync
- Defined in src/iso/fs.ts:144

ready

ready(): Promise<void>
Returns Promise<void>
Inherited from Readonly(Sync(FileSystem)).ready
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:173

readySync

readySync(): void
Returns void
Inherited from Readonly(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(FileSystem)).rmdirSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:194

`Abstract`stat

stat(path: string): Promise<InodeLike<number>>
Parameters
- path: string
Returns Promise<InodeLike<number>>
Inherited from Readonly(Sync(FileSystem)).stat
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:177

statSync

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

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from Readonly(Sync(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(Sync(FileSystem)).streamWrite
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:246

sync

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

syncSync

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

toString

toString(): string
Returns string
Inherited from Readonly(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(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(Sync(FileSystem)).usage
- Defined in src/iso/fs.ts:118

write

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

Class IsoFS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns IsoFS

Properties

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

Protecteddata

Protectedinodes

Optionallabel

Readonlyname

Readonly Internaloptions

Protectedpvd

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

Abstractread

Parameters

Returns Promise<void>

Abstractreaddir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

readSync

Parameters

Returns void

ready

Returns Promise<void>

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Protected`data

`Protected`inodes

`Optional`label

`Readonly`name

`Readonly` `Internal`options

`Protected`pvd

`Readonly`type

`Protected`inodeFor

`Abstract`read

`Abstract`readdir

`Abstract`stat