Skip to content

RequestBaseOptions

Defined in: packages/json-api-client/src/types.ts:20

Base options for customizing each request.

optional cacheKey?: string;

Defined in: packages/json-api-client/src/types.ts:46

The cache key to use for the request. If not set, the default cache key of {lang}-{locale}--{entity}--{bundle}--{sha256 hash of query string if exists} will be used.


optional disableAuthentication?: boolean;

Defined in: packages/json-api-client/src/types.ts:41

Whether to disable the authentication for the request.


optional disableCache?: boolean;

Defined in: packages/json-api-client/src/types.ts:36

Whether to disable the cache for the request.


optional locale?: string;

Defined in: packages/json-api-client/src/types.ts:26

The locale to use for the request. If not set, the default locale will be used. If no default locale is set, no locale will be used.


optional rawResponse?: boolean;

Defined in: packages/json-api-client/src/types.ts:31

Indicates whether the raw HTTP response should be returned. When set to true, the response will not be parsed or processed, providing the raw, unaltered response from the server.