Interface HttpProviderConfig<T>

Type Parameters

Hierarchy

  • HttpProviderConfig

Properties

adapter? apiVersion axiosOptions? baseUrl logger mapError? paths responseTransformers? serviceSlug

Properties

Optional adapter

adapter?: AxiosAdapter

This adapter that allows to you to modify the way Axios make requests.

apiVersion

apiVersion: string

The OpenApi version, which forms part of the URL scheme

Optional axiosOptions

axiosOptions?: AxiosRequestConfig<any>

Additional request options passed to axios

baseUrl

baseUrl: string

Example: "http://localhost:3000"

logger

logger: Logger

Logger strategy.

Optional mapError

mapError?: ((error: unknown, method: keyof T) => unknown)

Type declaration

    • (error: unknown, method: keyof T): unknown

    • Custom error handling: Either:

      • interpret error as valid response by mapping it to response type and returning it
      • map error to a new Error type by throwing it

      Parameters

      • error: unknown

        response body parsed as JSON

      • method: keyof T

        provider method name

      Returns unknown

paths

paths: HttpProviderConfigPaths<T>

A mapping between provider method names and url paths. Paths have to use /leadingSlash

Optional responseTransformers

responseTransformers?: ResponseTransformers<T>

Transform responses

serviceSlug

serviceSlug: string

Slug used in the URL path

Settings

Member Visibility

Theme

Generated using TypeDoc