ConcreteFS
Defined in: src/mixins/shared.ts:60
Internal
Concrete FileSystem. This is a convenience type.
Extends
Section titled “Extends”ExtractProperties<FileSystem,any>
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”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”uuid:
`${string}-${string}-${string}-${string}-${string}`
Defined in: src/internal/filesystem.ts:171
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”createFile()
Section titled “createFile()”
abstractcreateFile(path,options):Promise<InodeLike<number>>
Defined in: src/internal/filesystem.ts:233
Create the file at path with the given options.
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<InodeLike<number>>
Inherited from
Section titled “Inherited from”createFileSync()
Section titled “createFileSync()”
abstractcreateFileSync(path,options):InodeLike
Defined in: src/internal/filesystem.ts:238
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:359
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:367
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()”
abstractlink(target,link):Promise<void>
Defined in: src/internal/filesystem.ts:278
Parameters
Section titled “Parameters”target
Section titled “target”string
string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”linkSync()
Section titled “linkSync()”
abstractlinkSync(target,link):void
Defined in: src/internal/filesystem.ts:279
Parameters
Section titled “Parameters”target
Section titled “target”string
string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”mkdir()
Section titled “mkdir()”
abstractmkdir(path,options):Promise<InodeLike<number>>
Defined in: src/internal/filesystem.ts:248
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<InodeLike<number>>
Inherited from
Section titled “Inherited from”mkdirSync()
Section titled “mkdirSync()”
abstractmkdirSync(path,options):InodeLike
Defined in: src/internal/filesystem.ts:249
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”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()”
abstractreaddir(path):Promise<string[]>
Defined in: src/internal/filesystem.ts:251
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string[]>
Inherited from
Section titled “Inherited from”readdirSync()
Section titled “readdirSync()”
abstractreaddirSync(path):string[]
Defined in: src/internal/filesystem.ts:252
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”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”rename()
Section titled “rename()”
abstractrename(oldPath,newPath):Promise<void>
Defined in: src/internal/filesystem.ts:218
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()”
abstractrenameSync(oldPath,newPath):void
Defined in: src/internal/filesystem.ts:219
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”rmdir()
Section titled “rmdir()”
abstractrmdir(path):Promise<void>
Defined in: src/internal/filesystem.ts:245
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”rmdirSync()
Section titled “rmdirSync()”
abstractrmdirSync(path):void
Defined in: src/internal/filesystem.ts:246
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”stat()
Section titled “stat()”
abstractstat(path):Promise<InodeLike<number>>
Defined in: src/internal/filesystem.ts:221
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<InodeLike<number>>
Inherited from
Section titled “Inherited from”statSync()
Section titled “statSync()”
abstractstatSync(path):InodeLike
Defined in: src/internal/filesystem.ts:222
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:340
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()”
abstractsync():Promise<void>
Defined in: src/internal/filesystem.ts:281
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”syncSync()
Section titled “syncSync()”
abstractsyncSync():void
Defined in: src/internal/filesystem.ts:282
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()”
abstracttouch(path,metadata):Promise<void>
Defined in: src/internal/filesystem.ts:225
Modify metadata.
Parameters
Section titled “Parameters”string
metadata
Section titled “metadata”Partial<InodeLike>
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”touchSync()
Section titled “touchSync()”
abstracttouchSync(path,metadata):void
Defined in: src/internal/filesystem.ts:228
Modify metadata.
Parameters
Section titled “Parameters”string
metadata
Section titled “metadata”Partial<InodeLike>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unlink()
Section titled “unlink()”
abstractunlink(path):Promise<void>
Defined in: src/internal/filesystem.ts:240
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”unlinkSync()
Section titled “unlinkSync()”
abstractunlinkSync(path):void
Defined in: src/internal/filesystem.ts:241
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/filesystem.ts:206
Default implementation.
Returns
Section titled “Returns”Implement
Inherited from
Section titled “Inherited from”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