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

constructor

• new EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>(entityCompanionProvider, entityCompanionDefinition, tableDataCoordinator, metricsAdapter): EntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

• 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

  • entityCompanionProvider: EntityCompanionProvider

  • entityCompanionDefinition: EntityCompanionDefinition<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

  • tableDataCoordinator: default<TFields>

  • metricsAdapter: IEntityMetricsAdapter

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

Readonly entityCompanionDefinition

Readonly entityCompanionProvider

Readonly privacyPolicy

getLoaderFactory

• getLoaderFactory(): EntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

• Returns EntityLoaderFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

getMetricsAdapter

• getMetricsAdapter(): IEntityMetricsAdapter

• Get the IEntityMetricsAdapter for this companion.

  Returns IEntityMetricsAdapter

getMutatorFactory

• getMutatorFactory(): EntityMutatorFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

• Returns EntityMutatorFactory<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

getQueryContextProvider

• getQueryContextProvider(): EntityQueryContextProvider

• Get the query context provider for this entity.

  Returns EntityQueryContextProvider