@flowscripter/dynamic-cli-framework
    Preparing search index...

    Interface SecretService

    Internal service providing secret storage via OS-native credential stores. Not registered in Context -- used internally by DefaultKeyValueService (see dynamic-cli-framework).

    interface SecretService {
        deleteSecret(bunSecretName: string): Promise<boolean>;
        getSecret(bunSecretName: string): Promise<string | null>;
        hasSecret(bunSecretName: string): Promise<boolean>;
        setSecret(key: string, value: string): Promise<string>;
    }

    Implemented by

    Index
    deleteSecret getSecret hasSecret setSecret

    • Delete a secret by its full Bun secret name.

      Parameters

      • bunSecretName: string

      Returns Promise<boolean>

    • Retrieve a secret value by its full Bun secret name.

      Parameters

      • bunSecretName: string

      Returns Promise<string | null>

    • Check if a secret exists by its full Bun secret name.

      Parameters

      • bunSecretName: string

      Returns Promise<boolean>

    • Store a secret value. Constructs the Bun secret name from the current scope and key.

      Parameters

      • key: string
      • value: string

      Returns Promise<string>

      the constructed Bun secret name (used as part of the sentinel value in the key-value Map).

    Settings
    Member Visibility

    On This Page
    Methods