bothy-sdk
    Preparing search index...

    Interface ApiClientOptions

    Options of createApiClient: openapi-fetch's options plus the hand layer's.

    interface ApiClientOptions {
        clock?: Clock;
        dpopKey?: DpopSigner;
        logger?: Logger;
        retry?: RetryOptions;
        settings?: Partial<SdkSettings>;
        timeoutMs?: number;
        token?: string | Secret;
        userAgent?: string;
    }

    Hierarchy

    • ClientOptions
      • ApiClientOptions
    Index

    Properties

    clock? dpopKey? logger? retry? settings? timeoutMs? token? userAgent?

    Properties

    clock?: Clock

    The time source of proofs, Retry-After dates and waits (default systemClock).

    dpopKey?: DpopSigner

    The key of a DPoP-bound token (a DpopKey or a key store).

    logger?: Logger

    The logger (default defaultLogger; deprecations then go to process.emitWarning).

    retry?: RetryOptions

    Retry options.

    settings?: Partial<SdkSettings>

    Overrides of the SDK settings.

    timeoutMs?: number

    Bound of one attempt in milliseconds (default sdk.http_timeout).

    token?: string | Secret

    The API token; absent sends no Authorization.

    userAgent?: string

    <app>/<version> of the caller, placed before the SDK's own part of User-Agent.

    Settings

    Member Visibility

    On This Page

    Properties