QueryEntitiesInitialRequest

Home > @backstage/catalog-client > QueryEntitiesInitialRequest

A request type for CatalogClient.queryEntities(). The method takes this type in an initial pagination request, when requesting the first batch of entities.

The properties filter, sortField, query and sortFieldOrder, are going to be immutable for the entire lifecycle of the following requests.

Signature:

export type QueryEntitiesInitialRequest = {
    fields?: string[];
    limit?: number;
    offset?: number;
    filter?: EntityFilterQuery;
    orderFields?: EntityOrderQuery;
    fullTextFilter?: {
        term: string;
        fields?: string[];
    };
};

References: EntityFilterQuery, EntityOrderQuery