Class FetchFS`Internal`

A simple filesystem backed by HTTP using the fetch API.

Hierarchy (View Summary)

IndexFS
- FetchFS

Index

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:72

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

`Protected`baseUrl

baseUrl: string

`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 = {}

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

Methods

`Protected`_async

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

`Protected` `Optional`_mkdir

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

`Protected` `Optional`_mkdirSync

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

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

`Protected`create

create(path: string, options: CreationOptions): Inode
Parameters
- path: string
- options: CreationOptions
Returns Inode
Inherited from IndexFS.create
- 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>>
Inherited from IndexFS.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
Inherited from IndexFS.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 IndexFS.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 IndexFS.existsSync
- Defined in src/internal/filesystem.ts:263

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:203

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:207

mkdir

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

mkdirSync

mkdirSync(path: string, options: CreationOptions): InodeLike
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Inherited from IndexFS.mkdirSync
- Defined in src/internal/index_fs.ts:196

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

readdir

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

readdirSync

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

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
- end: number
  The position in the file to stop reading
Returns void
Overrides IndexFS.readSync
- Defined in src/backends/fetch.ts:105

ready

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

`Protected`remove

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

`Protected`removeSync

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

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:53

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:74

rmdir

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

rmdirSync

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

stat

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

statSync

statSync(path: string): Inode
Parameters
- path: string
Returns Inode
Inherited from IndexFS.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 IndexFS.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 IndexFS.streamWrite
- Defined in src/internal/filesystem.ts:334

sync

sync(): Promise<void>
Returns Promise<void>
Inherited from IndexFS.sync
- Defined in src/internal/index_fs.ts:219

syncSync

syncSync(): void
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:194

touch

touch(path: string, metadata: InodeLike): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: InodeLike
Returns Promise<void>
Inherited from IndexFS.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
Inherited from IndexFS.touchSync
- Defined in src/internal/index_fs.ts:112

unlink

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

unlinkSync

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

usage

usage(): UsageInfo
Experimental
Default implementation.

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

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:123

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:132

Class FetchFSInternal

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FetchFS

Properties

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

ProtectedbaseUrl

Readonlyindex

Optionallabel

Readonlyname

Protected OptionalremoteWrite

ProtectedrequestInit

Readonlytype

Accessors

uuid

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

Methods

Protected_async

Parameters

Returns void

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

read

Parameters

Returns Promise<void>

readdir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

readSync

Parameters

Returns void

ready

Returns Promise<void>

Class FetchFS`Internal`

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Protected`baseUrl

`Readonly`index

`Optional`label

`Readonly`name

`Protected` `Optional`remoteWrite

`Protected`requestInit

`Readonly`type

`Protected`_async

`Protected` `Optional`_mkdir

`Protected` `Optional`_mkdirSync

`Protected`_remove

`Protected`create

`Protected`remove

`Protected`removeSync