Skip to main content
Version: 5.9

RequestContext

Uses AsyncLocalStorage to create async context that holds current EM fork.

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new RequestContext(map: Map<string, EntityManager<IDatabaseDriver<Connection>>>): RequestContext

  • Parameters

    • map: Map<string, EntityManager<IDatabaseDriver<Connection>>>

    Returns RequestContext

Properties

readonlyid

id: number = ...

readonlymap

map: Map<string, EntityManager<IDatabaseDriver<Connection>>>

Accessors

em

  • get em(): undefined | EntityManager<IDatabaseDriver<Connection>>

  • Returns default EntityManager.

    Returns undefined | EntityManager<IDatabaseDriver<Connection>>

Methods

staticcreate

  • create(em: EntityManager<IDatabaseDriver<Connection>> | EntityManager<IDatabaseDriver<Connection>>[], next: (...args: any[]) => void, options?: CreateContextOptions): void

  • Creates new RequestContext instance and runs the code inside its domain.

    Parameters

    • em: EntityManager<IDatabaseDriver<Connection>> | EntityManager<IDatabaseDriver<Connection>>[]
    • next: (...args: any[]) => void
      • options: CreateContextOptions = {}

      Returns void

    staticcreateAsync

    • createAsync<T>(em: EntityManager<IDatabaseDriver<Connection>> | EntityManager<IDatabaseDriver<Connection>>[], next: (...args: any[]) => Promise<T>, options?: CreateContextOptions): Promise<T>

    • Creates new RequestContext instance and runs the code inside its domain. Async variant, when the next handler needs to be awaited (like in Koa).

      Type parameters

      • T

      Parameters

      • em: EntityManager<IDatabaseDriver<Connection>> | EntityManager<IDatabaseDriver<Connection>>[]
      • next: (...args: any[]) => Promise<T>
        • options: CreateContextOptions = {}

        Returns Promise<T>

      staticcurrentRequestContext

      • currentRequestContext(): undefined | RequestContext

      • Returns current RequestContext (if available).

        Returns undefined | RequestContext

      staticgetEntityManager

      • getEntityManager(name?: string): undefined | EntityManager<IDatabaseDriver<Connection>>

      • Returns current EntityManager (if available).

        Parameters

        • name: string = 'default'

        Returns undefined | EntityManager<IDatabaseDriver<Connection>>

      Page Options