Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PasswordStore

Basic keychain interface.

Hierarchy

  • PasswordStore

Implemented by

Index

Methods

getPassword

  • getPassword(opts: ProgramOpts, fn: function, retryCount?: undefined | number): Promise<void>
  • Gets a password

    Parameters

    • opts: ProgramOpts

      cli level password options.

    • fn: function

      function callback for password.

        • (error: Nullable<Error>, password?: undefined | string): void
        • Parameters

          • error: Nullable<Error>
          • Optional password: undefined | string

          Returns void

    • Optional retryCount: undefined | number

      number of reties to get the password.

    Returns Promise<void>

setPassword

  • setPassword(opts: ProgramOpts, fn: function): Promise<void>
  • Sets a password.

    Parameters

    • opts: ProgramOpts

      cli level password options.

    • fn: function

      function callback for password.

        • (error: Nullable<Error>, password?: undefined | string): void
        • Parameters

          • error: Nullable<Error>
          • Optional password: undefined | string

          Returns void

    Returns Promise<void>