FetchFS
Defined in: src/backends/fetch.ts:65
Internal
A simple filesystem backed by HTTP using the fetch API.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FetchFS(
index,baseUrl,requestInit?,remoteWrite?):FetchFS
Defined in: src/backends/fetch.ts:79
Parameters
Section titled “Parameters”baseUrl
Section titled “baseUrl”string
requestInit?
Section titled “requestInit?”RequestInit = {}
remoteWrite?
Section titled “remoteWrite?”boolean
Returns
Section titled “Returns”FetchFS
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_mountPoint?
Section titled “_mountPoint?”
protectedoptional_mountPoint?:string
Defined in: src/internal/filesystem.ts:162
Internal
The last place this file system was mounted
Inherited from
Section titled “Inherited from”
protected_uuid:`${string}-${string}-${string}-${string}-${string}`
Defined in: src/internal/filesystem.ts:169
Internal
The UUID of the file system.
Inherited from
Section titled “Inherited from”attributes
Section titled “attributes”
readonlyattributes:ConstMap<FileSystemAttributes, keyofFileSystemAttributes,void|CaseFold|undefined> &Map<string,any>
Defined in: src/internal/filesystem.ts:178
FileSystemAttributes
Inherited from
Section titled “Inherited from”baseUrl
Section titled “baseUrl”
protectedbaseUrl:string
Defined in: src/backends/fetch.ts:81
readonlyindex:Index
Defined in: src/internal/index_fs.ts:28
Inherited from
Section titled “Inherited from”label?
Section titled “label?”
optionallabel?:string
Defined in: src/internal/filesystem.ts:156
Inherited from
Section titled “Inherited from”
readonlyname:string
Defined in: src/internal/filesystem.ts:191
The name for this file system. For example, tmpfs for an in memory one
Inherited from
Section titled “Inherited from”remoteWrite?
Section titled “remoteWrite?”
protectedoptionalremoteWrite?:boolean
Defined in: src/backends/fetch.ts:83
requestInit
Section titled “requestInit”
protectedrequestInit:RequestInit={}
Defined in: src/backends/fetch.ts:82
readonlytype:number
Defined in: src/internal/filesystem.ts:185
A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get uuid():
`${string}-${string}-${string}-${string}-${string}`
Defined in: src/internal/filesystem.ts:171
Returns
Section titled “Returns”`${string}-${string}-${string}-${string}-${string}`
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”_async()
Section titled “_async()”
protected_async(p):void
Defined in: src/backends/fetch.ts:75
Queue an async operation started from a sync method. Failures aren’t rethrown to prevent further async ops from failing
Parameters
Section titled “Parameters”Promise<unknown>
Returns
Section titled “Returns”void
_create()
Section titled “_create()”
protected_create(path,inode):Promise<void>
Defined in: src/backends/fetch.ts:103
Create a new file in the underlying backend
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”_createSync()
Section titled “_createSync()”
protected_createSync(path,inode):void
Defined in: src/backends/fetch.ts:109
Create a new file in the underlying backend
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”_mkdir()?
Section titled “_mkdir()?”
protectedoptional_mkdir(path,options):Promise<void>
Defined in: src/internal/index_fs.ts:205
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”_mkdirSync()?
Section titled “_mkdirSync()?”
protectedoptional_mkdirSync(path,options):void
Defined in: src/internal/index_fs.ts:206
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_remove()
Section titled “_remove()”
protected_remove(path,isUnlink):void
Defined in: src/internal/index_fs.ts:119
Parameters
Section titled “Parameters”string
isUnlink
Section titled “isUnlink”boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”create()
Section titled “create()”
protectedcreate(path,options):Inode
Defined in: src/internal/index_fs.ts:161
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”createFile()
Section titled “createFile()”createFile(
path,options):Promise<Inode>
Defined in: src/internal/index_fs.ts:183
Create the file at path with the given options.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<Inode>
Inherited from
Section titled “Inherited from”createFileSync()
Section titled “createFileSync()”createFileSync(
path,options):Inode
Defined in: src/internal/index_fs.ts:194
Create the file at path with the given options.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”exists()
Section titled “exists()”exists(
path):Promise<boolean>
Defined in: src/internal/filesystem.ts:257
Test whether or not path exists.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Inherited from
Section titled “Inherited from”existsSync()
Section titled “existsSync()”existsSync(
path):boolean
Defined in: src/internal/filesystem.ts:269
Test whether or not path exists.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”ioctl()
Section titled “ioctl()”ioctl(
context,command, …args):Promise<any>
Defined in: src/internal/filesystem.ts:365
Internal
Parameters
Section titled “Parameters”context
Section titled “context”IoctlContext
command
Section titled “command”number
…any[]
Returns
Section titled “Returns”Promise<any>
Inherited from
Section titled “Inherited from”ioctlSync()
Section titled “ioctlSync()”ioctlSync(
context,command, …args):any
Defined in: src/internal/filesystem.ts:373
Internal
Parameters
Section titled “Parameters”context
Section titled “context”IoctlContext
command
Section titled “command”number
…any[]
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”link()
Section titled “link()”link():
Promise<void>
Defined in: src/internal/index_fs.ts:222
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”linkSync()
Section titled “linkSync()”linkSync():
void
Defined in: src/internal/index_fs.ts:226
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”mkdir()
Section titled “mkdir()”mkdir(
path,options):Promise<Inode>
Defined in: src/internal/index_fs.ts:208
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<Inode>
Inherited from
Section titled “Inherited from”mkdirSync()
Section titled “mkdirSync()”mkdirSync(
path,options):Inode
Defined in: src/internal/index_fs.ts:215
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”read()
Section titled “read()”read(
path,buffer,offset?,end):Promise<void>
Defined in: src/backends/fetch.ts:136
Reads into a buffer
Parameters
Section titled “Parameters”string
buffer
Section titled “buffer”Uint8Array
The buffer to read into. You must set the byteOffset and byteLength appropriately!
offset?
Section titled “offset?”number = 0
number
The position in the file to stop reading
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”readdir()
Section titled “readdir()”readdir(
path):Promise<string[]>
Defined in: src/internal/index_fs.ts:230
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string[]>
Inherited from
Section titled “Inherited from”readdirSync()
Section titled “readdirSync()”readdirSync(
path):string[]
Defined in: src/internal/index_fs.ts:234
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”readSync()
Section titled “readSync()”readSync(
path,buffer,offset?,end):void
Defined in: src/backends/fetch.ts:152
Reads into a buffer
Parameters
Section titled “Parameters”string
buffer
Section titled “buffer”Uint8Array
The buffer to read into. You must set the byteOffset and byteLength appropriately!
offset?
Section titled “offset?”number = 0
number
The position in the file to stop reading
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”ready()
Section titled “ready()”ready():
Promise<void>
Defined in: src/internal/filesystem.ts:213
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”readySync()
Section titled “readySync()”readySync():
void
Defined in: src/internal/filesystem.ts:214
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”remove()
Section titled “remove()”
protectedremove(path):Promise<void>
Defined in: src/backends/fetch.ts:128
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”removeSync()
Section titled “removeSync()”
protectedremoveSync(path):void
Defined in: src/backends/fetch.ts:132
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”rename()
Section titled “rename()”rename(
oldPath,newPath):Promise<void>
Defined in: src/internal/index_fs.ts:55
Parameters
Section titled “Parameters”oldPath
Section titled “oldPath”string
newPath
Section titled “newPath”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”renameSync()
Section titled “renameSync()”renameSync(
oldPath,newPath):void
Defined in: src/internal/index_fs.ts:76
Parameters
Section titled “Parameters”oldPath
Section titled “oldPath”string
newPath
Section titled “newPath”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”resize()
Section titled “resize()”
protectedresize(path,inode,oldSize):void|Promise<void>
Defined in: src/backends/fetch.ts:88
Parameters
Section titled “Parameters”string
oldSize
Section titled “oldSize”number
Returns
Section titled “Returns”void | Promise<void>
rmdir()
Section titled “rmdir()”rmdir(
path):Promise<void>
Defined in: src/internal/index_fs.ts:141
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”rmdirSync()
Section titled “rmdirSync()”rmdirSync(
path):void
Defined in: src/internal/index_fs.ts:149
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”stat()
Section titled “stat()”stat(
path):Promise<Inode>
Defined in: src/internal/index_fs.ts:97
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Inode>
Inherited from
Section titled “Inherited from”statSync()
Section titled “statSync()”statSync(
path):Inode
Defined in: src/internal/index_fs.ts:103
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”streamRead()
Section titled “streamRead()”streamRead(
path,options):ReadableStream
Defined in: src/internal/filesystem.ts:317
Read a file using a stream.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”ReadableStream
Inherited from
Section titled “Inherited from”streamWrite()
Section titled “streamWrite()”streamWrite(
path,options):WritableStream
Defined in: src/internal/filesystem.ts:346
Write a file using stream.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”WritableStream
Inherited from
Section titled “Inherited from”sync()
Section titled “sync()”sync():
Promise<void>
Defined in: src/internal/index_fs.ts:238
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”syncSync()
Section titled “syncSync()”syncSync():
void
Defined in: src/internal/index_fs.ts:240
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”toString()
Section titled “toString()”toString():
string
Defined in: src/internal/filesystem.ts:197
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”touch()
Section titled “touch()”touch(
path,metadata):Promise<void>
Defined in: src/backends/fetch.ts:113
Modify metadata.
Parameters
Section titled “Parameters”string
metadata
Section titled “metadata”Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”touchSync()
Section titled “touchSync()”touchSync(
path,metadata):void
Defined in: src/backends/fetch.ts:120
Modify metadata.
Parameters
Section titled “Parameters”string
metadata
Section titled “metadata”Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”unlink()
Section titled “unlink()”unlink(
path):Promise<void>
Defined in: src/internal/index_fs.ts:131
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”unlinkSync()
Section titled “unlinkSync()”unlinkSync(
path):void
Defined in: src/internal/index_fs.ts:136
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”usage()
Section titled “usage()”usage():
UsageInfo
Defined in: src/internal/index_fs.ts:33
Default implementation.
Returns
Section titled “Returns”Implement
Inherited from
Section titled “Inherited from”write()
Section titled “write()”write(
path,data,offset):Promise<void>
Defined in: src/backends/fetch.ts:170
Writes a buffer to a file
Parameters
Section titled “Parameters”string
Uint8Array
offset
Section titled “offset”number
The offset in the file to start writing
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”writeSync()
Section titled “writeSync()”writeSync(
path,data,offset):void
Defined in: src/backends/fetch.ts:179
Writes a buffer to a file
Parameters
Section titled “Parameters”string
Uint8Array
offset
Section titled “offset”number
The offset in the file to start writing
Returns
Section titled “Returns”void