AsyncFSMethods
Defined in: src/mixins/shared.ts:53
Internal
Asynchronous FileSystem methods. This is a convenience type for all of the async operations.
Extends
Section titled “Extends”Pick<FileSystem,_AsyncFSKeys>
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”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”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”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”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”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”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”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”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”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”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”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”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”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>