Class ViewerScopedEntityCompanionProvider

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

Hierarchy

  • ViewerScopedEntityCompanionProvider

Constructors

constructor

Properties

entityCompanionProvider viewerContext

Methods

getViewerScopedCompanionForEntity

Constructors

constructor

Properties

Private Readonly entityCompanionProvider

entityCompanionProvider: EntityCompanionProvider

Private Readonly viewerContext

viewerContext: ViewerContext

Methods

getViewerScopedCompanionForEntity

  • 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<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 ViewerScopedEntityCompanion<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc