NodepodFS
Nodepod API / src / NodepodFS
Class: NodepodFS
Section titled “Class: NodepodFS”Defined in: src/sdk/nodepod-fs.ts:8
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NodepodFS(
_vol,_profiler?):NodepodFS
Defined in: src/sdk/nodepod-fs.ts:9
Parameters
Section titled “Parameters”_profiler?
Section titled “_profiler?”NodepodProfilerImpl | null
Returns
Section titled “Returns”NodepodFS
Accessors
Section titled “Accessors”volume
Section titled “volume”Get Signature
Section titled “Get Signature”get volume():
MemoryVolume
Defined in: src/sdk/nodepod-fs.ts:145
Returns
Section titled “Returns”Methods
Section titled “Methods”exists()
Section titled “exists()”exists(
path):Promise<boolean>
Defined in: src/sdk/nodepod-fs.ts:81
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
mkdir()
Section titled “mkdir()”mkdir(
path,opts?):Promise<void>
Defined in: src/sdk/nodepod-fs.ts:60
Parameters
Section titled “Parameters”string
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”Promise<void>
readdir()
Section titled “readdir()”readdir(
path):Promise<string[]>
Defined in: src/sdk/nodepod-fs.ts:70
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string[]>
readFile()
Section titled “readFile()”Call Signature
Section titled “Call Signature”readFile(
path,encoding?):Promise<string>
Defined in: src/sdk/nodepod-fs.ts:41
Parameters
Section titled “Parameters”string
encoding?
Section titled “encoding?”"utf8" | "utf-8"
Returns
Section titled “Returns”Promise<string>
Call Signature
Section titled “Call Signature”readFile(
path):Promise<Uint8Array<ArrayBufferLike>>
Defined in: src/sdk/nodepod-fs.ts:42
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
rename()
Section titled “rename()”rename(
from,to):Promise<void>
Defined in: src/sdk/nodepod-fs.ts:128
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”Promise<void>
rm(
path,opts?):Promise<void>
Defined in: src/sdk/nodepod-fs.ts:113
Parameters
Section titled “Parameters”string
force?
Section titled “force?”boolean
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”Promise<void>
rmdir()
Section titled “rmdir()”rmdir(
path,opts?):Promise<void>
Defined in: src/sdk/nodepod-fs.ts:105
Parameters
Section titled “Parameters”string
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”Promise<void>
stat()
Section titled “stat()”stat(
path):Promise<StatResult>
Defined in: src/sdk/nodepod-fs.ts:85
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<StatResult>
unlink()
Section titled “unlink()”unlink(
path):Promise<void>
Defined in: src/sdk/nodepod-fs.ts:101
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
watch()
Section titled “watch()”watch(
path,optionsOrCb?,cb?):object
Defined in: src/sdk/nodepod-fs.ts:132
Parameters
Section titled “Parameters”string
optionsOrCb?
Section titled “optionsOrCb?”{ recursive?: boolean; } | ((event, filename) => void)
(event, filename) => void
Returns
Section titled “Returns”object
close()
Section titled “close()”close():
void
Returns
Section titled “Returns”void
writeFile()
Section titled “writeFile()”writeFile(
path,data):Promise<void>
Defined in: src/sdk/nodepod-fs.ts:23
Parameters
Section titled “Parameters”string
string | Uint8Array<ArrayBufferLike>
Returns
Section titled “Returns”Promise<void>