Class BaseCollection`Abstract`

Basic collection abstract class; serves as the top class for all collections.

Example

class MyCollection extends BaseCollection {
    constructor(owner: object) {
        super(owner);
    }

    add(element: any) {
        // Add element logic
    }

    clear() {
        // collection initialization logic
    }

    _remove(pos: number): boolean {
        // Element deletion logic
        return true;
    }
}

const myCollection = new MyCollection(someOwner);
myCollection.add(someElement);
console.log(myCollection.count);

Hierarchy (view full)

MetaObject
- BaseCollection
  - ArrayCollection
  - PropertyCollection

Implements

Properties

`Protected`_elemTypes

_elemTypes: any[]

Defines the type constraints for the collection element.

_guid

_guid: string

Unique identifier of the object (GUID). Uniquely identifies the object.

`Readonly`_list

_list: any[]

An array that stores a list of elements in a collection. This array contains actual data from the collection.

`Protected`_owner

_owner: object

Owned object of the collection.

_type

_type: Function

The generator function of the object. The function used when the object was created.

`Readonly`count

count: number

Returns the number of elements in the current collection.

`Readonly`length

length: number

Returns the number of elements in the current collection.

`Static` `Readonly`_NS

_NS: string

Indicates the namespace.

Default

'Meta'

`Static` `Readonly`_PARAM

_PARAM: []

List of parameters used for the constructor.

`Static` `Readonly`_UNION

_UNION: []

List of implemented interfaces.

Default

[IObject, IMarshal]

Methods

`Protected`_getPropDescriptor

_getPropDescriptor(idx): object
Protected
Default descriptor set when adding elements to a collection.
Parameters
- idx: number
  Index of the element to which the technician will be imported.
Returns object
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:290

_onAdd

_onAdd(idx, elem): void
Generates an 'onAdd' event.
Parameters
- idx: number
  Index of the element to be added.
- elem: any
  The element to add.
Returns void
Listens
BaseCollection#onAdd
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:229

_onAdded

_onAdded(idx, elem): void
Generates an 'onAdd' event.
Parameters
- idx: number
  Index of added elements.
- elem: any
  Added element.
Returns void
Listens
BaseCollection#onAdded
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:238

_onChanged

_onChanged(idx, elem): any
Generates an 'onChanged' event.
Parameters
- idx: number
  Index of the changed element.
- elem: any
  Changed element.
Returns any
Listens
BaseCollection#onChanged
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:282

_onChanging

_onChanging(idx, elem): any
Generates an 'onChanging' event.
Parameters
- idx: number
  Index of the element to be changed.
- elem: any
  The element to be changed.
Returns any
Listens
BaseCollection#onChanging
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:274

_onClear

_onClear(): any
Generates an 'onClear' event.

Returns any
Listens
BaseCollection#onClear
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:260

_onCleared

_onCleared(): any
Generates an 'onCheared' event.

Returns any
Listens
BaseCollection#onCleared
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:266

_onRemove

_onRemove(idx, elem): void
Create an 'onRemove' event.
Parameters
- idx: number
  Index of the element to be deleted.
- elem: any
Returns void
Listens
BaseCollection#onRemove
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:246

_onRemoved

_onRemoved(idx, elem): void
Generates an 'onRemoved' event.
Parameters
- idx: number
  Index of the element to be deleted.
- elem: any
  The element to delete.
Returns void
Listens
BaseCollection#onRemoved
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:254

`Abstract`_remove

_remove(pos): boolean
Deletes an element in the collection (use internally)
Parameters
- pos: number
  Index of the element to be deleted.
Returns boolean
This is a Boolean value that indicates whether deletion is successful or not.
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:299

`Abstract`add

add(...args): number
Add an element to the collection.
Parameters
- Rest...args: any[]
Returns number
Implementation of ICollection.add
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:441

`Abstract`clear

clear(): void
Initialize the collection.

Returns void
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:447

contains

contains(elem): boolean
Verify that the element exists in the collection.
Parameters
- elem: any
  This is the element to check.
Returns boolean
This is a Boolean value indicating the presence or absence of an element.
Example
```
const exists = myCollection.contains(someElement);
console.log(`element exists: ${exists}`);
```
Implementation of ICollection.contains
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:359

equal

equal(target): boolean
Compare the current object with the specified object.
Parameters
- target: object
  the object to be compared to.
Returns boolean
Returns whether the two objects are the same.
Inherited from MetaObject.equal
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:30

every

every(callback, thisArg?): boolean
Test that all elements pass the test implemented with the provided function.
Parameters
- callback: ((value: any, index: number, array: this) => any)
  콜백함수 입니다. (currentValue, index, array) => boolean
  - - (value, index, array): any
    - Parameters
      value: any
      index: number
      array: this
      Returns any
- OptionalthisArg: any
  The value to use as this when executing the callback function.
Returns boolean
True if you return a true value for all array elements, otherwise false.
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:426

filter

filter(callback, thisArg?): any[]
Filter only to elements that have passed the test implemented by the provided function
Parameters
- callback: ((value: any, index: number, array: this) => any)
  콜백함수 입니다.(currentValue, index, array) => boolean
  - - (value, index, array): any
    - Parameters
      value: any
      index: number
      array: this
      Returns any
- OptionalthisArg: any
  The value to use as this when executing the callback function.
Returns any[]
Returns a new array of results.
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:387

find

find(callback, thisArg?): any
Returns the first element that satisfies the provided test function
Parameters
- callback: ((value: any, index: number, array: this) => any)
  This is the callback function. (currentValue, index, array) => any
  - - (value, index, array): any
    - Parameters
      value: any
      index: number
      array: this
      Returns any
- OptionalthisArg: any
  The value to use as this when executing the callback function.
Returns any
The first element in the array that satisfies the test function. If no element satisfies the test function, undefined is returned.
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:403

findIndex

findIndex(callback, thisArg?): any
Returns the first element that satisfies the provided test function
Parameters
- callback: ((value: any, index: number, array: this) => any)
  콜백함수 입니다. (currentValue, index, array) => boolean
  - - (value, index, array): any
    - Parameters
      value: any
      index: number
      array: this
      Returns any
- OptionalthisArg: any
  The value to use as this when executing the callback function. Index of the first element that passes the @returns{number} test. If no match exists, return -1.
Returns any
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:434

forEach

forEach(callback, thisArg?): void
Run the function provided for each element once.
Parameters
- callback: ((value: any, index: number, array: this) => void)
  This is the callback function. (currentValue, index, array) => void
  - - (value, index, array): void
    - Parameters
      value: any
      index: number
      array: this
      Returns void
- OptionalthisArg: any
  The value to use as this when executing the callback function.
Returns void
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:410

getObject

getObject(vOpt?, owned?): object
Returns the collection object as a guide type object.
Circular references are replaced by $ref values.
Parameters
- OptionalvOpt: number
  Serialization option.
  - opt=0: Reference structure (_guid: Yes, $ref: Yes)
  - opt=1: Redundant structure (_guid: Yes, $ref: Yes)
  - opt=2: Non-steep structure (_guid: No, $ref: No)
- Optionalowned: object | object[]
Returns object
Example
```
a.getObject(2) == b.getObject(2)
```
Overrides MetaObject.getObject
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:314

getTypes

getTypes(): Function[]
Returns the creators of the current object and all the creators of the prototype chain to the array.

Returns Function[]
Returns the array of generator functions.
Example
```
const types = obj.getTypes();
console.log(types); // [Function: MetaObject]
```
Inherited from MetaObject.getTypes
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:41

indexOf

indexOf(elem?): number
Look up an element in the collection.
Parameters
- Optionalelem: any
  The element to look up.
Returns number
Index of element. If element does not exist, return -1.
Example
```
const index = myCollection.indexOf(someElement);
console.log (index of element: ${index});
```
Implementation of ICollection.indexOf
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:371

