buildCatalog

Function

Build an IHubCatalog definition JSON object based on a well-known catalog name, scope filters, and collections

Parameters

Parameter Type Default Notes
i18nScope Required string

i18n scope for the catalog title

catalogName Required string

well known catalog name

filters Required IFilter[]

filters to build the catalog scope

collections Required IHubCollection[]

collections to include in the catalog

targetEntity Required EntityType

Returns

Property Type Notes
schemaVersion number

Schema Version

collections Optional IHubCollection[]

Collections within the Catalog

scopes Optional ICatalogScope

Filter defines the "scopes" of the Catalog, on a per entity type basis

title Optional string

Title for the Gallery


Function defined in common/src/search/_internal/buildCatalog.ts:13