Skip to content
Drupal API Client

GetOptions

Options for customizing the get request.

Extends

Properties

cacheKey?

optional cacheKey: string;

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

RequestBaseOptions.cacheKey

Source

json-api-client/src/types.ts:46

disableAuthentication?

optional disableAuthentication: boolean;

Whether to disable the authentication for the request.

Inherited from

RequestBaseOptions.disableAuthentication

Source

json-api-client/src/types.ts:41

disableCache?

optional disableCache: boolean;

Whether to disable the cache for the request.

Inherited from

RequestBaseOptions.disableCache

Source

json-api-client/src/types.ts:36

locale?

optional locale: string;

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.

Inherited from

RequestBaseOptions.locale

Source

json-api-client/src/types.ts:26

queryString?

optional queryString: string;

A URL encoded query string to append to the request. See https://www.drupal.org/docs/core-modules-and-themes/core-modules/jsonapi-module/fetching-resources-get for some examples of valid query strings.

Remarks

To help generate a valid query string, use a library like drupal-jsonapi-params https://www.npmjs.com/package/drupal-jsonapi-params and the toQueryString method.

Example

const options = {
 queryString: "filter[title][value]=My%20recipe",
};

Source

json-api-client/src/types.ts:64

rawResponse?

optional rawResponse: boolean;

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.

Inherited from

RequestBaseOptions.rawResponse

Source

json-api-client/src/types.ts:31