Skip to main content

Interface: SchemaRegistryController

This controller is in charge of resolving the entity schemas from a given path. It takes into account the navigation prop set in the main level of the FireCMS app as well as the schemaResolver in case you want to override schemas to specific entities.

Properties#

getCollectionConfig#

getCollectionConfig: (path: string, entityId?: string) => undefined | EntityCollection<any, string>

Get props for path

Type declaration#

▸ (path, entityId?): undefined | EntityCollection<any, string>

Parameters#
NameType
pathstring
entityId?string
Returns#

undefined | EntityCollection<any, string>

Defined in#

models/schema_registry_controller.tsx:24


getSchemaConfig#

getSchemaConfig: (path: string, entityId?: string) => undefined | SchemaConfig<any>

Get props for path

Type declaration#

▸ (path, entityId?): undefined | SchemaConfig<any>

Parameters#
NameType
pathstring
entityId?string
Returns#

undefined | SchemaConfig<any>

Defined in#

models/schema_registry_controller.tsx:19


initialised#

initialised: boolean

Is the registry ready to be used

Defined in#

models/schema_registry_controller.tsx:15


removeAllOverridesExcept#

removeAllOverridesExcept: (keys: string[]) => void

Remove all keys not used

param keys

Type declaration#

▸ (keys): void

Parameters#
NameType
keysstring[]
Returns#

void

Defined in#

models/schema_registry_controller.tsx:40


setOverride#

setOverride: (entityPath: string, schemaConfig: null | Partial<SchemaConfig<any>>, overrideSchemaResolver?: boolean) => undefined | string

Set props for path

returns used key

Type declaration#

▸ (entityPath, schemaConfig, overrideSchemaResolver?): undefined | string

Parameters#
NameType
entityPathstring
schemaConfignull | Partial<SchemaConfig<any>>
overrideSchemaResolver?boolean
Returns#

undefined | string

Defined in#

models/schema_registry_controller.tsx:30