Interface Vault

The Vault aptitude allows Loops to retrieve and store strings in the system's secure storage (Keychain for MacOS, Credential Manager for Windows).

Hierarchy

Vault

Index

Methods

Methods

exists

exists(key: string): Promise<boolean>

- Defined in vault/index.ts:21
Returns true if the specified vault entry exists.

Parameters
- key: string
  
  The key for the item to check existence.
Returns Promise<boolean>
True if the specified vault entry exists.

read

read(key: string): Promise<string>

- Defined in vault/index.ts:29
Returns the stored value for the specified vault entry.

Parameters
- key: string
  
  The key for the item to read.
Returns Promise<string>
Stored value for the specified vault entry.

remove

remove(key: string): Promise<void>

- Defined in vault/index.ts:13
Removes an entry from the vault.

Parameters
- key: string
  
  The key for item to remove.
Returns Promise<void>
Status of the remove operation.

write

write(key: string, value: string): Promise<void>

- Defined in vault/index.ts:38
Writes the provided value to the specified vault entry.

Parameters
- key: string
  
  The key for the item to write.
- value: string
  
  The value to write.
Returns Promise<void>
The status of the write operation.

Generated using TypeDoc