Class FetchFS

A simple filesystem backed by HTTP using the fetch API.

Index objects look like the following:

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

Each entry contains the stats associated with the file.

Hierarchy (View Summary)

StoreFS
- FetchFS

Constructors

constructor

new FetchFS(
    index?: string | IndexData,
    cache?: Store,
    baseUrl?: string,
    requestInit?: RequestInit,
): FetchFS
Parameters
- index: string | IndexData = 'index.json'
- cache: Store = ...
- baseUrl: string = ''
- OptionalrequestInit: RequestInit
Returns FetchFS
Overrides StoreFS.constructor
- Defined in src/backends/fetch.ts:117

Properties

`Protected` `Optional` `Internal`_disableSync

_disableSync?: boolean

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

`Protected`_initialized

_initialized: boolean = false

`Readonly`baseUrl

baseUrl: string = ''

`Optional` `Readonly`requestInit

requestInit?: RequestInit

`Protected` `Readonly`store

store: Store

Methods

`Protected`allocNew

allocNew(tx: Transaction<Store>, path: string, syscall: string): Promise<number>
Adds a new node under a random ID. Retries before giving up in the exceedingly unlikely chance that we try to reuse a random id.
Parameters
- tx: Transaction<Store>
- path: string
- syscall: string
Returns Promise<number>
Inherited from StoreFS.allocNew
- Defined in src/backends/store/fs.ts:575

`Protected`allocNewSync

allocNewSync(tx: Transaction<Store>, path: string, syscall: string): number
Creates a new node under a random ID. Retries before giving up in the exceedingly unlikely chance that we try to reuse a random id.
Parameters
- tx: Transaction<Store>
- path: string
- syscall: string
Returns number
The ino that the data was stored under.
Inherited from StoreFS.allocNewSync
- Defined in src/backends/store/fs.ts:591

checkRoot

checkRoot(): Promise<void>
Checks if the root directory exists. Creates it if it doesn't.

Returns Promise<void>
Inherited from StoreFS.checkRoot
- Defined in src/backends/store/fs.ts:457

checkRootSync

checkRootSync(): void
Checks if the root directory exists. Creates it if it doesn't.

Returns void
Inherited from StoreFS.checkRootSync
- Defined in src/backends/store/fs.ts:473

`Protected`commitNew

commitNew(
    path: string,
    type: FileType,
    options: PureCreationOptions,
    data: Uint8Array<ArrayBufferLike>,
    syscall: string,
): Promise<Inode>
Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.
Parameters
- path: string
  The path to the new file.
- type: FileType
  The type of the new file.
- options: PureCreationOptions
- data: Uint8Array<ArrayBufferLike>
  The data to store at the file's data node.
- syscall: string
Returns Promise<Inode>
Inherited from StoreFS.commitNew
- Defined in src/backends/store/fs.ts:610

`Protected`commitNewSync

commitNewSync(
    path: string,
    type: FileType,
    options: PureCreationOptions,
    data: Uint8Array<ArrayBufferLike>,
    syscall: string,
): Inode
Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.
Parameters
- path: string
  The path to the new file.
- type: FileType
  The type of the new file.
- options: PureCreationOptions
- data: Uint8Array<ArrayBufferLike>
  The data to store at the file's data node.
- syscall: string
Returns Inode
The Inode for the new file.
Inherited from StoreFS.commitNewSync
- Defined in src/backends/store/fs.ts:658

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 StoreFS.createFile
- Defined in src/backends/store/fs.ts:272

createFileSync

createFileSync(
    path: string,
    flag: string,
    mode: number,
    options: CreationOptions,
): 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 File<FileSystem>
Inherited from StoreFS.createFileSync
- Defined in src/backends/store/fs.ts:277

createIndex

createIndex(): Promise<Index>
Returns Promise<Index>
Inherited from StoreFS.createIndex
- Defined in src/backends/store/fs.ts:105

createIndexSync

createIndexSync(): Index
Returns Index
Inherited from StoreFS.createIndexSync
- Defined in src/backends/store/fs.ts:133

empty

empty(): Promise<void>
Delete all contents stored in the file system.

Returns Promise<void>
Deprecated
Inherited from StoreFS.empty
- Defined in src/backends/store/fs.ts:54

