Class FetchFS

A simple filesystem backed by HTTP using the fetch API.

Index objects look like the following:

{
	"version": 1,
	"entries": {
		"/home": { ... },
		"/home/jvilk": { ... },
		"/home/james": { ... }
	}
}

Each entry contains the stats associated with the file.

Hierarchy (view full)

IndexFS
- FetchFS

Constructors

constructor

new FetchFS(__namedParameters): FetchFS
Parameters
- __namedParameters: FetchOptions
Returns FetchFS
Overrides IndexFS.constructor
- Defined in src/backends/fetch.ts:103

Properties

`Protected` `Optional` `Internal`_disableSync

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

`Protected`_isInitialized

_isInitialized: boolean = false

`Readonly`baseUrl

baseUrl: string

`Protected`index

index: Index = ...

`Optional` `Readonly`requestInit

requestInit?: RequestInit

Methods

createFile

createFile(path, flag, mode): Promise<File<FileSystem>>
Parameters
- path: string
- flag: string
- mode: number
Returns Promise<File<FileSystem>>
Inherited from IndexFS.createFile
- Defined in src/mixins/readonly.ts:19

createFileSync

createFileSync(path, flag, mode): File<FileSystem>
Parameters
- path: string
- flag: string
- mode: number
Returns File<FileSystem>
Inherited from IndexFS.createFileSync
- Defined in src/mixins/readonly.ts:20

exists

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

existsSync

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

`Protected`getData

getData(path, stats): Promise<Uint8Array>
Parameters
- path: string
- stats: Stats
Returns Promise<Uint8Array>
Todo
Be lazier about actually requesting the data?
Overrides IndexFS.getData
- Defined in src/backends/fetch.ts:141

`Protected`getDataSync

getDataSync(path, stats): Uint8Array
Parameters
- path: string
- stats: Stats
Returns Uint8Array
Overrides IndexFS.getDataSync
- Defined in src/backends/fetch.ts:151

link

link(srcpath, dstpath): Promise<void>
Parameters
- srcpath: string
- dstpath: string
Returns Promise<void>
Inherited from IndexFS.link
- Defined in src/mixins/readonly.ts:27

linkSync

linkSync(srcpath, dstpath): void
Parameters
- srcpath: string
- dstpath: string
Returns void
Inherited from IndexFS.linkSync
- Defined in src/mixins/readonly.ts:28

metadata

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

Returns FileSystemMetadata
Overrides IndexFS.metadata
- Defined in src/backends/fetch.ts:115

mkdir

mkdir(path, mode): Promise<void>
Parameters
- path: string
- mode: number
Returns Promise<void>
Inherited from IndexFS.mkdir
- Defined in src/mixins/readonly.ts:25

mkdirSync

mkdirSync(path, mode): void
Parameters
- path: string
- mode: number
Returns void
Inherited from IndexFS.mkdirSync
- Defined in src/mixins/readonly.ts:26

openFile

openFile(path, flag): Promise<NoSyncFile<FetchFS>>
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<NoSyncFile<FetchFS>>
Inherited from IndexFS.openFile
- Defined in src/backends/file_index.ts:151

openFileSync

openFileSync(path, flag): NoSyncFile<FetchFS>
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 NoSyncFile<FetchFS>
Inherited from IndexFS.openFileSync
- Defined in src/backends/file_index.ts:167

preload

preload(path, buffer): void
Preload the path into the index.
Parameters
- path: string
- buffer: Uint8Array
Returns void
- Defined in src/backends/fetch.ts:126

readdir

readdir(path): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Inherited from IndexFS.readdir
- Defined in src/backends/file_index.ts:183

readdirSync

readdirSync(path): string[]
Parameters
- path: string
Returns string[]
Inherited from IndexFS.readdirSync
- Defined in src/backends/file_index.ts:187

ready

ready(): Promise<void>
Returns Promise<void>
Overrides IndexFS.ready
- Defined in src/backends/fetch.ts:85

reloadFiles

reloadFiles(): Promise<void>
Returns Promise<void>
Inherited from IndexFS.reloadFiles
- Defined in src/backends/file_index.ts:125

reloadFilesSync

reloadFilesSync(): void
Returns void
Inherited from IndexFS.reloadFilesSync
- Defined in src/backends/file_index.ts:132

rename

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

renameSync

renameSync(oldPath, newPath): void
Parameters
- oldPath: string
- newPath: string
Returns void
Inherited from IndexFS.renameSync
- Defined in src/mixins/readonly.ts:18

rmdir

rmdir(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from IndexFS.rmdir
- Defined in src/mixins/readonly.ts:23

rmdirSync

rmdirSync(path): void
Parameters
- path: string
Returns void
Inherited from IndexFS.rmdirSync
- Defined in src/mixins/readonly.ts:24

stat

stat(path): Promise<Stats>
Parameters
- path: string
Returns Promise<Stats>
Inherited from IndexFS.stat
- Defined in src/backends/file_index.ts:139

statSync

statSync(path): Stats
Parameters
- path: string
Returns Stats
Inherited from IndexFS.statSync
- Defined in src/backends/file_index.ts:143

sync

sync(path, data, stats): Promise<void>
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns Promise<void>
Inherited from IndexFS.sync
- Defined in src/mixins/readonly.ts:29

syncSync

syncSync(path, data, stats): void
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns void
Inherited from IndexFS.syncSync
- Defined in src/mixins/readonly.ts:30

unlink

unlink(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from IndexFS.unlink
- Defined in src/mixins/readonly.ts:21

unlinkSync

unlinkSync(path): void
Parameters
- path: string
Returns void
Inherited from IndexFS.unlinkSync
- Defined in src/mixins/readonly.ts:22

Class FetchFS

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FetchFS

Properties

Protected Optional Internal_disableSync

Protected_isInitialized

ReadonlybaseUrl

Protectedindex

Optional ReadonlyrequestInit

Methods

createFile

Parameters

Returns Promise<File<FileSystem>>

createFileSync

Parameters

Returns File<FileSystem>

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

ProtectedgetData

Parameters

Returns Promise<Uint8Array>

Todo

ProtectedgetDataSync

Parameters

Returns Uint8Array

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

metadata

Returns FileSystemMetadata

mkdir

Parameters

Returns Promise<void>

mkdirSync

Parameters

Returns void

openFile

Parameters

Returns Promise<NoSyncFile<FetchFS>>

openFileSync

Parameters

Returns NoSyncFile<FetchFS>

preload

Parameters

Returns void

readdir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

ready

Returns Promise<void>

reloadFiles

Returns Promise<void>

reloadFilesSync

Returns void

rename

Parameters

Returns Promise<void>

renameSync

Parameters

Returns void

rmdir

Parameters

Returns Promise<void>

`Protected` `Optional` `Internal`_disableSync

`Protected`_isInitialized

`Readonly`baseUrl

`Protected`index

`Optional` `Readonly`requestInit

`Protected`getData

`Protected`getDataSync