Class FetchFS`Internal`

A simple filesystem backed by HTTP using the fetch API.

Hierarchy (View Summary)

IndexFS
- FetchFS

Constructors

constructor

new FetchFS(
    index: Index,
    baseUrl: string,
    requestInit?: RequestInit,
    remoteWrite?: boolean,
): FetchFS
Parameters
- index: Index
- baseUrl: string
- requestInit: RequestInit = {}
- OptionalremoteWrite: boolean
Returns FetchFS
Overrides IndexFS.constructor
- Defined in src/backends/fetch.ts:79

Properties

`Protected` `Optional` `Internal`_mountPoint

_mountPoint?: string

The last place this file system was mounted

`Readonly`attributes

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

See

FileSystemAttributes

`Protected`baseUrl

baseUrl: string

`Readonly`id

id: number

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

`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

`Protected` `Optional`remoteWrite

remoteWrite?: boolean

`Protected`requestInit

requestInit: RequestInit = {}

Methods

`Protected`_async

_async(p: Promise<unknown>): void
Parameters
- p: Promise<unknown>
Returns void
- Defined in src/backends/fetch.ts:75

`Protected`_remove

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

`Protected`create

create(path: string, options: PureCreationOptions): Inode
Parameters
- path: string
- options: PureCreationOptions
Returns Inode
Inherited from IndexFS.create
- Defined in src/internal/index_fs.ts:147

createFile

createFile(
    path: string,
    flag: string,
    mode: number,
    options: CreationOptions,
): Promise<File<FileSystem>>
Create the file at path with the given options. Then, open it with flag.
Parameters
- path: string
- flag: string
- mode: number
- options: CreationOptions
Returns Promise<File<FileSystem>>
Inherited from IndexFS.createFile
- Defined in src/internal/index_fs.ts:170

createFileSync

createFileSync(
    path: string,
    flag: string,
    mode: number,
    options: CreationOptions,
): File
Create the file at path with the given options. Then, open it with flag.
Parameters
- path: string
- flag: string
- mode: number
- options: CreationOptions
Returns File
Inherited from IndexFS.createFileSync
- Defined in src/internal/index_fs.ts:175

exists

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

existsSync

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

link

link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Inherited from IndexFS.link
- Defined in src/internal/index_fs.ts:188

linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Inherited from IndexFS.linkSync
- Defined in src/internal/index_fs.ts:192

metadata

metadata(): FileSystemMetadata
Get metadata about the current file system

Returns FileSystemMetadata
Deprecated
Inherited from IndexFS.metadata
- Defined in src/internal/filesystem.ts:240

mkdir

mkdir(path: string, mode: number, options: CreationOptions): Promise<void>
Parameters
- path: string
- mode: number
- options: CreationOptions
Returns Promise<void>
Inherited from IndexFS.mkdir
- Defined in src/internal/index_fs.ts:180

mkdirSync

mkdirSync(path: string, mode: number, options: CreationOptions): void
Parameters
- path: string
- mode: number
- options: CreationOptions
Returns void
Inherited from IndexFS.mkdirSync
- Defined in src/internal/index_fs.ts:184

openFile

openFile(path: string, flag: string): Promise<File<FileSystem>>
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<FileSystem>>
Inherited from IndexFS.openFile
- Defined in src/internal/index_fs.ts:105

openFileSync

openFileSync(path: string, flag: string): 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 File
Inherited from IndexFS.openFileSync
- Defined in src/internal/index_fs.ts:109

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 = 0
  The offset into the file to start reading from
- end: number
  The position in the file to stop reading
Returns Promise<void>
Overrides IndexFS.read
- Defined in src/backends/fetch.ts:96

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Inherited from IndexFS.readdir
- Defined in src/internal/index_fs.ts:196

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Inherited from IndexFS.readdirSync
- Defined in src/internal/index_fs.ts:200

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 = 0
  The offset into the file to start reading from
- end: number
  The position in the file to stop reading
Returns void
Overrides IndexFS.readSync
- Defined in src/backends/fetch.ts:112

ready

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

reloadFiles

reloadFiles(): never
Returns never
Deprecated
Inherited from IndexFS.reloadFiles
- Defined in src/internal/index_fs.ts:40

reloadFilesSync

reloadFilesSync(): never
Returns never
Deprecated
Inherited from IndexFS.reloadFilesSync
- Defined in src/internal/index_fs.ts:47

`Protected`remove

remove(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides IndexFS.remove
- Defined in src/backends/fetch.ts:88

`Protected`removeSync

removeSync(path: string): void
Parameters
- path: string
Returns void
Overrides IndexFS.removeSync
- Defined in src/backends/fetch.ts:92

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Inherited from IndexFS.rename
- Defined in src/internal/index_fs.ts:69

renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Inherited from IndexFS.renameSync
- Defined in src/internal/index_fs.ts:81

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from IndexFS.rmdir
- Defined in src/internal/index_fs.ts:137

rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Inherited from IndexFS.rmdirSync
- Defined in src/internal/index_fs.ts:142

stat

stat(path: string): Promise<Stats>
Parameters
- path: string
Returns Promise<Stats>
Inherited from IndexFS.stat
- Defined in src/internal/index_fs.ts:93

statSync

statSync(path: string): Stats
Parameters
- path: string
Returns Stats
Inherited from IndexFS.statSync
- Defined in src/internal/index_fs.ts:99

streamRead

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

streamWrite

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

sync

sync(
    path: string,
    data?: Uint8Array<ArrayBufferLike>,
    stats?: Readonly<InodeLike>,
): Promise<void>
Parameters
- path: string
- Optionaldata: Uint8Array<ArrayBufferLike>
- Optionalstats: Readonly<InodeLike>
Returns Promise<void>
Inherited from IndexFS.sync
- Defined in src/internal/index_fs.ts:209

`Protected` `Optional`syncMetadata

syncMetadata(path: string, metadata: Readonly<InodeLike>): Promise<void>
Optional hook for implementations to support updating metadata
Parameters
- path: string
- metadata: Readonly<InodeLike>
Returns Promise<void>
Inherited from IndexFS.syncMetadata
- Defined in src/internal/index_fs.ts:207

`Protected` `Optional`syncMetadataSync

syncMetadataSync(path: string, metadata: Readonly<InodeLike>): void
Optional hook for implementations to support updating metadata
Parameters
- path: string
- metadata: Readonly<InodeLike>
Returns void
Inherited from IndexFS.syncMetadataSync
- Defined in src/internal/index_fs.ts:219

syncSync

syncSync(
    path: string,
    data?: Uint8Array<ArrayBufferLike>,
    stats?: Readonly<InodeLike>,
): void
Parameters
- path: string
- Optionaldata: Uint8Array<ArrayBufferLike>
- Optionalstats: Readonly<InodeLike>
Returns void
Inherited from IndexFS.syncSync
- Defined in src/internal/index_fs.ts:221

toString

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

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from IndexFS.unlink
- Defined in src/internal/index_fs.ts:127

unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Inherited from IndexFS.unlinkSync
- Defined in src/internal/index_fs.ts:132

usage

usage(): UsageInfo
Experimental
Default implementation.

Returns UsageInfo
Todo
Implement
Inherited from IndexFS.usage
- Defined in src/internal/index_fs.ts:32

write

write(path: string, data: Uint8Array, offset: number): Promise<void>
Writes a buffer to a file
Parameters
- path: string
- data: Uint8Array
- offset: number
  The offset in the file to start writing
Returns Promise<void>
Overrides IndexFS.write
- Defined in src/backends/fetch.ts:130

writeSync

writeSync(path: string, data: Uint8Array, offset: number): void
Writes a buffer to a file
Parameters
- path: string
- data: Uint8Array
- offset: number
  The offset in the file to start writing
Returns void
Overrides IndexFS.writeSync
- Defined in src/backends/fetch.ts:139

Class FetchFSInternal

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FetchFS

Properties

Protected Optional Internal_mountPoint

Readonlyattributes

See

ProtectedbaseUrl

Readonlyid

Readonlyindex

Optionallabel

Readonlyname

Protected OptionalremoteWrite

ProtectedrequestInit

Methods

Protected_async

Parameters

Returns void

Protected_remove

Parameters

Returns void

Protectedcreate

Parameters

Returns Inode

createFile

Parameters

Returns Promise<File<FileSystem>>

createFileSync

Parameters

Returns File

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

metadata

Returns FileSystemMetadata

Deprecated

mkdir

Parameters

Returns Promise<void>

mkdirSync

Parameters

Returns void

openFile

Parameters

Returns Promise<File<FileSystem>>

openFileSync

Parameters

Returns File

read

Parameters

Returns Promise<void>

readdir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

readSync

Parameters

Returns void

ready

Returns Promise<void>

reloadFiles

Returns never

Class FetchFS`Internal`

`Protected` `Optional` `Internal`_mountPoint

`Readonly`attributes

`Protected`baseUrl

`Readonly`id

`Readonly`index

`Optional`label

`Readonly`name

`Protected` `Optional`remoteWrite

`Protected`requestInit

`Protected`_async

`Protected`_remove

`Protected`create

`Protected`remove

`Protected`removeSync

`Protected` `Optional`syncMetadata

`Protected` `Optional`syncMetadataSync