Skip to main content

Interface: EndpointParams

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:11

The base interface for defining endpoint parameters

Strategies should define type with the actually supported EndPointParams

Extended by

Indexable

[k: string]: unknown

Properties

_embed?

optional _embed: boolean

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data


_fields?

optional _fields: string[]

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

The _fields parameter is used to return only the specified fields in the response


lang?

optional lang: string

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

The polylang ?lang parameter.

This is only used if the polylang integration is enabled


optimizeYoastPayload?

optional optimizeYoastPayload: boolean

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:36

The custom parameter to optimize the Yoast payload.

This is only used if the YoastSEO integration is enabled