Class ReadonlyEntity<TFields, TIDField, 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 Record<string, any>
TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>
TViewerContext extends ViewerContext
TSelectedFields extends keyof TFields = keyof TFields

Hierarchy (View Summary)

ReadonlyEntity
- Entity

Index

Methods

associationLoader associationLoaderWithAuthorizationResults getAllDatabaseFields getAllFields getField getID getUniqueIdentifier getViewerContext toString loader loaderUtils loaderWithAuthorizationResults

Methods

associationLoader

associationLoader(
    queryContext?: EntityQueryContext,
): EnforcingEntityAssociationLoader<
    TFields,
    TIDField,
    TViewerContext,
    ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TSelectedFields,
>
Parameters
- OptionalqueryContext: EntityQueryContext
Returns EnforcingEntityAssociationLoader<
    TFields,
    TIDField,
    TViewerContext,
    ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TSelectedFields,
>
EnforcingEntityAssociationLoader for this entity
- Defined in packages/entity/src/ReadonlyEntity.ts:92

associationLoaderWithAuthorizationResults

associationLoaderWithAuthorizationResults(
    queryContext?: EntityQueryContext,
): AuthorizationResultBasedEntityAssociationLoader<
    TFields,
    TIDField,
    TViewerContext,
    ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TSelectedFields,
>
Parameters
- OptionalqueryContext: EntityQueryContext
Returns AuthorizationResultBasedEntityAssociationLoader<
    TFields,
    TIDField,
    TViewerContext,
    ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TSelectedFields,
>
AuthorizationResultBasedEntityAssociationLoader for this entity
- Defined in packages/entity/src/ReadonlyEntity.ts:104

getAllDatabaseFields

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

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:133

getField

getField<K extends string | number | symbol>(
fieldName: K,
): 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:124

getID

getID(): TFields[TIDField]
Returns TFields[TIDField]
the ID of this entity
- Defined in packages/entity/src/ReadonlyEntity.ts:85

getUniqueIdentifier

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

getViewerContext

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

toString

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

`Static`loader

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

`Static`loaderUtils

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

`Static`loaderWithAuthorizationResults

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

Class ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Methods

Methods

associationLoader

Parameters

Returns EnforcingEntityAssociationLoader< TFields, TIDField, TViewerContext, ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>, TSelectedFields,>

associationLoaderWithAuthorizationResults

Parameters

Returns AuthorizationResultBasedEntityAssociationLoader< TFields, TIDField, TViewerContext, ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>, TSelectedFields,>

getAllDatabaseFields

Returns Readonly<TFields>

getAllFields

Returns Readonly<Pick<TFields, TSelectedFields>>

getField

Type Parameters

Parameters

Returns Pick<TFields, TSelectedFields>[K]

getID

Returns TFields[TIDField]

getUniqueIdentifier

Returns string

getViewerContext

Returns TViewerContext

toString

Returns string

Staticloader

Type Parameters

Parameters

Returns EnforcingEntityLoader< TMFields, TMIDField, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields,>

StaticloaderUtils

Type Parameters

Parameters

Returns EntityLoaderUtils< TMFields, TMIDField, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields,>

StaticloaderWithAuthorizationResults

Type Parameters

Parameters

Returns AuthorizationResultBasedEntityLoader< TMFields, TMIDField, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields,>

Settings

On This Page

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

Returns EnforcingEntityAssociationLoader<
TFields,
TIDField,
TViewerContext,
ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
TSelectedFields,
>

Returns AuthorizationResultBasedEntityAssociationLoader<
TFields,
TIDField,
TViewerContext,
ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
TSelectedFields,
>

`Static`loader

Returns EnforcingEntityLoader<
TMFields,
TMIDField,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields,
>

`Static`loaderUtils

Returns EntityLoaderUtils<
TMFields,
TMIDField,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields,
>

`Static`loaderWithAuthorizationResults

Returns AuthorizationResultBasedEntityLoader<
TMFields,
TMIDField,
TMViewerContext,
TMEntity,
TMPrivacyPolicy,
TMSelectedFields,
>