NodepodFSClient
Nodepod API / src / NodepodFSClient
Class: NodepodFSClient
Section titled “Class: NodepodFSClient”Defined in: src/sdk/nodepod-fs-client.ts:30
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NodepodFSClient(
_reader):NodepodFSClient
Defined in: src/sdk/nodepod-fs-client.ts:31
Parameters
Section titled “Parameters”_reader
Section titled “_reader”Returns
Section titled “Returns”NodepodFSClient
Accessors
Section titled “Accessors”reader
Section titled “reader”Get Signature
Section titled “Get Signature”get reader():
SharedVFSReader
Defined in: src/sdk/nodepod-fs-client.ts:101
escape hatch if you need the sync reader directly
Returns
Section titled “Returns”version
Section titled “version”Get Signature
Section titled “Get Signature”get version():
number
Defined in: src/sdk/nodepod-fs-client.ts:68
SAB version counter, bumped on every write/delete.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”appendFile()
Section titled “appendFile()”appendFile(
_path,_data):Promise<void>
Defined in: src/sdk/nodepod-fs-client.ts:96
Parameters
Section titled “Parameters”string
string | Uint8Array<ArrayBufferLike>
Returns
Section titled “Returns”Promise<void>
exists()
Section titled “exists()”exists(
path):Promise<boolean>
Defined in: src/sdk/nodepod-fs-client.ts:47
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-client.ts:84
Parameters
Section titled “Parameters”string
_opts?
Section titled “_opts?”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-client.ts:59
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-client.ts:33
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-client.ts:34
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-client.ts:93
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”Promise<void>
rmdir()
Section titled “rmdir()”rmdir(
_path,_opts?):Promise<void>
Defined in: src/sdk/nodepod-fs-client.ts:90
Parameters
Section titled “Parameters”string
_opts?
Section titled “_opts?”recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”Promise<void>
stat()
Section titled “stat()”stat(
path):Promise<SharedVFSStat>
Defined in: src/sdk/nodepod-fs-client.ts:51
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<SharedVFSStat>
unlink()
Section titled “unlink()”unlink(
_path):Promise<void>
Defined in: src/sdk/nodepod-fs-client.ts:87
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
waitForChange()
Section titled “waitForChange()”waitForChange(
currentVersion,timeoutMs?):number
Defined in: src/sdk/nodepod-fs-client.ts:77
Block until the version changes or timeout. returns the new version, or -1 on timeout. don’t call this on a browser main thread, Atomics.wait throws there.
Parameters
Section titled “Parameters”currentVersion
Section titled “currentVersion”number
timeoutMs?
Section titled “timeoutMs?”number = 5000
Returns
Section titled “Returns”number
writeFile()
Section titled “writeFile()”writeFile(
_path,_data):Promise<void>
Defined in: src/sdk/nodepod-fs-client.ts:81
Parameters
Section titled “Parameters”string
string | Uint8Array<ArrayBufferLike>
Returns
Section titled “Returns”Promise<void>