Class OPFSAdapter

A Sylvie persistence adapter which persists using browser OPFS

Hierarchy

OPFSAdapter

Implements

Index

Constructors

Properties

fs isAsync mode options

Methods

#initializeFS deleteDatabase deleteDatabaseAsync loadDatabase loadDatabaseAsync saveDatabase saveDatabaseAsync

Constructors

constructor

new OPFSAdapter(options?: Partial<OPFSAdapterOptions>): OPFSAdapter
Parameters
- Optional options: Partial<OPFSAdapterOptions>
Returns OPFSAdapter
- Defined in src/storage-adapter/opfs-adapter.ts:38

Properties

fs

fs: FileSystemDirectoryHandle

isAsync

isAsync: true

mode

mode: "normal"

options

options: Partial<OPFSAdapterOptions>

Methods

`Private` #initializeFS

#initializeFS(): Promise<void>
Returns Promise<void>
- Defined in src/storage-adapter/opfs-adapter.ts:42

deleteDatabase

deleteDatabase(dbname: string, callback: PersistenceAdapterCallback): void
deleteDatabase() - delete the database file, will throw an error if the file can't be deleted
Parameters
- dbname: string
  
  the filename of the database to delete
- callback: PersistenceAdapterCallback
  
  the callback to handle the result
Returns void
Implementation of NormalPersistenceAdapter.deleteDatabase
- Defined in src/storage-adapter/opfs-adapter.ts:171

deleteDatabaseAsync

deleteDatabaseAsync(dbname: string): Promise<void>
Parameters
- dbname: string
Returns Promise<void>
Implementation of NormalAsyncPersistenceAdapter.deleteDatabaseAsync
- Defined in src/storage-adapter/opfs-adapter.ts:206

loadDatabase

loadDatabase(dbname: string, callback: ((serialized?: string | Error) => void)): void
loadDatabase() - Load data from OPFS file, will throw an error if the file does not exist
Parameters
- dbname: string
  
  the filename of the database to load
- callback: ((serialized?: string | Error) => void)
  
  the callback to handle the result
  - - (serialized?: string | Error): void
    - Parameters
      
      Optional serialized: string | Error
      
      Returns void
Returns void
Implementation of NormalPersistenceAdapter.loadDatabase
- Defined in src/storage-adapter/opfs-adapter.ts:56

loadDatabaseAsync

loadDatabaseAsync(dbname: string): Promise<string>
Parameters
- dbname: string
Returns Promise<string>
Implementation of NormalAsyncPersistenceAdapter.loadDatabaseAsync
- Defined in src/storage-adapter/opfs-adapter.ts:182

saveDatabase

saveDatabase(dbname: string, dbstring: string, callback: PersistenceAdapterCallback): void
saveDatabase() - save data to file, will throw an error if the file can't be saved might want to expand this to avoid dataloss on partial save

Memberof
LokiFsAdapter
Parameters
- dbname: string
  
  the filename of the database to load
- dbstring: string
- callback: PersistenceAdapterCallback
  
  the callback to handle the result
Returns void
Implementation of NormalPersistenceAdapter.saveDatabase
- Defined in src/storage-adapter/opfs-adapter.ts:106

saveDatabaseAsync

saveDatabaseAsync(dbname: string, dbstring: string): Promise<void>
Parameters
- dbname: string
- dbstring: string
Returns Promise<void>
Implementation of NormalAsyncPersistenceAdapter.saveDatabaseAsync
- Defined in src/storage-adapter/opfs-adapter.ts:194

Generated using TypeDoc