Class ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>`Abstract`

A readonly entity exposes only the read functionality of an Entity. Used as the base type for most entity operations excluding mutations.

This is also useful as a base class for Entities that should not be mutated, such as:

Entities representing SQL views.
Entities representing immutable tables.

Type Parameters

TFields extends object
TID extends NonNullable<TFields[TSelectedFields]>
TViewerContext extends ViewerContext
TSelectedFields extends keyof TFields = keyof TFields

Hierarchy (view full)

ReadonlyEntity
- Entity

Index

Constructors

Methods

associationLoader getAllDatabaseFields getAllFields getField getID getUniqueIdentifier getViewerContext toString loader

Constructors

constructor

new ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>(constructorParam): ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
Internal
Constructs an instance of an Entity.
Type Parameters
- TFields extends object
- TID extends {}
- TViewerContext extends ViewerContext
- TSelectedFields extends string | number | symbol = keyof TFields
Parameters
- constructorParam: {
      databaseFields: Readonly<TFields>;
      id: TID;
      selectedFields: Readonly<Pick<TFields, TSelectedFields>>;
      viewerContext: TViewerContext;
  }
  data needed to construct an instance of an entity viewerContext - the ViewerContext reading this entity id - the ID of this entity databaseFields - all underlying fields for this entity's data selectedFields - selected fields for this entity from TSelectedFields type
  
  This should only be overridden in cases where additional data validation is needed. The params should not be modified when calling super during constructions.
  - databaseFields: Readonly<TFields>
  - id: TID
  - selectedFields: Readonly<Pick<TFields, TSelectedFields>>
  - viewerContext: TViewerContext
Returns ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
- Defined in packages/entity/src/ReadonlyEntity.ts:43

Methods

associationLoader

associationLoader(): EntityAssociationLoader<TFields, TID, TViewerContext, ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>, TSelectedFields>
Returns EntityAssociationLoader<TFields, TID, TViewerContext, ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>, TSelectedFields>
EntityAssociationLoader for this entity
- Defined in packages/entity/src/ReadonlyEntity.ts:87

getAllDatabaseFields

getAllDatabaseFields(): Readonly<TFields>
Returns Readonly<TFields>
all underlying fields from this entity's database data
- Defined in packages/entity/src/ReadonlyEntity.ts:118

getAllFields

getAllFields(): Readonly<Pick<TFields, TSelectedFields>>
Returns Readonly<Pick<TFields, TSelectedFields>>
all underlying fields from this entity's data
- Defined in packages/entity/src/ReadonlyEntity.ts:111

getField

getField<K>(fieldName): Pick<TFields, TSelectedFields>[K]
Get a underlying field from this entity's data
Type Parameters
- K extends string | number | symbol
Parameters
- fieldName: K
  the field to get
Returns Pick<TFields, TSelectedFields>[K]
the value of the field or undefined if not loaded with that field
- Defined in packages/entity/src/ReadonlyEntity.ts:102

getID

getID(): TID
Returns TID
the ID of this entity
- Defined in packages/entity/src/ReadonlyEntity.ts:80

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
- Defined in packages/entity/src/ReadonlyEntity.ts:66

getViewerContext

getViewerContext(): TViewerContext
Returns TViewerContext
the ViewerContext authorized to read this entity
- Defined in packages/entity/src/ReadonlyEntity.ts:73

toString

toString(): string
Returns string
- Defined in packages/entity/src/ReadonlyEntity.ts:62

`Static`loader

loader<TMFields, TMID, TMViewerContext, TMViewerContext2, TMEntity, TMPrivacyPolicy, TMSelectedFields>(this, viewerContext, queryContext?): EntityLoader<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields>
Vend loader for loading an entity in a given query context.
Type Parameters
- TMFields extends object
- TMID extends {}
- TMViewerContext extends ViewerContext
- TMViewerContext2 extends ViewerContext
- TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>
- TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity, TMSelectedFields>
- TMSelectedFields extends string | number | symbol = keyof TMFields
Parameters
- this: IEntityClass<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields>
- viewerContext: TMViewerContext2
  viewer context of loading user
- queryContext: EntityQueryContext = ...
  query context in which to perform the load
Returns EntityLoader<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields>
- Defined in packages/entity/src/ReadonlyEntity.ts:127