Interface UseGetCubicWebEntityQueryParams<E, EntityType>

Parameters to describe how to build a query to the API.

Type Parameters

  • E extends EntityRawSchemaArray

  • EntityType extends E[number]["type"]

Hierarchy

  • UseGetCubicWebEntityQueryParams

Properties

eid includeObjectRelations? omittedFields? type

Properties

eid

eid: number

The eid of the entity you want to fetch.

Optional includeObjectRelations

includeObjectRelations?: boolean

True if you want to include object relations. Defaults to false.

Optional omittedFields

omittedFields?: string[]

Which attributes/relations you want to ignore while fetching the entity.

type

type: EntityType

The entity type you want to fetch. Allows the lib to know which entity schema to return.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc