Class: Collection<T, O>#
core.Collection
Type parameters#
| Name | Default |
|---|---|
T | - |
O | unknown |
Hierarchy#
ArrayCollection<T, O>
↳ Collection
↳↳ LoadedCollection
Constructors#
constructor#
+ new Collection<T, O>(owner: O, items?: T[], initialized?: boolean): Collection<T, O>
Type parameters:#
| Name | Default |
|---|---|
T | - |
O | unknown |
Parameters:#
| Name | Type | Default value |
|---|---|---|
owner | O | - |
items? | T[] | - |
initialized | boolean | true |
Returns: Collection<T, O>
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:13
Properties#
_count#
• Protected Optional _count: undefined | number
Inherited from: ArrayCollection._count
Defined in: packages/core/src/entity/ArrayCollection.ts:13
_lazyInitialized#
• Private _lazyInitialized: boolean= false
Defined in: packages/core/src/entity/Collection.ts:13
_populated#
• Private _populated: boolean= false
Defined in: packages/core/src/entity/Collection.ts:12
dirty#
• Private dirty: boolean= false
Defined in: packages/core/src/entity/Collection.ts:11
initialized#
• Protected initialized: boolean= true
Inherited from: ArrayCollection.initialized
Defined in: packages/core/src/entity/ArrayCollection.ts:12
items#
• Protected Readonly items: Set<T>
Inherited from: ArrayCollection.items
Defined in: packages/core/src/entity/ArrayCollection.ts:11
owner#
• Readonly owner: O & Partial<O> & { __@EntityRepositoryType@41631?: unknown ; __@PrimaryKeyType@41543?: unknown ; __helper?: undefined | IWrappedEntityInternal<O, keyof O, keyof O> ; __meta?: undefined | EntityMetadata<O> ; __platform?: undefined | Platform }
Inherited from: ArrayCollection.owner
snapshot#
• Private snapshot: undefined | T[]
Defined in: packages/core/src/entity/Collection.ts:10
Accessors#
length#
• length(): number
Returns: number
Defined in: packages/core/src/entity/ArrayCollection.ts:134
property#
• property(): EntityProperty<T>
internal
Returns: EntityProperty<T>
Defined in: packages/core/src/entity/ArrayCollection.ts:147
Methods#
[Symbol.iterator]#
â–¸ [Symbol.iterator](): IterableIterator<T>
Returns: IterableIterator<T>
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:138
add#
â–¸ add(...items: (T | Reference<T>)[]): void
Parameters:#
| Name | Type |
|---|---|
...items | (T | Reference<T>)[] |
Returns: void
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:91
cancelOrphanRemoval#
â–¸ PrivatecancelOrphanRemoval(items: T[]): void
Parameters:#
| Name | Type |
|---|---|
items | T[] |
Returns: void
Defined in: packages/core/src/entity/Collection.ts:298
checkInitialized#
â–¸ PrivatecheckInitialized(): void
Returns: void
Defined in: packages/core/src/entity/Collection.ts:283
contains#
â–¸ contains(item: T | Reference<T>, check?: boolean): boolean
Parameters:#
| Name | Type | Default value |
|---|---|---|
item | T | Reference<T> | - |
check | boolean | true |
Returns: boolean
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:134
count#
â–¸ count(): number
Returns: number
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:142
createCondition#
â–¸ PrivatecreateCondition<T>(cond?: FilterQuery<T>): FilterQuery<T>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type | Default value |
|---|---|---|
cond | FilterQuery<T> | ... |
Returns: FilterQuery<T>
Defined in: packages/core/src/entity/Collection.ts:230
createLoadCountCondition#
â–¸ PrivatecreateLoadCountCondition(cond: Dictionary<any>): Dictionary<any>
Parameters:#
| Name | Type |
|---|---|
cond | Dictionary<any> |
Returns: Dictionary<any>
Defined in: packages/core/src/entity/Collection.ts:263
createManyToManyCondition#
â–¸ PrivatecreateManyToManyCondition(cond: Dictionary<any>): void
Parameters:#
| Name | Type |
|---|---|
cond | Dictionary<any> |
Returns: void
Defined in: packages/core/src/entity/Collection.ts:252
createOrderBy#
â–¸ PrivatecreateOrderBy(orderBy?: QueryOrderMap): QueryOrderMap
Parameters:#
| Name | Type | Default value |
|---|---|---|
orderBy | QueryOrderMap | ... |
Returns: QueryOrderMap
Defined in: packages/core/src/entity/Collection.ts:240
getIdentifiers#
â–¸ getIdentifiers<U>(field?: string): U[]
Type parameters:#
| Name | Type | Default |
|---|---|---|
U | IPrimaryKeyValue | Primary<T\> & string \ |
Parameters:#
| Name | Type |
|---|---|
field? | string |
Returns: U[]
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:53
getItems#
â–¸ getItems(check?: boolean): T[]
Returns the items (the collection must be initialized)
Parameters:#
| Name | Type | Default value |
|---|---|---|
check | boolean | true |
Returns: T[]
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:75
getSnapshot#
â–¸ getSnapshot(): undefined | T[]
internal
Returns: undefined | T[]
Defined in: packages/core/src/entity/Collection.ts:226
hydrate#
â–¸ hydrate(items: T[]): void
internal
Parameters:#
| Name | Type |
|---|---|
items | T[] |
Returns: void
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:116
incrementCount#
â–¸ ProtectedincrementCount(value: number): void
Parameters:#
| Name | Type |
|---|---|
value | number |
Returns: void
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:197
init#
â–¸ init(options?: InitOptions<T>): Promise<Collection<T, O>>
Parameters:#
| Name | Type |
|---|---|
options? | InitOptions<T> |
Returns: Promise<Collection<T, O>>
Defined in: packages/core/src/entity/Collection.ts:164
â–¸ init(populate?: string[], where?: { __@PrimaryKeyType@41543?: any } | NonNullable<Query<T>>, orderBy?: QueryOrderMap): Promise<Collection<T, O>>
Parameters:#
| Name | Type |
|---|---|
populate? | string[] |
where? | { __@PrimaryKeyType@41543?: any } | NonNullable<Query<T>> |
orderBy? | QueryOrderMap |
Returns: Promise<Collection<T, O>>
Defined in: packages/core/src/entity/Collection.ts:165
isDirty#
â–¸ isDirty(): boolean
Returns: boolean
Defined in: packages/core/src/entity/Collection.ts:156
isInitialized#
â–¸ isInitialized(fully?: boolean): boolean
Parameters:#
| Name | Type | Default value |
|---|---|---|
fully | boolean | false |
Returns: boolean
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:126
loadCount#
â–¸ loadCount(refresh?: boolean): Promise<number>
Gets the count of collection items from database instead of counting loaded items.
The value is cached, use refresh = true to force reload it.
Parameters:#
| Name | Type | Default value |
|---|---|---|
refresh | boolean | false |
Returns: Promise<number>
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:54
loadItems#
â–¸ loadItems(): Promise<T[]>
Initializes the collection and returns the items
Returns: Promise<T[]>
Defined in: packages/core/src/entity/Collection.ts:42
modify#
â–¸ Privatemodify(method: add | remove, items: T[]): void
Parameters:#
| Name | Type |
|---|---|
method | add | remove |
items | T[] |
Returns: void
Defined in: packages/core/src/entity/Collection.ts:273
populated#
â–¸ populated(populated?: boolean): void
Parameters:#
| Name | Type | Default value |
|---|---|---|
populated | boolean | true |
Returns: void
Defined in: packages/core/src/entity/Collection.ts:151
propagate#
â–¸ Protectedpropagate(item: T, method: add | remove): void
Parameters:#
| Name | Type |
|---|---|
item | T |
method | add | remove |
Returns: void
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:157
propagateToInverseSide#
â–¸ ProtectedpropagateToInverseSide(item: T, method: add | remove): void
Parameters:#
| Name | Type |
|---|---|
item | T |
method | add | remove |
Returns: void
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:165
propagateToOwningSide#
â–¸ ProtectedpropagateToOwningSide(item: T, method: add | remove): void
Parameters:#
| Name | Type |
|---|---|
item | T |
method | add | remove |
Returns: void
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:173
remove#
â–¸ remove(...items: (T | Reference<T>)[]): void
Parameters:#
| Name | Type |
|---|---|
...items | (T | Reference<T>)[] |
Returns: void
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:122
removeAll#
â–¸ removeAll(): void
Returns: void
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:113
reorderItems#
â–¸ PrivatereorderItems(items: T[], order: T[]): void
re-orders items after searching with $in operator
Parameters:#
| Name | Type |
|---|---|
items | T[] |
order | T[] |
Returns: void
Defined in: packages/core/src/entity/Collection.ts:292
set#
â–¸ set(items: (T | Reference<T>)[]): void
Parameters:#
| Name | Type |
|---|---|
items | (T | Reference<T>)[] |
Returns: void
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:98
setDirty#
â–¸ setDirty(dirty?: boolean): void
Parameters:#
| Name | Type | Default value |
|---|---|---|
dirty | boolean | true |
Returns: void
Defined in: packages/core/src/entity/Collection.ts:160
shouldPopulate#
â–¸ shouldPopulate(): boolean
Returns: boolean
Defined in: packages/core/src/entity/Collection.ts:147
shouldPropagateToCollection#
â–¸ ProtectedshouldPropagateToCollection(collection: ArrayCollection<O, T>, method: add | remove): boolean
Parameters:#
| Name | Type |
|---|---|
collection | ArrayCollection<O, T> |
method | add | remove |
Returns: boolean
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:184
takeSnapshot#
â–¸ takeSnapshot(): void
internal
Returns: void
Defined in: packages/core/src/entity/Collection.ts:218
toArray#
â–¸ toArray(): Dictionary<any>[]
Returns: Dictionary<any>[]
Inherited from: ArrayCollection
Defined in: packages/core/src/entity/ArrayCollection.ts:38
toJSON#
â–¸ toJSON(): Dictionary<any>[]
Returns: Dictionary<any>[]
Overrides: ArrayCollection
Defined in: packages/core/src/entity/Collection.ts:83
validateItemType#
â–¸ PrivatevalidateItemType(item: T | Primary<T> | EntityData<T>): void
Parameters:#
| Name | Type |
|---|---|
item | T | Primary<T> | EntityData<T> |
Returns: void
Defined in: packages/core/src/entity/Collection.ts:310
validateModification#
â–¸ PrivatevalidateModification(items: T[]): void
Parameters:#
| Name | Type |
|---|---|
items | T[] |
Returns: void
Defined in: packages/core/src/entity/Collection.ts:316
create#
â–¸ Staticcreate<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:#
| Name | Default |
|---|---|
T | - |
O | any |
Parameters:#
| Name | Type |
|---|---|
owner | O |
prop | keyof O |
items | undefined | T[] |
initialized | boolean |
Returns: Collection<T, O>
Defined in: packages/core/src/entity/Collection.ts:28