Interface CredentialStore

Interface for storing and retrieving credentials. Provides methods to manage credentials required by tools.

interface CredentialStore {
    getCredentials<T>(requiredCredentialNames): Promise<{
        foundCredentials: Partial<CredentialsFor<T>>;
        missingCredentials: string[];
    }>;
    setCredentials<T>(credentials): Promise<void>;
}

Implemented by

Methods

getCredentials setCredentials

Methods

getCredentials

  • getCredentials<T>(requiredCredentialNames): Promise<{
        foundCredentials: Partial<CredentialsFor<T>>;
        missingCredentials: string[];
    }>

  • Retrieves stored credentials by their names.

    Type Parameters

    • T

      The type containing credential information.

    Parameters

    • requiredCredentialNames: readonly string[]

      Names of the credentials to retrieve.

    Returns Promise<{
        foundCredentials: Partial<CredentialsFor<T>>;
        missingCredentials: string[];
    }>

    Object containing found credentials and names of missing credentials.

setCredentials

  • setCredentials<T>(credentials): Promise<void>

  • Stores credentials for future use.

    Type Parameters

    • T

      The type containing credential information.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

getCredentialssetCredentials