LoadedCollection <T>

Hierarchy

• Collection<T>
  • LoadedCollection

Index

Properties

• $
• owner

Accessors

• length

Methods

• [iterator]
• add
• contains
• count
• exists
• filter
• find
• get
• getIdentifiers
• getItems
• indexBy
• init
• isDirty
• isEmpty
• isInitialized
• load
• loadCount
• loadItems
• map
• matching
• populated
• reduce
• remove
• removeAll
• set
• setDirty
• shouldPopulate
• slice
• toArray
• toJSON

Properties

$

$: Collection<T, object>

readonlyinheritedowner

owner: object

Inherited from Collection.owner

Accessors

inheritedlength

• get length(): number

• Inherited from Collection.length

  Returns number

Methods

inherited[iterator]

• [iterator](): IterableIterator<T, any, any>

• Inherited from Collection.[iterator]

  Returns IterableIterator<T, any, any>

inheritedadd

• add<TT>(entity, ...entities): void

• Inherited from Collection.add

  Parameters

  • entity: TT | Reference<TT> | Iterable<TT | Reference<TT>, any, any>

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

  Returns void

inheritedcontains

• contains<TT>(item, check): boolean

• Inherited from Collection.contains

  Parameters

  • item: TT | Reference<TT>

  • check: boolean = true

  Returns boolean

inheritedcount

• count(): number

• Inherited from Collection.count

  Returns number

inheritedexists

• exists(cb): boolean

• Inherited from Collection.exists

  Tests for the existence of an element that satisfies the given predicate.

  ---

  Parameters

  • cb: (item) => boolean

  Returns boolean

inheritedfilter

• filter(cb): T[]

• Inherited from Collection.filter

  Extracts a subset of the collection items.

  ---

  Parameters

  • cb: (item, index) => boolean

  Returns T[]

inheritedfind

• find(cb): undefined | T

• Inherited from Collection.find

  Returns the first element of this collection that satisfies the predicate.

  ---

  Parameters

  • cb: (item, index) => boolean

  Returns undefined | T

get

• get(): Collection<T, object>

• Returns Collection<T, object>

inheritedgetIdentifiers

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

• Inherited from Collection.getIdentifiers

  Parameters

  • optionalfield: string

  Returns U[]

getItems

• getItems(check): T[]

• Overrides Collection.getItems

  Returns the items (the collection must be initialized)

  ---

  Parameters

  • optionalcheck: boolean

  Returns T[]

inheritedindexBy

• indexBy<K1, K2>(key): Record<T[K1] & PropertyKey, T>
• indexBy<K1, K2>(key, valueKey): Record<T[K1] & PropertyKey, T[K2]>

• Inherited from Collection.indexBy

  Maps the collection items to a dictionary, indexed by the key you specify. If there are more items with the same key, only the first one will be present.

  ---

  Parameters

  • key: K1

  Returns Record<T[K1] & PropertyKey, T>

inheritedinit

• init<TT, P>(options): Promise<LoadedCollection<Loaded<TT, P>>>

• Inherited from Collection.init

  Parameters

  • options: InitCollectionOptions<TT, P, *, never> = {}

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

inheritedisDirty

• isDirty(): boolean

• Inherited from Collection.isDirty

  Returns boolean

inheritedisEmpty

• isEmpty(): boolean

• Inherited from Collection.isEmpty

  Returns boolean

inheritedisInitialized

• isInitialized(fully): boolean

• Inherited from Collection.isInitialized

  Parameters

  • fully: boolean = false

  Returns boolean

inheritedload

• load<TT, P>(options): Promise<LoadedCollection<Loaded<TT, P>>>

• Inherited from Collection.load

  Ensures the collection is loaded first (without reloading it if it already is loaded). Returns the Collection instance (itself), works the same as Reference.load().

  ---

  Parameters

  • options: InitCollectionOptions<TT, P, *, never> = {}

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

inheritedloadCount

• loadCount(options): Promise<number>

• Inherited from Collection.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>

inheritedloadItems

• loadItems<TT, P>(options): Promise<Loaded<TT, P>[]>

• Inherited from Collection.loadItems

  Initializes the collection and returns the items

  ---

  Parameters

  • optionaloptions: InitCollectionOptions<TT, P, *, never>

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

inheritedmap

• map<R>(mapper): R[]

• Inherited from Collection.map

  Maps the collection items based on your provided mapper function.

  ---

  Parameters

  • mapper: (item, index) => R

  Returns R[]

inheritedmatching

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

• Inherited from Collection.matching

  Parameters

  • options: MatchingOptions<T, P>

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

inheritedpopulated

• populated(populated): void

• Inherited from Collection.populated

  Parameters

  • populated: undefined | boolean = true

  Returns void

inheritedreduce

• reduce<R>(cb, initial): R

• Inherited from Collection.reduce

  Maps the collection items based on your provided mapper function to a single object.

  ---

  Parameters

  • cb: (obj, item, index) => R

  • initial: R = ...

  Returns R

inheritedremove

• remove<TT>(entity, ...entities): void

• Inherited from Collection.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: TT | Reference<TT> | Iterable<TT | Reference<TT>, any, any> | (item) => boolean

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

  Returns void

inheritedremoveAll

• removeAll(): void

• Inherited from Collection.removeAll

  Remove all items from the collection. Note that removing items 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.

  ---

  Returns void

inheritedset

• set(items): void

• Inherited from Collection.set

  Parameters

  • items: Iterable<T | Reference<T>, any, any>

  Returns void

inheritedsetDirty

• setDirty(dirty): void

• Inherited from Collection.setDirty

  Parameters

  • dirty: boolean = true

  Returns void

inheritedshouldPopulate

• shouldPopulate(populated): boolean

• Inherited from Collection.shouldPopulate

  Parameters

  • optionalpopulated: boolean

  Returns boolean

inheritedslice

• slice(start, end): T[]

• Inherited from Collection.slice

  Extracts a slice of the collection items starting at position start to end (exclusive) of the collection. If end is null it returns all elements from start to the end of the collection.

  ---

  Parameters

  • optionalstart: number

  • optionalend: number

  Returns T[]

inheritedtoArray

• toArray<TT>(): EntityDTO<TT>[]

• Inherited from Collection.toArray

  Returns EntityDTO<TT>[]

inheritedtoJSON

• toJSON<TT>(): EntityDTO<TT>[]

• Inherited from Collection.toJSON

  Returns EntityDTO<TT>[]