Skip to main content
Version: 6.4

UnitOfWork

Index

Constructors

constructor

Methods

cancelOrphanRemoval

  • cancelOrphanRemoval(entity, visited): void
  • Parameters

    • entity: Partial<any>
    • optionalvisited: Set<Partial<any>>

    Returns void

clear

  • clear(): void
  • Returns void

clearActionsQueue

  • clearActionsQueue(): void
  • Returns void

commit

  • commit(): Promise<void>
  • Returns Promise<void>

computeChangeSet

  • computeChangeSet(entity, type): void

computeChangeSets

  • computeChangeSets(): void
  • Returns void

getById

  • getById(entityName, id, schema): undefined | T
  • Returns entity from the identity map. For composite keys, you need to pass an array of PKs in the same order as they are defined in meta.primaryKeys.


    Parameters

    • entityName: string
    • id: (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T) | (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T<T> ? ReadonlyPrimary<UnwrapPrimary<T<T>[PK<PK>]>> : PK extends keyof T<T>[] ? ReadonlyPrimary<PrimaryPropToType<T<T>, PK<PK>>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)[]
    • optionalschema: string

    Returns undefined | T

getChangeSetPersister

getChangeSets

getCollectionUpdates

  • getCollectionUpdates(): Collection<Partial<any>, object>[]

getExtraUpdates

getIdentityMap

  • Returns map of all managed entities.


    Returns IdentityMap

getOriginalEntityData

  • getOriginalEntityData(entity): undefined | EntityData<T>
  • Returns stored snapshot of entity state that is used for change set computation.


    Parameters

    • entity: T

    Returns undefined | EntityData<T>

getOrphanRemoveStack

  • getOrphanRemoveStack(): Set<Partial<any>>
  • Returns Set<Partial<any>>

getPersistStack

  • getPersistStack(): Set<Partial<any>>
  • Returns Set<Partial<any>>

getRemoveStack

  • getRemoveStack(): Set<Partial<any>>
  • Returns Set<Partial<any>>

lock

  • lock(entity, options): Promise<void>
  • Parameters

    Returns Promise<void>

merge

  • merge(entity, visited): void
  • Parameters

    • entity: T
    • optionalvisited: Set<Partial<any>>

    Returns void

persist

  • persist(entity, visited, options): void
  • Parameters

    • entity: T
    • optionalvisited: Set<Partial<any>>
    • options: { cascade?: boolean; checkRemoveStack?: boolean } = {}
      • optionalcascade: boolean
      • optionalcheckRemoveStack: boolean

    Returns void

recomputeSingleChangeSet

  • recomputeSingleChangeSet(entity): void
  • Parameters

    • entity: T

    Returns void

remove

  • remove(entity, visited, options): void
  • Parameters

    • entity: T
    • optionalvisited: Set<Partial<any>>
    • options: { cascade?: boolean } = {}
      • optionalcascade: boolean

    Returns void

scheduleExtraUpdate

  • scheduleExtraUpdate(changeSet, props): void

scheduleOrphanRemoval

  • scheduleOrphanRemoval(entity, visited): void
  • Parameters

    • optionalentity: Partial<any>
    • optionalvisited: Set<Partial<any>>

    Returns void

shouldAutoFlush

  • shouldAutoFlush(meta): boolean

tryGetById

  • tryGetById(entityName, where, schema, strict): null | T
  • Parameters

    • entityName: string
    • where: FilterQuery<T>
    • optionalschema: string
    • strict: boolean = true

    Returns null | T

unsetIdentity

  • unsetIdentity(entity): void
  • Parameters

    • entity: Partial<any>

    Returns void