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

    Interface OpenBaoConfigOptions

    Options accepted by OpenBaoConfig (all optional).

    interface OpenBaoConfigOptions {
        connectTimeoutMs?: number;
        headers?: Record<string, string>;
        hooks?: Hooks;
        kvMount?: string;
        kvVersion?: KvVersion;
        logger?: ClientLogger;
        namespace?: string;
        proxy?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        secretsPath?: string;
        tls?: TlsOptions;
        token?: string | Secret;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
        valueField?: string;
    }

    Hierarchy (View Summary)

    Index
    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    kvMount?: string

    Default KV mount used by client.kv() and client.secrets() (default "secret").

    kvVersion?: KvVersion

    KV version of every mount, skipping auto-detection (sys/internal/ui/mounts). Set it for tokens that cannot read the mount preflight endpoint. Default: auto-detect per mount.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    namespace?: string

    Namespace sent as X-Vault-Namespace (env GROW_OPENBAO_NAMESPACE, BAO_NAMESPACE, VAULT_NAMESPACE).

    proxy?: string

    Proxy URL. Environment proxies (HTTPS_PROXY, …) are ignored unless set here.

    requestTimeoutMs?: number

    Per-attempt timeout in ms, headers + body (default 30 000).

    Retry policy or its options.

    secretsPath?: string

    Base path inside the KV mount under which client.secrets() stores secrets (env GROW_OPENBAO_SECRETS_PATH, default "" = the mount root).

    TLS settings.

    token?: string | Secret

    Client token sent as X-Vault-Token (env GROW_OPENBAO_TOKEN, BAO_TOKEN, VAULT_TOKEN). Leave it unset when the client logs in with an auth method (client.auth.login(...)).

    totalTimeoutMs?: number

    Whole-call timeout in ms including retries and backoff (default 120 000).

    url?: string

    Endpoint base URL.

    userAgentSuffix?: string

    Appended after the standard User-Agent.

    valueField?: string

    KV data field that holds a client.secrets() value (default "value").