OpenDecree TypeScript SDK - v0.3.0-alpha.1
    Preparing search index...

    Interface ClientOptions

    Options for configuring a ConfigClient.

    interface ClientOptions {
        insecure?: boolean;
        retry?: false | RetryConfig;
        role?: string;
        subject?: string;
        tenantId?: string;
        timeout?: number;
        tls?: TlsOptions;
        token?: string;
    }
    Index

    Properties

    insecure? retry? role? subject? tenantId? timeout? tls? token?

    Properties

    insecure?: boolean

    Use plaintext (no TLS). Default: false. Set to true only for local/dev servers without TLS.

    retry?: false | RetryConfig

    Retry configuration. Set to false to disable retry. Default: RetryConfig defaults.

    role?: string

    Role for x-role metadata header. Default: "superadmin".

    subject?: string

    Identity for x-subject metadata header.

    tenantId?: string

    Default tenant for x-tenant-id metadata header.

    timeout?: number

    Default per-RPC timeout in milliseconds. Default: 10000.

    tls?: TlsOptions

    TLS credential overrides: custom CA, or client cert/key for mTLS. Ignored when insecure is true.

    token?: string

    Bearer token. When set, metadata headers are not sent.

    Settings

    Member Visibility

    On This Page

    Properties