Opfs
Defined in: sdks/js/browser-sdk/src/Opfs.ts:4
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Opfs(
enableLogging?):Opfs
Defined in: sdks/js/browser-sdk/src/Opfs.ts:8
Parameters
Section titled “Parameters”enableLogging?
Section titled “enableLogging?”boolean
Returns
Section titled “Returns”Opfs
Methods
Section titled “Methods”clearAll()
Section titled “clearAll()”clearAll():
Promise<void>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:65
Returns
Section titled “Returns”Promise<void>
close()
Section titled “close()”close():
void
Defined in: sdks/js/browser-sdk/src/Opfs.ts:22
Returns
Section titled “Returns”void
deleteFile()
Section titled “deleteFile()”deleteFile(
path):Promise<boolean>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:48
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
exportDb()
Section titled “exportDb()”exportDb(
path):Promise<Uint8Array<ArrayBufferLike>>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:52
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike>>
fileCount()
Section titled “fileCount()”fileCount():
Promise<number>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:36
Returns
Section titled “Returns”Promise<number>
fileExists()
Section titled “fileExists()”fileExists(
path):Promise<boolean>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:44
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
importDb()
Section titled “importDb()”importDb(
path,data):Promise<void>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:61
Import a current client database to an absent path. Close and delete an existing target separately. Import changes the database identity, so old delivery cursors and acknowledgement tokens cannot be reused.
Parameters
Section titled “Parameters”string
Uint8Array
Returns
Section titled “Returns”Promise<void>
init()
Section titled “init()”init():
Promise<void>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:16
Returns
Section titled “Returns”Promise<void>
listFiles()
Section titled “listFiles()”listFiles():
Promise<string[]>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:32
Returns
Section titled “Returns”Promise<string[]>
poolCapacity()
Section titled “poolCapacity()”poolCapacity():
Promise<number>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:40
Returns
Section titled “Returns”Promise<number>
create()
Section titled “create()”
staticcreate(enableLogging?):Promise<Opfs>
Defined in: sdks/js/browser-sdk/src/Opfs.ts:26
Parameters
Section titled “Parameters”enableLogging?
Section titled “enableLogging?”boolean
Returns
Section titled “Returns”Promise<Opfs>