Class FilePersistence

Reads and writes data to file specified by file location. File contents are not encrypted.

If file or directory has not been created, it FilePersistence.create() will create file and any directories in the path recursively.

Hierarchy

BasePersistence
- FilePersistence

Implements

IPersistence

Index

Methods

createForPersistenceValidation delete getFilePath getLogger load loadBuffer reloadNecessary save saveBuffer verifyPersistence create

Methods

createForPersistenceValidation

createForPersistenceValidation(): Promise<FilePersistence>
Returns Promise<FilePersistence>
Implementation of IPersistence.createForPersistenceValidation

Overrides BasePersistence.createForPersistenceValidation
- Defined in persistence/FilePersistence.ts:141

delete

delete(): Promise<boolean>
Returns Promise<boolean>
Implementation of IPersistence.delete
- Defined in persistence/FilePersistence.ts:106

getFilePath

getFilePath(): string
Returns string
Implementation of IPersistence.getFilePath
- Defined in persistence/FilePersistence.ts:129

getLogger

getLogger(): Logger
Returns Logger
Implementation of IPersistence.getLogger
- Defined in persistence/FilePersistence.ts:137

load

load(): Promise<null | string>
Returns Promise<null | string>
Implementation of IPersistence.load
- Defined in persistence/FilePersistence.ts:76

loadBuffer

loadBuffer(): Promise<Uint8Array>
Returns Promise<Uint8Array>
- Defined in persistence/FilePersistence.ts:91

reloadNecessary

reloadNecessary(lastSync): Promise<boolean>
Parameters
- lastSync: number
Returns Promise<boolean>
Implementation of IPersistence.reloadNecessary
- Defined in persistence/FilePersistence.ts:133

save

save(contents): Promise<void>
Parameters
- contents: string
Returns Promise<void>
Implementation of IPersistence.save
- Defined in persistence/FilePersistence.ts:46

saveBuffer

saveBuffer(contents): Promise<void>
Parameters
- contents: Uint8Array
Returns Promise<void>
- Defined in persistence/FilePersistence.ts:61

verifyPersistence

verifyPersistence(): Promise<boolean>
Returns Promise<boolean>
Implementation of IPersistence.verifyPersistence

Inherited from BasePersistence.verifyPersistence
- Defined in persistence/BasePersistence.ts:13

`Static` create

create(fileLocation, loggerOptions?): Promise<FilePersistence>
Parameters
- fileLocation: string
- Optional loggerOptions: LoggerOptions
Returns Promise<FilePersistence>
- Defined in persistence/FilePersistence.ts:34

Generated using TypeDoc