Collection <T, O>

Hierarchy

• ArrayCollection<T, O>
  • Collection
    • LoadedCollection

Index

Constructors

• constructor

Properties

• owner

Accessors

• length

Methods

• [custom]
• [iterator]
• add
• contains
• count
• getIdentifiers
• getItems
• init
• isDirty
• isInitialized
• loadCount
• loadItems
• matching
• populated
• remove
• removeAll
• set
• setDirty
• shouldPopulate
• toArray
• toJSON
• create

Constructors

constructor

• new Collection<T, O>(owner: O, items?: T[], initialized?: boolean): Collection<T, O>

• Overrides ArrayCollection.constructor

  Type parameters

  • T: object
  • O: object = object

  Parameters

  • owner: O

  • optionalitems: T[]

  • initialized: boolean = true

  Returns Collection<T, O>

Properties

readonlyowner

owner: O

Inherited from ArrayCollection.owner

Accessors

length

• get length(): number

• Inherited from ArrayCollection.length

  Returns number

Methods

[custom]

• [custom](depth: number): string

• Inherited from ArrayCollection.[custom]

  Parameters

  • depth: number

  Returns string

[iterator]

• [iterator](): IterableIterator<T>

• Inherited from ArrayCollection.[iterator]

  Returns IterableIterator<T>

add

• add(entity: T | Reference<T> | (T | Reference<T>)[], ...entities: (T | Reference<T>)[]): void

• Overrides ArrayCollection.add

  Parameters

  • entity: T | Reference<T> | (T | Reference<T>)[]

  • rest...entities: (T | Reference<T>)[]

  Returns void

contains

• contains(item: T | Reference<T>, check?: boolean): boolean

• Overrides ArrayCollection.contains

  Parameters

  • item: T | Reference<T>

  • check: boolean = true

  Returns boolean

count

• count(): number

• Overrides ArrayCollection.count

  Returns number

getIdentifiers

• getIdentifiers<U>(field?: string): U[]

• Inherited from ArrayCollection.getIdentifiers

  Type parameters

  • U: IPrimaryKeyValue = Object

  Parameters

  • optionalfield: string

  Returns U[]

getItems

• getItems(check?: boolean): T[]

• Overrides ArrayCollection.getItems

  Returns the items (the collection must be initialized)

  ---

  Parameters

  • check: boolean = true

  Returns T[]

init

• init<P>(options?: InitOptions<T, P>): Promise<LoadedCollection<Loaded<T, P>>>

• Type parameters

  • P: string = never

  Parameters

  • options: InitOptions<T, P> = {}

  Returns Promise<LoadedCollection<Loaded<T, P>>>

isDirty

• isDirty(): boolean

• Inherited from ArrayCollection.isDirty

  Returns boolean

isInitialized

• isInitialized(fully?: boolean): boolean

• Inherited from ArrayCollection.isInitialized

  Parameters

  • fully: boolean = false

  Returns boolean

loadCount

• loadCount(options?: boolean | LoadCountOptions<T>): Promise<number>

• Overrides ArrayCollection.loadCount

  Gets the count of collection items from database instead of counting loaded items. The value is cached (unless you use the where option), use refresh: true to force reload it.

  ---

  Parameters

  • options: boolean | LoadCountOptions<T> = {}

  Returns Promise<number>

loadItems

• loadItems<P>(options?: InitOptions<T, P>): Promise<Loaded<T, P>[]>

• Initializes the collection and returns the items

  ---

  Type parameters

  • P: string = never

  Parameters

  • optionaloptions: InitOptions<T, P>

  Returns Promise<Loaded<T, P>[]>

matching

• matching<P>(options: MatchingOptions<T, P>): Promise<Loaded<T, P>[]>

• Type parameters

  • P: string = never

  Parameters

  • options: MatchingOptions<T, P>

  Returns Promise<Loaded<T, P>[]>

populated

• populated(populated?: boolean): void

• Parameters

  • populated: boolean = true

  Returns void

remove

• remove(entity: T | Reference<T> | (T | Reference<T>)[] | (item: T) => boolean, ...entities: (T | Reference<T>)[]): void

• Overrides ArrayCollection.remove

  Remove specified item(s) from the collection. Note that removing item from collection does not necessarily imply deleting the target entity, it means we are disconnecting the relation - removing items from collection, not removing entities from database - Collection.remove() is not the same as em.remove(). If we want to delete the entity by removing it from collection, we need to enable orphanRemoval: true, which tells the ORM we don’t want orphaned entities to exist, so we know those should be removed.

  ---

  Parameters

  • entity: T | Reference<T> | (T | Reference<T>)[] | (item: T) => boolean

  • rest...entities: (T | Reference<T>)[]

  Returns void

removeAll

• removeAll(): void

• Overrides ArrayCollection.removeAll

  Remove all items from the collection. Note that removing items from collection does necessarily imply deleting the target entity, it means we are disconnecting the relation - removing items from collection, not removing entities from database - Collection.remove() is not the same as em.remove(). If we want to delete the entity by removing it from collection, we need to enable orphanRemoval: true, which tells the ORM we don’t want orphaned entities to exist, so we know those should be removed.

  ---

  Returns void

set

• set(items: (T | Reference<T>)[]): void

• Overrides ArrayCollection.set

  Parameters

  • items: (T | Reference<T>)[]

  Returns void

setDirty

• setDirty(dirty?: boolean): void

• Inherited from ArrayCollection.setDirty

  Parameters

  • dirty: boolean = true

  Returns void

shouldPopulate

• shouldPopulate(): boolean

• Returns boolean

toArray

• toArray(): EntityDTO<T>[]

• Inherited from ArrayCollection.toArray

  Returns EntityDTO<T>[]

toJSON

• toJSON(): EntityDTO<T>[]

• Overrides ArrayCollection.toJSON

  Returns EntityDTO<T>[]

staticcreate

• create<T, O>(owner: O, prop: keyof O, items: undefined | T[], initialized: boolean): Collection<T, O>

• Creates new Collection instance, assigns it to the owning entity and sets the items to it (propagating them to their inverse sides)

  ---

  Type parameters

  • T: object
  • O: object = object

  Parameters

  • owner: O

  • prop: keyof O

  • items: undefined | T[]

  • initialized: boolean

  Returns Collection<T, O>