Class IndexFS`Abstract` `Internal`

A file system that uses an Index for metadata.

Hierarchy (View Summary)

FileSystem
- IndexFS
  - FetchFS

Index

Constructors

constructor

new IndexFS(id: number, name: string, index?: Index): IndexFS
Parameters
- id: number
- name: string
- index: Index = ...
Returns IndexFS
Overrides FileSystem.constructor
- Defined in src/internal/index_fs.ts:23

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,
    undefined
    | void
    | CaseFold,
> & Map<string, any> = ...

See

FileSystemAttributes

`Readonly`index

index: Index = ...

`Optional`label

label?: string

`Readonly`name

name: string

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

`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 FileSystem.uuid
- Defined in src/internal/filesystem.ts:168

Methods

`Protected` `Optional`_mkdir

_mkdir?(path: string, options: CreationOptions): Promise<void>
Parameters
- path: string
- options: CreationOptions
Returns Promise<void>
- Defined in src/internal/index_fs.ts:186

`Protected` `Optional`_mkdirSync

_mkdirSync?(path: string, options: CreationOptions): void
Parameters
- path: string
- options: CreationOptions
Returns void
- Defined in src/internal/index_fs.ts:187

`Protected`_remove

_remove(path: string, isUnlink: boolean): void
Parameters
- path: string
- isUnlink: boolean
Returns void
- Defined in src/internal/index_fs.ts:117

`Protected`create

create(path: string, options: CreationOptions): Inode
Parameters
- path: string
- options: CreationOptions
Returns Inode
- Defined in src/internal/index_fs.ts:154

createFile

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>>
Overrides FileSystem.createFile
- Defined in src/internal/index_fs.ts:176

createFileSync

createFileSync(path: string, options: CreationOptions): InodeLike
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Overrides FileSystem.createFileSync
- Defined in src/internal/index_fs.ts:181

exists

exists(path: string): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from FileSystem.exists
- Defined in src/internal/filesystem.ts:251

existsSync

existsSync(path: string): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from FileSystem.existsSync
- Defined in src/internal/filesystem.ts:263

link

link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Overrides FileSystem.link
- Defined in src/internal/index_fs.ts:203

linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Overrides FileSystem.linkSync
- Defined in src/internal/index_fs.ts:207

mkdir

mkdir(path: string, options: CreationOptions): Promise<InodeLike<number>>
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike<number>>
Overrides FileSystem.mkdir
- Defined in src/internal/index_fs.ts:189

mkdirSync

mkdirSync(path: string, options: CreationOptions): InodeLike
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Overrides FileSystem.mkdirSync
- Defined in src/internal/index_fs.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 FileSystem.read
- Defined in src/internal/filesystem.ts:284

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides FileSystem.readdir
- Defined in src/internal/index_fs.ts:211

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Overrides FileSystem.readdirSync
- Defined in src/internal/index_fs.ts:215

`Abstract`readSync

readSync(path: string, buffer: Uint8Array, start: 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!
- start: number
  The offset into the file to start reading from
- end: number
  The position in the file to stop reading
Returns void
Inherited from FileSystem.readSync
- Defined in src/internal/filesystem.ts:291

ready

ready(): Promise<void>
Returns Promise<void>
Inherited from FileSystem.ready
- Defined in src/internal/filesystem.ts:210

`Protected` `Abstract`remove

remove(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in src/internal/index_fs.ts:126

`Protected` `Abstract`removeSync

removeSync(path: string): void
Parameters
- path: string
Returns void
- Defined in src/internal/index_fs.ts:127

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Overrides FileSystem.rename
- Defined in src/internal/index_fs.ts:53

renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Overrides FileSystem.renameSync
- Defined in src/internal/index_fs.ts:74

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.rmdir
- Defined in src/internal/index_fs.ts:139

rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Overrides FileSystem.rmdirSync
- Defined in src/internal/index_fs.ts:147

stat

stat(path: string): Promise<Inode>
Parameters
- path: string
Returns Promise<Inode>
Overrides FileSystem.stat
- Defined in src/internal/index_fs.ts:95

statSync

statSync(path: string): Inode
Parameters
- path: string
Returns Inode
Overrides FileSystem.statSync
- Defined in src/internal/index_fs.ts:101

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from FileSystem.streamRead
- Defined in src/internal/filesystem.ts:311

streamWrite

streamWrite(path: string, options: StreamOptions): WritableStream
Write a file using stream.
Parameters
- path: string
- options: StreamOptions
Returns WritableStream
Inherited from FileSystem.streamWrite
- Defined in src/internal/filesystem.ts:334

sync

sync(): Promise<void>
Returns Promise<void>
Overrides FileSystem.sync
- Defined in src/internal/index_fs.ts:219

syncSync

syncSync(): void
Returns void
Overrides FileSystem.syncSync
- Defined in src/internal/index_fs.ts:221

toString

toString(): string
Returns string
Inherited from FileSystem.toString
- Defined in src/internal/filesystem.ts:194

touch

touch(path: string, metadata: InodeLike): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: InodeLike
Returns Promise<void>
Overrides FileSystem.touch
- Defined in src/internal/index_fs.ts:107

touchSync

touchSync(path: string, metadata: InodeLike): void
Modify metadata.
Parameters
- path: string
- metadata: InodeLike
Returns void
Overrides FileSystem.touchSync
- Defined in src/internal/index_fs.ts:112

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.unlink
- Defined in src/internal/index_fs.ts:129

unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Overrides FileSystem.unlinkSync
- Defined in src/internal/index_fs.ts:134

usage

usage(): UsageInfo
Experimental
Default implementation.

Returns UsageInfo
Todo
Implement
Overrides FileSystem.usage
- Defined in src/internal/index_fs.ts:31

`Abstract`write

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 FileSystem.write
- Defined in src/internal/filesystem.ts:298

`Abstract`writeSync

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 FileSystem.writeSync
- Defined in src/internal/filesystem.ts:305

Class IndexFSAbstract Internal

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns IndexFS

Properties

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

Readonlyindex

Optionallabel

Readonlyname

Readonlytype

Accessors

uuid

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

Methods

Protected Optional_mkdir

Parameters

Returns Promise<void>

Protected Optional_mkdirSync

Parameters

Returns void

Protected_remove

Parameters

Returns void

Protectedcreate

Parameters

Returns Inode

createFile

Parameters

Returns Promise<InodeLike<number>>

createFileSync

Parameters

Returns InodeLike

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

mkdir

Parameters

Returns Promise<InodeLike<number>>

mkdirSync

Parameters

Returns InodeLike

Abstractread

Parameters

Returns Promise<void>

readdir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

AbstractreadSync

Parameters

Returns void

ready

Returns Promise<void>

Protected Abstractremove

Parameters

Returns Promise<void>

Protected AbstractremoveSync

Parameters

Returns void

Class IndexFS`Abstract` `Internal`

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Readonly`index

`Optional`label

`Readonly`name

`Readonly`type

`Protected` `Optional`_mkdir

`Protected` `Optional`_mkdirSync

`Protected`_remove

`Protected`create

`Abstract`read

`Abstract`readSync

`Protected` `Abstract`remove

`Protected` `Abstract`removeSync

`Abstract`write

`Abstract`writeSync