Skip to main content

Type alias: HttpAdapterConfig<Data>

HttpAdapterConfig<Data>: object

The configuration for the HTTP adapter implementation.

Type parameters

Data = any

Type declaration

appendHeaders()?

optional appendHeaders: (context) => Awaitable <Dictionary<string>>

Parameters

context

Returns

Awaitable <Dictionary<string>>

appendParams()?

optional appendParams: (context) => Awaitable <Dictionary<any>>

Parameters

context

Returns

Awaitable <Dictionary<any>>

baseURL?

optional baseURL: string | null

buildURL()?

optional buildURL: (urlContext, context) => string

Parameters

urlContext: HttpURLContext

context

Returns

string

defaultBodyAs?

optional defaultBodyAs: BodyAsTransformer | null

defaultHeaders?

optional defaultHeaders: Dictionary<string>

defaultResponseReader?

optional defaultResponseReader: HttpResponseReader<Data>

errorTransformers?

optional errorTransformers: ErrorTransformer[]

fetch?

optional fetch: typeof fetch

idPathTransformer?

optional idPathTransformer: Transformer<string>

modelPathTransformer?

optional modelPathTransformer: Transformer<string>

relationPathTransformer?

optional relationPathTransformer: Transformer<string>

requestTransformers?

optional requestTransformers: RequestTransformer[]

responseTransformers?

optional responseTransformers: ResponseTransformer[]

serializeParams

serializeParams: HttpParamsSerializer

Source

packages/http/src/types.ts:81