getWellKnownCatalog

Function

Get a single catalog based on the catalog name, entity type and optional requests

Parameters

Parameter Type Default Notes
i18nScope Required string

Translation scope to be interpolated into the catalog

catalogName Required WellKnownCatalog
entityType Required EntityType
options Optional IGetWellKnownCatalogOptions

An opitional IGetWellKnownCatalogOptions definition JSON object

Returns

An IHubCatalog definition JSON object

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/wellKnownCatalog.ts:63