Class ViewerContext

constructor

• new ViewerContext(
      entityCompanionProvider: EntityCompanionProvider,
  ): ViewerContext

  Parameters

  • entityCompanionProvider: EntityCompanionProvider

  Returns ViewerContext

ReadonlyentityCompanionProvider

[toStringTag]

• get "[toStringTag]"(): string

  Returns string

getQueryContextForDatabaseAdaptorFlavor

• getQueryContextForDatabaseAdaptorFlavor(
      databaseAdaptorFlavor: string,
  ): EntityQueryContext

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

  Parameters

  • databaseAdaptorFlavor: string

    database adaptor flavor

  Returns EntityQueryContext

getViewerScopedEntityCompanionForClass

• getViewerScopedEntityCompanionForClass<
      TMFields extends object,
      TMIDField extends string | number | symbol,
      TMViewerContext extends ViewerContext,
      TMEntity extends
          ReadonlyEntity<TMFields, TMIDField, TMViewerContext, TMSelectedFields>,
      TMPrivacyPolicy extends
          EntityPrivacyPolicy<
              TMFields,
              TMIDField,
              TMViewerContext,
              TMEntity,
              TMSelectedFields,
          >,
      TMSelectedFields extends string
      | number
      | symbol,
  >(
      entityClass: IEntityClass<
          TMFields,
          TMIDField,
          TMViewerContext,
          TMEntity,
          TMPrivacyPolicy,
          TMSelectedFields,
      >,
  ): ViewerScopedEntityCompanion<
      TMFields,
      TMIDField,
      TMViewerContext,
      TMEntity,
      TMPrivacyPolicy,
      TMSelectedFields,
  >

  Type Parameters

  • TMFields extends object
  • TMIDField extends string | number | symbol
  • TMViewerContext extends ViewerContext
  • TMEntity extends ReadonlyEntity<TMFields, TMIDField, TMViewerContext, TMSelectedFields>
  • TMPrivacyPolicy extends EntityPrivacyPolicy<
        TMFields,
        TMIDField,
        TMViewerContext,
        TMEntity,
        TMSelectedFields,
    >
  • TMSelectedFields extends string | number | symbol

  Parameters

  • entityClass: IEntityClass<
        TMFields,
        TMIDField,
        TMViewerContext,
        TMEntity,
        TMPrivacyPolicy,
        TMSelectedFields,
    >

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

runInTransactionForDatabaseAdaptorFlavorAsync

• runInTransactionForDatabaseAdaptorFlavorAsync<TResult>(
      databaseAdaptorFlavor: string,
      transactionScope: (
          queryContext: EntityTransactionalQueryContext,
      ) => Promise<TResult>,
      transactionConfig?: 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
  • OptionaltransactionConfig: TransactionConfig

  Returns Promise<TResult>