ClientConfig

Type Alias: ClientConfig

ClientConfig = object

Defined in: packages/fetch-kit/src/types.ts:156

Configuration for createClient.

Properties

auth?

optional auth?: AuthFn

Defined in: packages/fetch-kit/src/types.ts:175

Resolve the credential to attach to each request.

Returns the full Authorization header value (e.g. "Bearer xyz", "Basic dXNlcjpwYXNz", "Token xyz", or a raw key). Return an object to set a custom header (X-Api-Key, etc.) or to split scheme + token. Return null/undefined to skip auth for the request.

See

AuthResult

---

baseUrl?

optional baseUrl?: string

Defined in: packages/fetch-kit/src/types.ts:158

Base URL prepended to relative paths. e.g. "https://api.example.com"

---

cache?

optional cache?: boolean | CacheConfig

Defined in: packages/fetch-kit/src/types.ts:189

Enable response caching. Pass true to use defaults, an object to tune, or omit to disable. Caching applies to GET requests and GraphQL queries by default; mutations are never cached.

---

dedupe?

optional dedupe?: boolean

Defined in: packages/fetch-kit/src/types.ts:195

Enable in-flight request deduplication. When two identical GET or query requests fire concurrently, both await a single underlying fetch. Defaults to true.

---

fetch?

optional fetch?: typeof fetch

Defined in: packages/fetch-kit/src/types.ts:183

Custom fetch implementation. Defaults to global fetch.

---

graphqlEndpoint?

optional graphqlEndpoint?: string

Defined in: packages/fetch-kit/src/types.ts:200

GraphQL endpoint path or absolute URL. Required for Client.graphql unless an explicit url is passed per request.

---

headers?

optional headers?: Record<string, string>

Defined in: packages/fetch-kit/src/types.ts:164

Default headers merged into every request.

---

onError?

optional onError?: (error) => void

Defined in: packages/fetch-kit/src/types.ts:177

Hook called when any request errors. Useful for telemetry.

Parameters

error

unknown

Returns

void

---

requestInterceptors?

optional requestInterceptors?: RequestInterceptor[]

Defined in: packages/fetch-kit/src/types.ts:179

Request interceptors run in order.

---

responseInterceptors?

optional responseInterceptors?: ResponseInterceptor[]

Defined in: packages/fetch-kit/src/types.ts:181

Response interceptors run in order.

---

retry?

optional retry?: RetryConfig

Defined in: packages/fetch-kit/src/types.ts:162

Default retry configuration.

---

timeout?

optional timeout?: number

Defined in: packages/fetch-kit/src/types.ts:160

Default request timeout in milliseconds. Defaults to 30000.