- Preparing search index...
- The search index is not available
Entity
Interface IEntityClass<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Type Parameters
-
TFields extends object
-
TID extends NonNullable<TFields[TSelectedFields]>
-
-
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
-
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields>
-
TSelectedFields extends keyof TFields = keyof TFields
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
Methods
defineCompanionDefinition
- defineCompanionDefinition(): EntityCompanionDefinition<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
-
Returns EntityCompanionDefinition<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
An interface to pass in constructor (class) of an Entity as a function argument.