Class CollectionProperty

A basic relational property type representing a collection of BaseObject instances. This core class manages the in-memory array representation. For dynamic querying, see the backend CollectionProperty.

Example

const permissions = new CollectionProperty({
   name: 'permissions',
   instanceOf: Permission
});

Hierarchy (View Summary)

BaseProperty
- CollectionProperty
  - CollectionProperty

Index

Constructors

constructor

new CollectionProperty(config: CollectionPropertyType): CollectionProperty
Parameters
- config: CollectionPropertyType
Returns CollectionProperty
Overrides BaseProperty.constructor
- Defined in packages/core/src/properties/CollectionProperty.ts:46

Properties

`Protected`_allows

_allows: string[] = []

`Protected`_defaultValue

_defaultValue: any

`Protected`_events

_events: { [key: string]: Function } = {}

`Protected`_hasChanged

_hasChanged: boolean

`Protected`_htmlType

_htmlType: PropertyHTMLType = 'off'

`Protected`_id

_id: string

`Protected`_instanceOf

_instanceOf: typeof BaseObject

`Protected`_mandatory

_mandatory: boolean = false

`Protected`_name

_name: string

`Protected`_parent

_parent: DataObjectClass<any> | undefined

`Protected`_parentKey

_parentKey: string

`Protected`_protected

_protected: boolean = false

`Protected`_value

_value: any[] | DataObjectClass<any>[] | ObjectUri[] | undefined = undefined

`Static`EVENT_ONCHANGE

EVENT_ONCHANGE: string = 'onChange'

Event name triggered when the property value changes.

`Static`EVENT_ONDELETE

EVENT_ONDELETE: string = 'onDelete'

Event name triggered when the property is deleted.

`Static`TYPE

TYPE: string = 'collection'

The string literal type identifier for this property.

Accessors

allows

get allows(): string[]
Returns string[]
Inherited from BaseProperty.allows
- Defined in packages/core/src/properties/BaseProperty.ts:105

hasChanged

get hasChanged(): boolean
Returns boolean
Inherited from BaseProperty.hasChanged
- Defined in packages/core/src/properties/BaseProperty.ts:117
set hasChanged(val: boolean): void
Parameters
- val: boolean
Returns void
Inherited from BaseProperty.hasChanged
- Defined in packages/core/src/properties/BaseProperty.ts:121

htmlType

get htmlType(): PropertyHTMLType
Returns PropertyHTMLType
Inherited from BaseProperty.htmlType
- Defined in packages/core/src/properties/BaseProperty.ts:113
set htmlType(type: PropertyHTMLType): void
Parameters
- type: PropertyHTMLType
Returns void
Inherited from BaseProperty.htmlType
- Defined in packages/core/src/properties/BaseProperty.ts:109

mandatory

get mandatory(): boolean
Returns boolean
Inherited from BaseProperty.mandatory
- Defined in packages/core/src/properties/BaseProperty.ts:97

name

get name(): string
Returns string
Inherited from BaseProperty.name
- Defined in packages/core/src/properties/BaseProperty.ts:93

protected

get protected(): boolean
Returns boolean
Inherited from BaseProperty.protected
- Defined in packages/core/src/properties/BaseProperty.ts:101

Methods

`Protected`_enable

_enable(value: boolean | undefined): value is true | undefined
Parameters
- value: boolean | undefined
Returns value is true | undefined
Inherited from BaseProperty._enable
- Defined in packages/core/src/properties/BaseProperty.ts:192

apply

apply(fn: (item: any) => any, items?: any[]): any[] | Promise<any[]>
Applies an anonymous function to each item in the collection. Can execute either on the internal collection value or an external array. Supporting both synchronous and asynchronous callback functions.
Parameters
- fn: (item: any) => any
  The anonymous callback function to apply to each item.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns any[] | Promise<any[]>
The results of the function applications (or a Promise resolving to the results if async).
- Defined in packages/core/src/properties/CollectionProperty.ts:238

average

average(property: string, items?: any[]): number | Promise<number>
Calculates the average of the numeric values of a property across items in the collection. Can aggregate either the internal collection value or an external array.
Parameters
- property: string
  The name of the property to average.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns number | Promise<number>
The average of all numeric values, or 0 if empty.
- Defined in packages/core/src/properties/CollectionProperty.ts:111

clone

clone(): any
Creates a deep clone of the current property instance, preserving its prototype chain.

Returns any
A new independent instance of the property.
Inherited from BaseProperty.clone
- Defined in packages/core/src/properties/BaseProperty.ts:210

count

count(
predicate?: (item: any) => boolean,
items?: any[],
): number | Promise<number>
Returns the count of items in the collection, optionally filtered by a predicate callback. Can aggregate either the internal collection value or an external array.
Parameters
- Optionalpredicate: (item: any) => boolean
  An optional filter callback to run on each item.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns number | Promise<number>
The count of matching items.
- Defined in packages/core/src/properties/CollectionProperty.ts:224

distinct

distinct(property: string, items?: any[]): any[] | Promise<any[]>
Retrieves all distinct values of a property across the collection items. Can aggregate either the internal collection value or an external array.
Parameters
- property: string
  The name of the property.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns any[] | Promise<any[]>
An array of unique property values.
- Defined in packages/core/src/properties/CollectionProperty.ts:128

groupBy

groupBy(
property: string,
items?: any[],
): Record<string, any[]> | Promise<Record<string, any[]>>
Groups the collection items by the values of a specific property. Can aggregate either the internal collection value or an external array.
Parameters
- property: string
  The name of the property to group by.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns Record<string, any[]> | Promise<Record<string, any[]>>
A dictionary object where keys are the property values and values are arrays of matching items.
- Defined in packages/core/src/properties/CollectionProperty.ts:189

max

max(
property: string,
items?: any[],
): number | Promise<number | undefined> | undefined
Returns the maximum value of a numeric property across the collection items. Can aggregate either the internal collection value or an external array.
Parameters
- property: string
  The name of the property.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns number | Promise<number | undefined> | undefined
The maximum numeric value found, or undefined if no valid numbers are present.
- Defined in packages/core/src/properties/CollectionProperty.ts:166

min

min(
property: string,
items?: any[],
): number | Promise<number | undefined> | undefined
Returns the minimum value of a numeric property across the collection items. Can aggregate either the internal collection value or an external array.
Parameters
- property: string
  The name of the property.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns number | Promise<number | undefined> | undefined
The minimum numeric value found, or undefined if no valid numbers are present.
- Defined in packages/core/src/properties/CollectionProperty.ts:143

pluck

pluck(property: string, items?: any[]): any[] | Promise<any[]>
Plucks a specific property from each item in the collection. Can aggregate either the internal collection value or an external array.
Parameters
- property: string
  The name of the property to extract.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns any[] | Promise<any[]>
An array containing the extracted property values.
- Defined in packages/core/src/properties/CollectionProperty.ts:210

set

set(value: any[], setChanged?: boolean): CollectionProperty
Assigns an array of related objects or URIs to the collection.
Parameters
- value: any[]
  The array of elements to assign.
- setChanged: boolean = true
  Whether to mark the property as modified.
Returns CollectionProperty
The property instance for chaining.
Overrides BaseProperty.set
- Defined in packages/core/src/properties/CollectionProperty.ts:66

sum

sum(property: string, items?: any[]): number | Promise<number>
Sums the numeric values of a property across items in the collection. Can aggregate either the internal collection value or an external array.
Parameters
- property: string
  The name of the property to sum.
- items: any[] = ...
  Optional external items array. Defaults to the internal collection array.
Returns number | Promise<number>
The sum of all numeric values.
- Defined in packages/core/src/properties/CollectionProperty.ts:95

toJSON

toJSON(): any[] | DataObjectClass<any>[] | ObjectUri[] | undefined
Serializes the collection for JSON output.

Returns any[] | DataObjectClass<any>[] | ObjectUri[] | undefined
The raw array of values.
Overrides BaseProperty.toJSON
- Defined in packages/core/src/properties/CollectionProperty.ts:75

val

val(transform?: any): any
Retrieves the current value of the property, or its default value if currently undefined.
Parameters
- transform: any = undefined
  An optional transformation function applied to the value before returning it.
Returns any
The raw or transformed property value.
Inherited from BaseProperty.val
- Defined in packages/core/src/properties/BaseProperty.ts:183

Class CollectionProperty

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CollectionProperty

Properties

Protected_allows

Protected_defaultValue

Protected_events

Protected_hasChanged

Protected_htmlType

Protected_id

Protected_instanceOf

Protected_mandatory

Protected_name

Protected_parent

Protected_parentKey

Protected_protected

Protected_value

StaticEVENT_ONCHANGE

StaticEVENT_ONDELETE

StaticTYPE

Accessors

allows

Returns string[]

hasChanged

Returns boolean

Parameters

Returns void

htmlType

Returns PropertyHTMLType

Parameters

Returns void

mandatory

Returns boolean

name

Returns string

protected

Returns boolean

Methods

Protected_enable

Parameters

Returns value is true | undefined

apply

Parameters

Returns any[] | Promise<any[]>

average

Parameters

Returns number | Promise<number>

clone

Returns any

count

Parameters

Returns number | Promise<number>

distinct

Parameters

Returns any[] | Promise<any[]>

groupBy

Parameters

Returns Record<string, any[]> | Promise<Record<string, any[]>>

max

Parameters

Returns number | Promise<number | undefined> | undefined

min

Parameters

Returns number | Promise<number | undefined> | undefined

pluck

Parameters

Returns any[] | Promise<any[]>

set

Parameters

Returns CollectionProperty

sum

`Protected`_allows

`Protected`_defaultValue

`Protected`_events

`Protected`_hasChanged

`Protected`_htmlType

`Protected`_id

`Protected`_instanceOf

`Protected`_mandatory

`Protected`_name

`Protected`_parent

`Protected`_parentKey

`Protected`_protected

`Protected`_value

`Static`EVENT_ONCHANGE

`Static`EVENT_ONDELETE

`Static`TYPE

`Protected`_enable