@grow-codes/openbao - v0.1.2
    Preparing search index...

    Class OpenBaoSecretsProvider

    SecretsProvider over an OpenBao KV mount (v1 or v2, auto-detected).

    • get(name) reads <path>/<name>; KV v2 versions are the SecretValue version.
    • set returns the new KV v2 version ("" on KV v1); cas and tags (custom metadata) need KV v2.
    • delete soft-deletes the latest version (KV v2), versions deletes those versions, permanent removes all versions and metadata.
    • list(prefix) lists one folder level (sub-folders skipped); on KV v2 each entry carries its metadata and secrets whose current version is deleted are skipped.

    Hierarchy (View Summary)

    Index

    The KV mount.

    path: string

    Base path inside the mount.

    valueField: string

    Data field that holds the value.

    capabilities: readonly string[] = ...

    Capabilities for the conformance runner.

    • get activeWatchers(): number

      Number of active watchers.

      Returns number

    • get closed(): boolean

      Whether close was called.

      Returns boolean

    • Throws CancelledError ("<operation>: client is closed", not retryable) once close was called (SPEC §2.4). The public operations call it before any I/O; service operations can call it too.

      Parameters

      • operation: string

      Returns void

    • The KV path of a secret: <options.path ?? provider path>/<name>.

      Parameters

      • name: string
      • Optionalpath: string

      Returns string

    • Sets environment variables from secrets: a path (one variable per secret directly under it) or a mapping { ENV_NAME: "secret/name" }. Returns { envName: secretName } for the variables that were set (never values).

      Parameters

      • source: string | Readonly<Record<string, string>>
      • options: LoadEnvOptions = {}

      Returns Promise<Record<string, string>>