Class ViewerScopedEntityCompanionProvider

Provides viewer-scoped entity companions providers for a simpler API.

Constructors

getViewerScopedCompanionForEntity<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>(entityClass): ViewerScopedEntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Vend a new viewer-scoped entity companion. 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 ViewerScopedEntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/ViewerScopedEntityCompanionProvider.ts:23