Interface EntityLoadThroughDirective<TViewerContext, TFields, TAssociatedFields, TAssociatedID, TAssociatedEntity, TAssociatedPrivacyPolicy, TSelectedFields, TAssociatedSelectedFields>

Instruction for each step of a load-associated-through method.

Type Parameters

  • TViewerContext extends ViewerContext

  • TFields

  • TAssociatedFields extends object

  • TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>

  • TAssociatedEntity extends ReadonlyEntity<TAssociatedFields, TAssociatedID, TViewerContext, TAssociatedSelectedFields>

  • TAssociatedPrivacyPolicy extends EntityPrivacyPolicy<TAssociatedFields, TAssociatedID, TViewerContext, TAssociatedEntity, TAssociatedSelectedFields>

  • TSelectedFields extends keyof TFields = keyof TFields

  • TAssociatedSelectedFields extends keyof TAssociatedFields = keyof TAssociatedFields

Hierarchy

  • EntityLoadThroughDirective

Properties

associatedEntityClass associatedEntityLookupByField? fieldIdentifyingAssociatedEntity

Properties

associatedEntityClass

associatedEntityClass: IEntityClass<TAssociatedFields, TAssociatedID, TViewerContext, TAssociatedEntity, TAssociatedPrivacyPolicy, TAssociatedSelectedFields>

Class of entity to load at this step.

Optional associatedEntityLookupByField

associatedEntityLookupByField?: TAssociatedSelectedFields

Field by which to load the instance of associatedEntityClass. If not provided, the associatedEntityClass instance is fetched by its ID.

fieldIdentifyingAssociatedEntity

fieldIdentifyingAssociatedEntity: TSelectedFields

Field of the current entity with which to load an instance of associatedEntityClass.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc