Interface IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

An interface to pass in constructor (class) of an Entity as a function argument.

interface IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
    new IEntityClassnew (constructorParam: {
        databaseFields: Readonly<TFields>;
        id: TID;
        selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
        viewerContext: TViewerContext;
    }): TEntity;
    defineCompanionDefinition(): EntityCompanionDefinition<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>;
}

Type Parameters

TFields extends object
TID extends NonNullable<TFields[TSelectedFields]>
TViewerContext extends ViewerContext
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields>
TSelectedFields extends keyof TFields = keyof TFields

Index

Constructors

Methods

defineCompanionDefinition

Constructors

constructor

new IEntityClass(constructorParam): TEntity
Parameters
- constructorParam: {
      databaseFields: Readonly<TFields>;
      id: TID;
      selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
      viewerContext: TViewerContext;
  }
  - databaseFields: Readonly<TFields>
  - id: TID
  - selectedFields: Readonly<Pick<TFields, TSelectedFields>>
  - viewerContext: TViewerContext
Returns TEntity
- Defined in packages/entity/src/Entity.ts:219

Methods

defineCompanionDefinition

defineCompanionDefinition(): EntityCompanionDefinition<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Returns a EntityCompanionDefinition for this entity.

Memoized by the entity framework.

Returns EntityCompanionDefinition<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/Entity.ts:231