JsonApiClientOptions
Defined in: packages/json-api-client/src/types.ts:6
Extends ApiClientOptions to add JSON:API Specific options.
Extends
Section titled “Extends”ApiClientOptions
Properties
Section titled “Properties”apiPrefix?
Section titled “apiPrefix?”optional apiPrefix?: string;Defined in: packages/api-client/dist/index.d.mts:15
The base path for the JSON:API endpoint
Inherited from
Section titled “Inherited from”ApiClientOptions.apiPrefixauthentication?
Section titled “authentication?”optional authentication?: Authentication;Defined in: packages/api-client/dist/index.d.mts:32
The authentication configuration to use for authenticated API requests.
Inherited from
Section titled “Inherited from”ApiClientOptions.authenticationcache?
Section titled “cache?”optional cache?: Cache;Defined in: packages/api-client/dist/index.d.mts:20
Default cache implementation Cache
Inherited from
Section titled “Inherited from”ApiClientOptions.cachecustomFetch?
Section titled “customFetch?”optional customFetch?: (input, init?) => Promise<Response>;Defined in: packages/api-client/dist/index.d.mts:28
Custom fetch method overrides fetch in the ApiClient
Parameters
Section titled “Parameters”URL | RequestInfo
input to the customFetch
RequestInit
additional configuration for the request like the method to use, headers, etc.
Returns
Section titled “Returns”a Response wrapped in a promise
https://developer.mozilla.org/en-US/docs/Web/API/fetch
Inherited from
Section titled “Inherited from”ApiClientOptions.customFetchdebug?
Section titled “debug?”optional debug?: boolean;Defined in: packages/api-client/dist/index.d.mts:52
If true, logs debug messages to the console.
Inherited from
Section titled “Inherited from”ApiClientOptions.debugdecoupledRouterApiPrefix?
Section titled “decoupledRouterApiPrefix?”optional decoupledRouterApiPrefix?: string;Defined in: packages/json-api-client/src/types.ts:14
The api prefix to use for decoupled router
defaultLocale?
Section titled “defaultLocale?”optional defaultLocale?: string;Defined in: packages/api-client/dist/index.d.mts:37
The default locale to use for all API requests.
Locale
Inherited from
Section titled “Inherited from”ApiClientOptions.defaultLocaleindexLookup?
Section titled “indexLookup?”optional indexLookup?: boolean;Defined in: packages/json-api-client/src/types.ts:10
If true, the client will use the JSON:API index endpoint to discover the available resources.
logger?
Section titled “logger?”optional logger?: object;Defined in: packages/api-client/dist/index.d.mts:46
Represents a logger object with optional logging methods for various log levels.
debug?
Section titled “debug?”optional debug?: LogMethod;error?
Section titled “error?”optional error?: LogMethod;optional http?: LogMethod;optional info?: LogMethod;silly?
Section titled “silly?”optional silly?: LogMethod;verbose?
Section titled “verbose?”optional verbose?: LogMethod;optional warn?: LogMethod;Inherited from
Section titled “Inherited from”ApiClientOptions.loggerserializer?
Section titled “serializer?”optional serializer?: Serializer;Defined in: packages/api-client/dist/index.d.mts:42
Custom serializer to use for deserializing api response.
Inherited from
Section titled “Inherited from”ApiClientOptions.serializer