emptySync

emptySync(): void
Delete all contents stored in the file system.

Returns void
Deprecated
Inherited from StoreFS.emptySync
- Defined in src/backends/store/fs.ts:64

exists

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

existsSync

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

`Protected`findInodeSync

findInodeSync(
    tx: Transaction<Store>,
    path: string,
    syscall: string,
    visited?: Set<string>,
): Inode
Finds the Inode of path.
Parameters
- tx: Transaction<Store>
- path: string
  The path to look up.
- syscall: string
- visited: Set<string> = ...
Returns Inode
The Inode of the path p.

Todo
memoize/cache
Inherited from StoreFS.findInodeSync
- Defined in src/backends/store/fs.ts:566

link

link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Inherited from StoreFS.link
- Defined in src/backends/store/fs.ts:372

linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Inherited from StoreFS.linkSync
- Defined in src/backends/store/fs.ts:389

loadIndex

loadIndex(index: Index): Promise<void>
Load an index into the StoreFS. You must manually add non-directory files
Parameters
- index: Index
Returns Promise<void>
Inherited from StoreFS.loadIndex
- Defined in src/backends/store/fs.ts:75

loadIndexSync

loadIndexSync(index: Index): void
Load an index into the StoreFS. You must manually add non-directory files
Parameters
- index: Index
Returns void
Inherited from StoreFS.loadIndexSync
- Defined in src/backends/store/fs.ts:92

metadata

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

Returns FileSystemMetadata
Inherited from StoreFS.metadata
- Defined in src/backends/store/fs.ts:41

mkdir

mkdir(path: string, mode: number, options: CreationOptions): Promise<void>
Parameters
- path: string
- mode: number
- options: CreationOptions
Returns Promise<void>
Inherited from StoreFS.mkdir
- Defined in src/backends/store/fs.ts:320

mkdirSync

mkdirSync(path: string, mode: number, options: CreationOptions): void
Parameters
- path: string
- mode: number
- options: CreationOptions
Returns void
Inherited from StoreFS.mkdirSync
- Defined in src/backends/store/fs.ts:324

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 StoreFS.openFile
- Defined in src/backends/store/fs.ts:282

openFileSync

openFileSync(path: string, flag: string): 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 File<FileSystem>
Inherited from StoreFS.openFileSync
- Defined in src/backends/store/fs.ts:290

read

read(
    path: string,
    buffer: Uint8Array<ArrayBufferLike>,
    offset: number,
    end: number,
): Promise<void>
Reads into a buffer
Parameters
- path: string
- buffer: Uint8Array<ArrayBufferLike>
  The buffer to read into. You must set the byteOffset and byteLength appropriately!
- offset: 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 StoreFS.read
- Defined in src/backends/store/fs.ts:406

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Inherited from StoreFS.readdir
- Defined in src/backends/store/fs.ts:328

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Inherited from StoreFS.readdirSync
- Defined in src/backends/store/fs.ts:334

readSync

readSync(
    path: string,
    buffer: Uint8Array<ArrayBufferLike>,
    offset: number,
    end: number,
): void
Reads into a buffer
Parameters
- path: string
- buffer: Uint8Array<ArrayBufferLike>
  The buffer to read into. You must set the byteOffset and byteLength appropriately!
- offset: number
  The offset into the file to start reading from
- end: number
  The position in the file to stop reading
Returns void
Inherited from StoreFS.readSync
- Defined in src/backends/store/fs.ts:414

ready

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

`Protected`remove

remove(path: string, isDir: boolean, syscall: string): Promise<void>
Remove all traces of path from the file system.
Parameters
- path: string
  The path to remove from the file system.
- isDir: boolean
  Does the path belong to a directory, or a file?
- syscall: string
Returns Promise<void>
Todo
Update mtime.
Inherited from StoreFS.remove
- Defined in src/backends/store/fs.ts:703

`Protected`removeSync

removeSync(path: string, isDir: boolean, syscall: string): void
Remove all traces of path from the file system.
Parameters
- path: string
  The path to remove from the file system.
- isDir: boolean
  Does the path belong to a directory, or a file?
- syscall: string
Returns void
Todo
Update mtime.
Inherited from StoreFS.removeSync
- Defined in src/backends/store/fs.ts:744

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Todo
Make rename compatible with the cache.
Inherited from StoreFS.rename
- Defined in src/backends/store/fs.ts:164

renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Inherited from StoreFS.renameSync
- Defined in src/backends/store/fs.ts:213

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from StoreFS.rmdir
- Defined in src/backends/store/fs.ts:306

rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Inherited from StoreFS.rmdirSync
- Defined in src/backends/store/fs.ts:313

stat

stat(path: string): Promise<Stats>
Parameters
- path: string
Returns Promise<Stats>
Inherited from StoreFS.stat
- Defined in src/backends/store/fs.ts:262

statSync

statSync(path: string): Stats
Parameters
- path: string
Returns Stats
Inherited from StoreFS.statSync
- Defined in src/backends/store/fs.ts:267

sync

sync(
    path: string,
    data?: Uint8Array<ArrayBufferLike>,
    metadata?: Readonly<InodeLike>,
): Promise<void>
Updated the inode and data node at path
Parameters
- path: string
- Optionaldata: Uint8Array<ArrayBufferLike>
- Optionalmetadata: Readonly<InodeLike>
Returns Promise<void>
Todo
Ensure mtime updates properly, and use that to determine if a data update is required.
Inherited from StoreFS.sync
- Defined in src/backends/store/fs.ts:344

syncSync

syncSync(
    path: string,
    data?: Uint8Array<ArrayBufferLike>,
    metadata?: Readonly<InodeLike>,
): void
Updated the inode and data node at path
Parameters
- path: string
- Optionaldata: Uint8Array<ArrayBufferLike>
- Optionalmetadata: Readonly<InodeLike>
Returns void
Todo
Ensure mtime updates properly, and use that to determine if a data update is required.
Inherited from StoreFS.syncSync
- Defined in src/backends/store/fs.ts:360

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from StoreFS.unlink
- Defined in src/backends/store/fs.ts:298

unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Inherited from StoreFS.unlinkSync
- Defined in src/backends/store/fs.ts:302

write

write(
    path: string,
    data: Uint8Array<ArrayBufferLike>,
    offset: number,
): Promise<void>
Writes a buffer to a file
Parameters
- path: string
- data: Uint8Array<ArrayBufferLike>
- offset: number
  The offset in the file to start writing
Returns Promise<void>
Inherited from StoreFS.write
- Defined in src/backends/store/fs.ts:422

writeSync

writeSync(path: string, data: Uint8Array<ArrayBufferLike>, offset: number): void
Writes a buffer to a file
Parameters
- path: string
- data: Uint8Array<ArrayBufferLike>
- offset: number
  The offset in the file to start writing
Returns void
Inherited from StoreFS.writeSync
- Defined in src/backends/store/fs.ts:438

Class FetchFS

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FetchFS

Properties

Protected Optional Internal_disableSync

Protected_initialized

ReadonlybaseUrl

Optional ReadonlyrequestInit

Protected Readonlystore

Methods

ProtectedallocNew

Parameters

Returns Promise<number>

ProtectedallocNewSync

Parameters

Returns number

checkRoot

Returns Promise<void>

checkRootSync

Returns void

ProtectedcommitNew

Parameters

Returns Promise<Inode>

ProtectedcommitNewSync

Parameters

Returns Inode

createFile

Parameters

Returns Promise<File<FileSystem>>

createFileSync

Parameters

Returns File<FileSystem>

createIndex

Returns Promise<Index>

createIndexSync

Returns Index

empty

Returns Promise<void>

Deprecated

emptySync

Returns void

Deprecated

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

ProtectedfindInodeSync

Parameters

Returns Inode

Todo

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

loadIndex

Parameters

Returns Promise<void>

loadIndexSync

Parameters

Returns void

metadata

Returns FileSystemMetadata

mkdir

Parameters

Returns Promise<void>

mkdirSync

Parameters

Returns void

openFile

`Protected` `Optional` `Internal`_disableSync

`Protected`_initialized

`Readonly`baseUrl

`Optional` `Readonly`requestInit

`Protected` `Readonly`store

`Protected`allocNew

`Protected`allocNewSync

`Protected`commitNew

`Protected`commitNewSync

`Protected`findInodeSync

`Protected`remove

`Protected`removeSync