ApiClientOptions: {
    apiPrefix?: string;
    authentication?: Authentication;
    cache?: Cache;
    customFetch?: ((input, init?) => Promise<Response>);
    debug?: boolean;
    defaultLocale?: Locale;
    logger?: {
        [key in LogLevels]?: LogMethod
    };
    serializer?: Serializer;
}

Type declaration

  • Optional apiPrefix?: string

    The base path for the JSON:API endpoint

  • Optional authentication?: Authentication

    The authentication configuration to use for authenticated API requests.

  • Optional cache?: Cache

    Default cache implementation Cache

  • Optional customFetch?: ((input, init?) => Promise<Response>)
  • Optional debug?: boolean

    If true, logs debug messages to the console.

  • Optional defaultLocale?: Locale

    The default locale to use for all API requests.

    See

    Locale

  • Optional logger?: {
        [key in LogLevels]?: LogMethod
    }

    Represents a logger object with optional logging methods for various log levels.

  • Optional serializer?: Serializer

    Custom serializer to use for deserializing api response.

Generated using TypeDoc