IndexFS
Defined in: src/internal/index_fs.ts:24
Internal
A file system that uses an Index for metadata.
[breaking] replace the three method create system with something more intuitive, e.g. requiring subclasses to implement createFile, with this just exposing create for convenience.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new IndexFS(
id,name,index?):IndexFS
Defined in: src/internal/index_fs.ts:25
Parameters
Section titled “Parameters”number
string
index?
Section titled “index?”Index = ...
Returns
Section titled “Returns”IndexFS
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”
readonlyindex:Index
Defined in: src/internal/index_fs.ts:28
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”
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”_create()?
Section titled “_create()?”
protectedoptional_create(path,inode):Promise<void>
Defined in: src/internal/index_fs.ts:157
Create a new file in the underlying backend
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
_createSync()?
Section titled “_createSync()?”
protectedoptional_createSync(path,inode):void
Defined in: src/internal/index_fs.ts:159
Create a new file in the underlying backend
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
_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>
_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
_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
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”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>
Overrides
Section titled “Overrides”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”Overrides
Section titled “Overrides”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>
Overrides
Section titled “Overrides”linkSync()
Section titled “linkSync()”linkSync():
void
Defined in: src/internal/index_fs.ts:226
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”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>
Overrides
Section titled “Overrides”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”Overrides
Section titled “Overrides”read()
Section titled “read()”
abstractread(path,buffer,start,end):Promise<void>
Defined in: src/internal/filesystem.ts:290
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!
number
The offset into the file to start reading from
number
The position in the file to stop reading
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”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[]>
Overrides
Section titled “Overrides”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[]
Overrides
Section titled “Overrides”readSync()
Section titled “readSync()”
abstractreadSync(path,buffer,start,end):void
Defined in: src/internal/filesystem.ts:297
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!
number
The offset into the file to start reading from
number
The position in the file to stop reading
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”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()”
abstractprotectedremove(path):Promise<void>
Defined in: src/internal/index_fs.ts:128
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
removeSync()
Section titled “removeSync()”
abstractprotectedremoveSync(path):void
Defined in: src/internal/index_fs.ts:129
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
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>
Overrides
Section titled “Overrides”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
Overrides
Section titled “Overrides”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>
Overrides
Section titled “Overrides”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
Overrides
Section titled “Overrides”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>
Overrides
Section titled “Overrides”statSync()
Section titled “statSync()”statSync(
path):Inode
Defined in: src/internal/index_fs.ts:103
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Overrides
Section titled “Overrides”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>
Overrides
Section titled “Overrides”syncSync()
Section titled “syncSync()”syncSync():
void
Defined in: src/internal/index_fs.ts:240
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”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/internal/index_fs.ts:109
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/internal/index_fs.ts:114
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>
Overrides
Section titled “Overrides”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
Overrides
Section titled “Overrides”usage()
Section titled “usage()”usage():
UsageInfo
Defined in: src/internal/index_fs.ts:33
Default implementation.
Returns
Section titled “Returns”Implement
Overrides
Section titled “Overrides”write()
Section titled “write()”
abstractwrite(path,buffer,offset):Promise<void>
Defined in: src/internal/filesystem.ts:304
Writes a buffer to a file
Parameters
Section titled “Parameters”string
buffer
Section titled “buffer”Uint8Array
The buffer to write. You must set the byteOffset and byteLength appropriately!
offset
Section titled “offset”number
The offset in the file to start writing
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”writeSync()
Section titled “writeSync()”
abstractwriteSync(path,buffer,offset):void
Defined in: src/internal/filesystem.ts:311
Writes a buffer to a file
Parameters
Section titled “Parameters”string
buffer
Section titled “buffer”Uint8Array
The buffer to write. You must set the byteOffset and byteLength appropriately!
offset
Section titled “offset”number
The offset in the file to start writing
Returns
Section titled “Returns”void