Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Vault

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

Index

Interfaces

Methods

Methods

exists

  • exists(key: string): Promise<boolean>
  • 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>
  • 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>
  • 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>
  • 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