instanceOf

instanceOf(target): boolean
Verify that the current object is an instance of the specified type (including _UNION)
Parameters
- target: string | object
  The type of object to be checked (object or string).
Returns boolean
Returns whether it is an instance of the specified type.
Inherited from MetaObject.instanceOf
- Defined in node_modules/logic-core/types/en/meta-object.d.ts:49

map

map(callback, thisArg?): any[]
Collects the results of calling a given function for each element and returns a new array.
Parameters
- callback: ((value: any, index: number, array: this) => any)
  This is the callback function (currentValue, index, array) => any[]
  - - (value, index, array): any
    - Parameters
      value: any
      index: number
      array: this
      Returns any
- OptionalthisArg: any
  The value to use as this when executing the callback function.
Returns any[]
Returns a new array of results.
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:379

reduce

reduce(callback, initialValue?): any
Run the given reducer function for each element and return one result.
Parameters
- callback: ((value: any, index: number, array: this) => any)
  콜백함수 입니다. (accumulator, currentValue, index, array) => any
  - - (value, index, array): any
    - Parameters
      value: any
      index: number
      array: this
      Returns any
- OptionalinitialValue: any
  Use the first element of the array if it does not provide an initial value.
Returns any
Returns a new array of results.
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:395

remove

remove(elem): number
Delete an element in the collection.
Parameters
- elem: any
  The element to delete.
Returns number
Index of deleted elements.
Example
```
const removedIndex = myCollection.remove(someElement);
console.log(`Index of deleted element: ${removedIndex}`);
```
Implementation of ICollection.remove
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:335

removeAt

removeAt(pos): boolean
Deletes an element in the specified location from the collection.
Parameters
- pos: number
  Index of the element to be deleted.
Returns boolean
This is a Boolean value that indicates whether element deletion is successful or not.
Example
```
const success = myCollection.removeAt(0);
console.log(`Delete element successful: ${success}`);
```
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:347

setObject

setObject(oGuid, origin?): any
Sets the guide type object to the collection object.
The object is initialized.
Parameters
- oGuid: object
  serialized object.
- Optionalorigin: object
  This is the source object that sets the current object. The default is oGuid.
Returns any
Overrides MetaObject.setObject
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:323

some

some(callback, thisArg?): boolean
Test that at least one element passes through a given discriminant function.
Parameters
- callback: ((value: any, index: number, array: this) => any)
  콜백함수 입니다. (currentValue, index, array) => boolean
  - - (value, index, array): any
    - Parameters
      value: any
      index: number
      array: this
      Returns any
- OptionalthisArg: any
  The value to use as this when executing the callback function.
Returns boolean
Returns true if you return a true value for one element, or false.
- Defined in node_modules/logic-core/types/en/base-collection.d.ts:418

Events

onAdd

onAdd: ((idx: number, elem: any, _this: object) => void)

Events that occur before adding an element to a collection.

BaseCollection#onAdd

Type declaration

- (idx, elem, _this): void
- Parameters
  - idx: number
    Index of the element to be added.
  - elem: any
    The element to add.
  - _this: object
    current collection object.
  Returns void

Example

myCollection.onAdd = function(idx, elem, _this) {
    console.log(`Before adding elements: index ${idx}, element ${elem}`);
};

onAdded

onAdded: ((idx: number, elem: any, _this: object) => void)

Events that occur after you add an element to a collection.

BaseCollection#onAdded

Type declaration

- (idx, elem, _this): void
- Parameters
  - idx: number
    Index of added elements.
  - elem: any
    Added element.
  - _this: object
    current collection object.
  Returns void

Example

myCollection.onAdded = function(idx, elem, _this) {
    console.log ('After adding elements: index ${idx}, element ${elem}');
};

onChanged

onChanged: ((idx: number, elem: any, _this: object) => void)

Events that occur after you change an element in a collection.

BaseCollection#onChanged

