Skip to main content

IndexDBFileSystemStorageAdapter

IndexDBFileSystemStorageAdapter implements LocalStorageAdapter using IndexedDB. Suitable for web browsers and web-based environments.

Implements

Constructors

new IndexDBFileSystemStorageAdapter()

new IndexDBFileSystemStorageAdapter(databaseName): IndexDBFileSystemStorageAdapter

Parameters

ParameterTypeDefault value
databaseNamestring'PowerSyncFiles'

Returns

IndexDBFileSystemStorageAdapter

Methods

clear()

clear(): Promise<void>

Returns

Promise<void>

Implementation of

LocalStorageAdapter.clear


deleteFile()

deleteFile(uri, options?): Promise<void>

Parameters

ParameterType
uristring
options?{ filename: string; }
options.filename?string

Returns

Promise<void>

Implementation of

LocalStorageAdapter.deleteFile


fileExists()

fileExists(fileUri): Promise<boolean>

Parameters

ParameterType
fileUristring

Returns

Promise<boolean>

True if the file exists, false otherwise

Implementation of

LocalStorageAdapter.fileExists


getLocalUri()

getLocalUri(filename): string

Parameters

ParameterTypeDescription
filenamestringThe filename to get the path for

Returns

string

The full file path

Implementation of

LocalStorageAdapter.getLocalUri


initialize()

initialize(): Promise<void>

Returns

Promise<void>

Implementation of

LocalStorageAdapter.initialize


makeDir()

makeDir(path): Promise<void>

Parameters

ParameterTypeDescription
pathstringThe full path to the directory

Returns

Promise<void>

Implementation of

LocalStorageAdapter.makeDir


readFile()

readFile(fileUri, options?): Promise<ArrayBuffer>

Parameters

ParameterType
fileUristring
options?{ encoding: EncodingType; mediaType: string; }
options.encoding?EncodingType
options.mediaType?string

Returns

Promise<ArrayBuffer>

ArrayBuffer containing the file data

Implementation of

LocalStorageAdapter.readFile


rmDir()

rmDir(path): Promise<void>

Parameters

ParameterTypeDescription
pathstringThe full path to the directory

Returns

Promise<void>

Implementation of

LocalStorageAdapter.rmDir


saveFile()

saveFile(filePath, data): Promise<number>

Parameters

ParameterTypeDescription
filePathstringPath where the file will be stored
dataAttachmentDataData to store (ArrayBuffer, Blob, or string)

Returns

Promise<number>

Number of bytes written

Implementation of

LocalStorageAdapter.saveFile