Skip to main content

Interface: EndpointParams

@headstartwp/core.EndpointParams

The base interface for defining endpoint parameters

Strategies should define type with the actually supported EndPointParams

Hierarchy

Indexable

[k: string]: unknown

Properties

_embed

Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Defined in

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


_fields

Optional _fields: string[]

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

Defined in

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


lang

Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Defined in

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