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.

Index

Constructors

Properties

globalMutationTriggers metricsAdapter

Methods

getCompanionForEntity getQueryContextProviderForDatabaseAdaptorFlavor

Constructors

constructor

new EntityCompanionProvider(metricsAdapter, databaseAdapterFlavors, cacheAdapterFlavors, globalMutationTriggers?): EntityCompanionProvider
Instantiate an Entity framework.
Parameters
- metricsAdapter: IEntityMetricsAdapter
  An IEntityMetricsAdapter for collecting metrics on this instance
- databaseAdapterFlavors: ReadonlyMap<string, DatabaseAdapterFlavorDefinition>
  Database adapter configurations for this instance
- cacheAdapterFlavors: ReadonlyMap<string, CacheAdapterFlavorDefinition>
  Cache adapter configurations for this instance
- globalMutationTriggers: EntityMutationTriggerConfiguration<any, any, any, any, any> = {}
  Optional set of EntityMutationTrigger to run for all entity mutations systemwide.
Returns EntityCompanionProvider
- Defined in packages/entity/src/EntityCompanionProvider.ts:144

Properties

`Readonly`globalMutationTriggers

globalMutationTriggers: EntityMutationTriggerConfiguration<any, any, any, any, any> = {}

Optional set of EntityMutationTrigger to run for all entity mutations systemwide.

`Readonly`metricsAdapter

metricsAdapter: IEntityMetricsAdapter

An IEntityMetricsAdapter for collecting metrics on this instance

Methods

getCompanionForEntity

getCompanionForEntity<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>(entityClass): EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
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
- TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields>
- 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>
- Defined in packages/entity/src/EntityCompanionProvider.ts:169

getQueryContextProviderForDatabaseAdaptorFlavor

getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdapterFlavor): EntityQueryContextProvider
Parameters
- databaseAdapterFlavor: string
Returns EntityQueryContextProvider
- Defined in packages/entity/src/EntityCompanionProvider.ts:211