Class FilePersistenceWithDataProtection

Uses CryptProtectData and CryptUnprotectData on Windows to encrypt and decrypt file contents.

scope: Scope of the data protection. Either local user or the current machine optionalEntropy: Password or other additional entropy used to encrypt the data

Hierarchy

BasePersistence
- FilePersistenceWithDataProtection

Implements

IPersistence

Index

Methods

createForPersistenceValidation delete getFilePath getLogger load reloadNecessary save verifyPersistence create

Methods

createForPersistenceValidation

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

Overrides BasePersistence.createForPersistenceValidation
- Defined in persistence/FilePersistenceWithDataProtection.ts:127

delete

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

getFilePath

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

getLogger

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

load

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

reloadNecessary

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

save

save(contents): Promise<void>
Parameters
- contents: string
Returns Promise<void>
Implementation of IPersistence.save
- Defined in persistence/FilePersistenceWithDataProtection.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, scope, optionalEntropy?, loggerOptions?): Promise<FilePersistenceWithDataProtection>
Parameters
- fileLocation: string
- scope: DataProtectionScope
- Optional optionalEntropy: string
- Optional loggerOptions: LoggerOptions
Returns Promise<FilePersistenceWithDataProtection>
- Defined in persistence/FilePersistenceWithDataProtection.ts:43

Generated using TypeDoc