@mywebapi.com/sdk - v0.3.5
    Preparing search index...

    Interface CPluginWebApiClientOptions

    interface CPluginWebApiClientOptions {
        clientId: string;
        clientSecret: string;
        fetch?: typeof fetch;
        requestTimeout?: number;
        retry?: Partial<RetryPolicy>;
        scopes?: readonly string[];
        timeoutMs?: number;
    }
    Index
    clientId clientSecret fetch? requestTimeout? retry? scopes? timeoutMs?
    clientId: string
    clientSecret: string
    fetch?: typeof fetch

    Inject a custom fetch implementation (testing / Bun / Node polyfill).

    requestTimeout?: number

    Client-wide server timeout in seconds (1–300), sent as X-Request-Timeout to every operation that accepts it. A per-call requestTimeout overrides it. Omit to use each operation's server default (trade 5 s, read 10 s, change 15 s, history 30 s, maintenance 60 s).

    retry?: Partial<RetryPolicy>

    Override individual retry-policy fields.

    scopes?: readonly string[]
    timeoutMs?: number

    Minimum client deadline per request in milliseconds, covering token acquisition, the request and the response body. Defaults to 30 seconds. For operations with a server timeout the deadline is extended automatically to that timeout plus 30 s, so the server's Timeout / OutcomeUnknown / Busy answer is received rather than cut off by a local abort.

    Settings
    Member Visibility

    On This Page
    Properties