Class OPFSStorageBackend

Stores databases in the Origin Private File System (OPFS). Used for opfs:// locations by default when the browser supports OPFS.

Opening a database takes a Web Lock, so a database can be open in only one tab or worker at a time.

Implements

StorageBackend

Index

Constructors

Methods

list lock readFile remove unlock writeFile isSupported

Constructors

constructor

new OPFSStorageBackend(options?: OPFSStorageBackendOptions): OPFSStorageBackend
Parameters
- Optionaloptions: OPFSStorageBackendOptions
Returns OPFSStorageBackend
- Defined in storage.d.ts:53

Methods

list

list(path: string): Promise<string[]>
List entry names of a directory; directory names end with /. Missing directories list as empty.
Parameters
- path: string
Returns Promise<string[]>
Implementation of StorageBackend.list
- Defined in storage.d.ts:61

lock

lock(name: string): Promise<void>
Acquire an exclusive lock (for example across browser tabs). Rejects if it is held elsewhere.
Parameters
- name: string
Returns Promise<void>
Implementation of StorageBackend.lock
- Defined in storage.d.ts:62

readFile

readFile(path: string): Promise<Uint8Array<ArrayBuffer>>
Read a file. Resolves to null if it does not exist.
Parameters
- path: string
Returns Promise<Uint8Array<ArrayBuffer>>
Implementation of StorageBackend.readFile
- Defined in storage.d.ts:58

remove

remove(path: string): Promise<void>
Remove a file or directory (recursively). Missing entries are ignored.
Parameters
- path: string
Returns Promise<void>
Implementation of StorageBackend.remove
- Defined in storage.d.ts:60

unlock

unlock(name: string): Promise<void>
Release a lock acquired with lock().
Parameters
- name: string
Returns Promise<void>
Implementation of StorageBackend.unlock
- Defined in storage.d.ts:63

writeFile

writeFile(path: string, data: Uint8Array): Promise<void>
Create or replace a file. Should replace the file atomically.
Parameters
- path: string
- data: Uint8Array
Returns Promise<void>
Implementation of StorageBackend.writeFile
- Defined in storage.d.ts:59

`Static`isSupported

isSupported(): boolean
Whether OPFS is available in the current environment.

Returns boolean
- Defined in storage.d.ts:55