Type declaration

- (idx, elem, _this): void
- Parameters
  - idx: number
    Index of the changed element.
  - elem: any
    Changed element.
  - _this: object
    current collection object.
  Returns void

Example

myCollection.onChanged = function(idx, elem, _this) {
    console.log ('After element change: index ${idx}, element ${elem}');
};

onChanging

onChanging: ((idx: number, elem: any, _this: object) => void)

An event that occurs before you change an element in a collection.

BaseCollection#onChanging

Type declaration

- (idx, elem, _this): void
- Parameters
  - idx: number
    Index of the element to be changed.
  - elem: any
    The element to be changed.
  - _this: object
    current collection object.
  Returns void

Example

myCollection.onChanging = function(idx, elem, _this) {
    console.log(`Before element change: index ${idx}, element ${elem}`);
};

onClear

onClear: ((_this: object) => {})

Events that occur before the collection is initialized.

BaseCollection#onClear

Type declaration

- (_this): {}
- Parameters
  - _this: object
    current collection object.
  Returns {}

Example

myCollection.onClear = function(_this) {
    console.log ('Before collection initialization);
};

onCleared

onCleared: ((_this: object) => {})

Events that occur after the collection is initialized.

BaseCollection#onCleared

Type declaration

- (_this): {}
- Parameters
  - _this: object
    current collection object.
  Returns {}

Example

myCollection.onCleared = function(_this) {
    console.log ('After collection initialization');
};

onRemove

onRemove: ((idx: number, elem: any, _this: object) => void)

An event that occurs before an element is deleted from the collection.

BaseCollection#onRemove

Type declaration

- (idx, elem, _this): void
- Parameters
  - idx: number
    Index of the element to be deleted.
  - elem: any
    The element to delete.
  - _this: object
    current collection object.
  Returns void

Example

myCollection.onRemove = function(idx, elem, _this) {
    console.log(`Before element deletion: index ${idx}, element ${elem}`);
};

onRemoved

onRemoved: ((idx: number, elem: any, _this: object) => void)

Events that occur after you delete an element from a collection.

BaseCollection#onRemoved

Type declaration

- (idx, elem, _this): void
- Parameters
  - idx: number
    Index of deleted elements.
  - elem: any
    Deleted element.
  - _this: object
    current collection object.
  Returns void

Example

myCollection.onRemoved = function(idx, elem, _this) {
    console.log(`After element deletion: index ${idx}, element ${elem}`);
};

Class BaseCollectionAbstract

Example

Hierarchy (view full)

Implements

Index

Properties

Methods

Events

Properties

Protected_elemTypes

_guid

Readonly_list

Protected_owner

_type

Readonlycount

Readonlylength

Static Readonly_NS

Default

Static Readonly_PARAM

Static Readonly_UNION

Default

Methods

Protected_getPropDescriptor

Parameters

Returns object

_onAdd

Parameters

Returns void

Listens

_onAdded

Parameters

Returns void

Listens

_onChanged

Parameters

Returns any

Listens

_onChanging

Parameters

Returns any

Listens

_onClear

Returns any

Listens

_onCleared

Returns any

Listens

_onRemove

Parameters

Returns void

Listens

_onRemoved

Parameters

Returns void

Listens

Abstract_remove

Parameters

Returns boolean

Abstractadd

Parameters

Returns number

Abstractclear

Returns void

contains

Parameters

Returns boolean

Example

equal

Parameters

Returns boolean

every

Parameters

Parameters

Returns any

Returns boolean

filter

Parameters

Parameters

Returns any

Returns any[]

Class BaseCollection`Abstract`

`Protected`_elemTypes

`Readonly`_list

`Protected`_owner

`Readonly`count

`Readonly`length

`Static` `Readonly`_NS

`Static` `Readonly`_PARAM

`Static` `Readonly`_UNION

`Protected`_getPropDescriptor

`Abstract`_remove

`Abstract`add

`Abstract`clear