@edgible-team/sdk
    Preparing search index...

    Interface ClientConfig

    Options for createClient (api-design.md §2). Everything is optional — the zero-config client targets prod and resolves credentials via the provider chain.

    interface ClientConfig {
        baseUrl?: string;
        credentialProvider?: CredentialProvider;
        credentials?: CredentialInput;
        credentialStore?: CredentialStore;
        env?: "local" | "dev" | "test" | "uat" | "prod";
        logger?: Logger;
        middleware?: Middleware[];
        retry?: Partial<RetryPolicy>;
        transport?: Transport;
        wsUrl?: string;
    }
    Index

    Properties

    baseUrl? credentialProvider? credentials? credentialStore? env? logger? middleware? retry? transport? wsUrl?

    Properties

    baseUrl?: string

    Explicit base URL; overrides env.

    credentialProvider?: CredentialProvider

    Replace the default provider chain (explicit → env → store → metadata).

    credentials?: CredentialInput

    Explicit credentials; otherwise resolved via the provider chain.

    credentialStore?: CredentialStore

    Replace the token store. Default: file-backed on Node (shared with the CLI), in-memory in browsers.

    env?: "local" | "dev" | "test" | "uat" | "prod"

    Target stage; resolves the base URL. Default: env EDGIBLE_ENV, else 'prod'.

    logger?: Logger

    Receive SDK diagnostics. Default: noopLogger (the SDK never uses console).

    middleware?: Middleware[]

    Extra middleware appended after the defaults.

    retry?: Partial<RetryPolicy>

    Retry policy overrides (defaults: exponential backoff + jitter, 4 attempts).

    transport?: Transport

    Replace the wire layer. Default: FetchTransport.

    wsUrl?: string

    Explicit realtime wss/ws URL; overrides derivation from baseUrl. Used only by the agent/realtime client.

    Settings

    Member Visibility

    On This Page

    Properties