KeyEntryStorage | virgil-sdk

Class responsible for persisting private key bytes with optional user-defined metadata.

Hierarchy

KeyEntryStorage

Implements

IKeyEntryStorage

Index

Constructors

constructor

Methods

Constructors

constructor

new KeyEntryStorage(config?: IKeyEntryStorageConfig | string): KeyEntryStorage

- Defined in Storage/KeyEntryStorage/KeyEntryStorage.ts:28
Initializes a new instance of KeyEntryStorage.

Parameters
- Default value config: IKeyEntryStorageConfig | string = {}
  
  Instance configuration.
Returns KeyEntryStorage

Methods

clear

clear(): Promise<void>

Implementation of IKeyEntryStorage.clear
- Defined in Storage/KeyEntryStorage/KeyEntryStorage.ts:133
Removes all of the stored entries.

Returns Promise<void>

exists

exists(name: string): Promise<boolean>

Implementation of IKeyEntryStorage.exists
- Defined in Storage/KeyEntryStorage/KeyEntryStorage.ts:42
Checks if key entry exists by name.

Parameters
- name: string
Returns Promise<boolean>
- Promise resolved with true if key entry exists, or false otherwise.

list

list(): Promise<IKeyEntry[]>

Implementation of IKeyEntryStorage.list
- Defined in Storage/KeyEntryStorage/KeyEntryStorage.ts:97
Retrieves a collection of all stored entries.

Returns Promise<IKeyEntry[]>
- Promise resolved with array of all stored entries.

load

load(name: string): Promise<IKeyEntry | null>

Implementation of IKeyEntryStorage.load
- Defined in Storage/KeyEntryStorage/KeyEntryStorage.ts:50
Retrieves key entry by name.

Parameters
- name: string
Returns Promise<IKeyEntry | null>

Promise resolved with stored entry or null if entry with the given name does not exist.

remove

remove(name: string): Promise<boolean>

Implementation of IKeyEntryStorage.remove
- Defined in Storage/KeyEntryStorage/KeyEntryStorage.ts:63
Removes key entry by name.

Parameters
- name: string
Returns Promise<boolean>
- Promise resolved with true if key entry was removed, or false otherwise.

save

save(__namedParameters: object): Promise<IKeyEntry>

- Defined in Storage/KeyEntryStorage/KeyEntryStorage.ts:71
inheritdoc

Parameters
- __namedParameters: object
Returns Promise<IKeyEntry>

update

update(__namedParameters: object): Promise<IKeyEntry>

- Defined in Storage/KeyEntryStorage/KeyEntryStorage.ts:105
inheritdoc

Parameters
- __namedParameters: object
Returns Promise<IKeyEntry>