DeleteOptions
Defined in: packages/json-api-client/src/types.ts:148
Options for customizing the delete request.
Extends
Section titled “Extends”Properties
Section titled “Properties”cacheKey?
Section titled “cacheKey?”optional cacheKey?: string;Defined in: packages/json-api-client/src/types.ts:58
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.
Inherited from
Section titled “Inherited from”disableAuthentication?
Section titled “disableAuthentication?”optional disableAuthentication?: boolean;Defined in: packages/json-api-client/src/types.ts:53
Whether to disable the authentication for the request.
Inherited from
Section titled “Inherited from”RequestBaseOptions.disableAuthentication
disableCache?
Section titled “disableCache?”optional disableCache?: boolean;Defined in: packages/json-api-client/src/types.ts:48
Whether to disable the cache for the request.
Inherited from
Section titled “Inherited from”RequestBaseOptions.disableCache
locale?
Section titled “locale?”optional locale?: string;Defined in: packages/json-api-client/src/types.ts:38
The locale to use for the request, targeting exactly one translation.
Sent as the /{locale}/ URL path prefix (see
JsonApiClientOptions.languagePathPrefix) and as the langCode
query parameter, the jsonapi_multilingual module’s language selector.
If not set, the default locale will be used.
If no default locale is set, no locale will be used.
Inherited from
Section titled “Inherited from”rawResponse?
Section titled “rawResponse?”optional rawResponse?: boolean;Defined in: packages/json-api-client/src/types.ts:43
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.