Class ViewerContext

constructor

• new ViewerContext(entityCompanionProvider): ViewerContext

• Parameters

  • entityCompanionProvider: EntityCompanionProvider

  Returns ViewerContext

ReadonlyentityCompanionProvider

[toStringTag]

• get [toStringTag](): string

• Returns string

getQueryContextForDatabaseAdaptorFlavor

• getQueryContextForDatabaseAdaptorFlavor(databaseAdaptorFlavor): EntityQueryContext

• Get the regular (non-transactional) query context for a database adaptor flavor.

  Parameters

  • databaseAdaptorFlavor: string

    database adaptor flavor

  Returns EntityQueryContext

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
  • TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>
  • TMPrivacyPolicy extends EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity, TMSelectedFields>
  • 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>

• Run a transaction of specified database adaptor flavor and execute the provided transaction-scoped closure within the transaction.

  Type Parameters

  • TResult

  Parameters

  • databaseAdaptorFlavor: string

    databaseAdaptorFlavor
  • transactionScope: ((queryContext: EntityTransactionalQueryContext) => Promise<TResult>)

    async callback to execute within the transaction

    • • (queryContext): Promise<TResult>

      • Parameters

        • queryContext: EntityTransactionalQueryContext

        Returns Promise<TResult>

  • OptionaltransactionConfig: TransactionConfig

  Returns Promise<TResult>