Skip to main content
Version: Next

LoadedCollection <T>

A Collection<T> that is guaranteed to be loaded, providing synchronous access via $, get(), and getItems().

Hierarchy

Index

Properties

Accessors

Methods

Properties

$

$: Collection<T, object>

readonlyinheritedowner

owner: object

Accessors

inheritedlength

  • get length(): number

  • Returns number

Methods

inherited[iterator]

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

  • Returns IterableIterator<T, any, any>

inheritedadd

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

  • Adds one or more items to the collection, propagating the change to the inverse side. Returns the number of items added.

    Parameters

    Returns number

inheritedcontains

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

  • Checks whether the collection contains the given item.

    Parameters

    • item: TT | Reference<TT>
    • check: boolean = true

    Returns boolean

inheritedcount

  • count(): number

  • Returns the number of items in the collection. Throws if the collection is not initialized.

    Returns number

inheritedexists

  • exists(cb): boolean

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

    Parameters

    • cb: (item) => boolean

      Returns boolean

    inheritedfilter

    • filter<S>(cb): S[]
    • filter(cb): T[]

    • Extracts a subset of the collection items.

      Parameters

      • cb: (item, index) => item is S

        Returns S[]

      inheritedfind

      • find<S>(cb): undefined | S
      • find(cb): undefined | T

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

        Parameters

        • cb: (item, index) => item is S

          Returns undefined | S

        get

        inheritedgetIdentifiers

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

        • Returns the primary key values (or a specific field) of all items in the collection.

          Parameters

          • optionalfield: string | string[]

          Returns U[]

        getItems

        • getItems(check): T[]

        • 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]>

        • 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

        inheritedisDirty

        • isDirty(): boolean

        • Returns boolean

        inheritedisEmpty

        • isEmpty(): boolean

        • Returns true if the collection has no items. Throws if the collection is not initialized.

          Returns boolean

        inheritedisInitialized

        • isInitialized(fully): boolean

        • Returns whether the collection has been initialized. Pass fully = true to also check that all items are initialized.

          Parameters

          • fully: boolean = false

          Returns boolean

        inheritedisPartial

        • isPartial(): boolean

        • Returns whether the collection was partially loaded (propagation is disabled for partial collections).

          Returns boolean

        inheritedload

        • 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

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

        inheritedloadCount

        • loadCount(options): Promise<number>

        • 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

          Returns Promise<number>

        inheritedloadItems

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

        • Initializes the collection and returns the items

          Parameters

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

        inheritedmap

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

        • 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>[]>

          • Queries a subset of the collection items from the database with custom filtering, ordering, and pagination.

            Parameters

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

          inheritedpopulated

          • populated(populated): void

          • Marks the collection as populated or not for serialization purposes.

            Parameters

            • populated: undefined | boolean = true

            Returns void

          inheritedreduce

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

          • 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): number

            • 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

              Returns number

            inheritedremoveAll

            • removeAll(): void

            • 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

            • Replaces all items in the collection with the given items.

              Parameters

              Returns void

            inheritedsetDirty

            • setDirty(dirty): void

            • Parameters

              • dirty: boolean = true

              Returns void

            inheritedshouldPopulate

            • shouldPopulate(populated): boolean

            • Returns whether this collection should be included in serialization based on its populated state.

              Parameters

              • optionalpopulated: boolean

              Returns boolean

            inheritedslice

            • slice(start, end): T[]

            • 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

              • start: number = 0
              • optionalend: number

              Returns T[]

            inheritedtoArray

            • Converts all items in the collection to plain DTO objects.

              Returns EntityDTO<TT>[]

            inheritedtoJSON

            • Serializes the collection items to plain JSON objects. Returns an empty array if not initialized.

              Returns EntityDTO<TT>[]

            Page Options