AsyncMixin
Defined in: src/mixins/async.ts:23
Internal
Extends
Section titled “Extends”Pick<FileSystem,Exclude<_SyncFSKeys,"existsSync">>
Properties
Section titled “Properties”_sync?
Section titled “_sync?”
protectedoptional_sync?:FileSystem
Defined in: src/mixins/async.ts:27
Internal
Methods
Section titled “Methods”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”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”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”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”queueDone()
Section titled “queueDone()”queueDone():
Promise<void>
Defined in: src/mixins/async.ts:31
Returns
Section titled “Returns”Promise<void>
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/mixins/async.ts:33
Returns
Section titled “Returns”Promise<void>
readySync()
Section titled “readySync()”readySync():
void
Defined in: src/internal/filesystem.ts:214
Returns
Section titled “Returns”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”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”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”sync()
Section titled “sync()”sync():
Promise<void>
Defined in: src/mixins/async.ts:35
Returns
Section titled “Returns”Promise<void>
syncSync()
Section titled “syncSync()”
abstractsyncSync():void
Defined in: src/internal/filesystem.ts:282
Returns
Section titled “Returns”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”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”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