Interface LibraryAPIOptions

interface LibraryAPIOptions {
    GraphQL?: {
        withCredentials?: boolean;
        headers?(options?): Promise<Record<string, unknown> | Headers>;
    };
    REST?: {
        defaultAuthMode?: RESTAuthMode;
        retryStrategy?: RetryStrategy;
        headers?(options): Promise<Headers>;
        timeout?(options): number;
    };
}

Properties

GraphQL? REST?

Properties

Optional GraphQL

GraphQL?: {
    withCredentials?: boolean;
    headers?(options?): Promise<Record<string, unknown> | Headers>;
}

Type declaration

  • Optional withCredentials?: boolean
  • headers?:function
    • headers(options?): Promise<Record<string, unknown> | Headers>

    • custom headers for given GraphQL service. Will be applied to all operations.

      Parameters

      Returns Promise<Record<string, unknown> | Headers>

Optional REST

REST?: {
    defaultAuthMode?: RESTAuthMode;
    retryStrategy?: RetryStrategy;
    headers?(options): Promise<Headers>;
    timeout?(options): number;
}

Type declaration

  • Optional defaultAuthMode?: RESTAuthMode

    Default auth mode for REST API calls when no explicit auth is provided.

  • Optional retryStrategy?: RetryStrategy

    Retry strategy for the REST API calls.

    Default

    { strategy: 'jittered-exponential-backoff' }

  • headers?:function
    • headers(options): Promise<Headers>

    • custom headers for given REST service. Will be applied to all operations.

      Parameters

      • options: {
            apiName: string;
        }
        • apiName: string

      Returns Promise<Headers>

  • timeout?:function
    • timeout(options): number

    • custom timeout in milliseconds configurable for given REST service, or/and method.

      Parameters

      • options: {
            apiName: string;
            method: string;
        }
        • apiName: string
        • method: string

      Returns number

Settings

Member Visibility

Theme

On This Page