IKeyEntryStorage | virgil-sdk

Interface to be implemented by object capable of persisting private keys data and metadata.

Hierarchy

IKeyEntryStorage

Implemented by

KeyEntryStorage

Index

Methods

Methods

clear

clear(): Promise<void>

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

Returns Promise<void>

exists

exists(name: string): Promise<boolean>

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

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

list

list(): Promise<IKeyEntry[]>

- Defined in Storage/KeyEntryStorage/IKeyEntryStorage.ts:122
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>

- Defined in Storage/KeyEntryStorage/IKeyEntryStorage.ts:99
Retrieves key entry by name.

Parameters
- name: string
  
  Name of the key entry to retrieve.
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>

- Defined in Storage/KeyEntryStorage/IKeyEntryStorage.ts:115
Removes key entry by name.

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

save

save(params: ISaveKeyEntryParams): Promise<IKeyEntry>

- Defined in Storage/KeyEntryStorage/IKeyEntryStorage.ts:91
Saves key entry represented by params.

Parameters
- params: ISaveKeyEntryParams
  
  New key entry parameters.
Returns Promise<IKeyEntry>

Promise resolved with stored entry, or rejected with PrivateKeyExistsError error in case entry with the same name already exists.

update

update(params: IUpdateKeyEntryParams): Promise<IKeyEntry>

- Defined in Storage/KeyEntryStorage/IKeyEntryStorage.ts:130
Updates the value or metadata (or both) of the key entry identified by params.name.

Parameters
- params: IUpdateKeyEntryParams
  
  Paremeters identifying the entry to update and new value or metadata (or both).
Returns Promise<IKeyEntry>