Class EntityCompanionProvider

An instance of the Entity framework.

Required to create a ViewerContext, which is the application entry point into the framework.

Internally, this is a lazy entity companion factory that instantiates and caches one EntityCompanion for each type of Entity.

Hierarchy

  • EntityCompanionProvider

Constructors

constructor

Properties

cacheAdapterFlavors companionDefinitionMap companionMap databaseAdapterFlavors metricsAdapter tableDataCoordinatorMap

Methods

getCompanionForEntity getQueryContextProviderForDatabaseAdaptorFlavor getTableDataCoordinatorForEntity

Constructors

constructor

Properties

Private cacheAdapterFlavors

cacheAdapterFlavors: ReadonlyMap<string, CacheAdapterFlavorDefinition>

Cache adapter configurations for this instance

Private Readonly companionDefinitionMap

companionDefinitionMap: Map<string, EntityCompanionDefinition<any, any, any, any, any, any>> = ...

Private Readonly companionMap

companionMap: Map<string, EntityCompanion<any, any, any, any, any, any>> = ...

Private databaseAdapterFlavors

databaseAdapterFlavors: ReadonlyMap<string, DatabaseAdapterFlavorDefinition>

Database adapter configurations for this instance

Readonly metricsAdapter

metricsAdapter: IEntityMetricsAdapter

An IEntityMetricsAdapter for collecting metrics on this instance

Private Readonly tableDataCoordinatorMap

tableDataCoordinatorMap: Map<string, default<any>> = ...

Methods

getCompanionForEntity

  • Get the entity companion for specified entity. If not already computed and cached, the entity companion is constructed using the configuration provided by the factory.

    Type Parameters

    • TFields extends object

    • TID extends {}

    • TViewerContext extends ViewerContext<TViewerContext>

    • TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields, TEntity>

    • TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields, TPrivacyPolicy>

    • TSelectedFields extends string | number | symbol

    Parameters

    • entityClass: IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

      entity class to load

    Returns EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

getQueryContextProviderForDatabaseAdaptorFlavor

Private getTableDataCoordinatorForEntity

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc