- Preparing search index...
- The search index is not available
Entity
Properties
Readonly
entityCompanionProvider
Private
Readonly
viewerScopedEntityCompanionProvider
Accessors
[toStringTag]
- get [toStringTag](): string
-
Returns string
Methods
getQueryContextForDatabaseAdaptorFlavor
- getQueryContextForDatabaseAdaptorFlavor(databaseAdaptorFlavor): EntityQueryContext
-
Parameters
-
databaseAdaptorFlavor: string
getViewerScopedEntityCompanionForClass
- getViewerScopedEntityCompanionForClass<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields>(entityClass): ViewerScopedEntityCompanion<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields>
-
Type Parameters
-
TMFields extends object
-
TMID extends {}
-
TMViewerContext extends ViewerContext<TMViewerContext>
-
TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields, TMEntity>
-
TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity, TMSelectedFields, TMPrivacyPolicy>
-
TMSelectedFields extends string | number | symbol
Parameters
-
entityClass: IEntityClass<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields>
Returns ViewerScopedEntityCompanion<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields>
runInTransactionForDatabaseAdaptorFlavorAsync
- runInTransactionForDatabaseAdaptorFlavorAsync<TResult>(databaseAdaptorFlavor, transactionScope, transactionConfig?): Promise<TResult>
-
Parameters
-
databaseAdaptorFlavor: string
-
transactionScope: ((queryContext) => Promise<TResult>)
-
- (queryContext): Promise<TResult>
-
Returns Promise<TResult>
-
Returns Promise<TResult>
A viewer context encapsulates all information necessary to evaluate an EntityPrivacyPolicy.
In combination with an EntityCompanionProvider, a viewer context is the entry point into the Entity framework.