Type Alias JsonApiOptions

JsonApiOptions: { deserialize?: boolean; params?: JsonApiParams } & JsonApiWithAuthOption & (
| { defaultLocale: Locale; locale: Locale }
| { defaultLocale?: never; locale?: undefined }
)

JSON:API Related Options

Type declaration

Optionaldeserialize?: boolean
Set to false to return the raw JSON:API response.
Optionalparams?: JsonApiParams
JSON:API params such as filter, fields, include or sort.

{ defaultLocale: Locale; locale: Locale }
- defaultLocale: Locale
  The default locale of the site.
- locale: Locale
  The locale to fetch the resource in.
{ defaultLocale?: never; locale?: undefined }