Class ModelCollection<T>

constructor

• new ModelCollection<T>(data, descriptorConfig, initConfig): ModelCollection<T>

• Type Parameters

  • T extends AbstractModel<any>

  Parameters

  • data: any[]
  • descriptorConfig: IHasManyMainDescriptorConfig<T, void>
  • initConfig: Partial<ModelOptions>

  Returns ModelCollection<T>

items

modelId

type

add

• add(item): ModelCollection<T>

• Parameters

  • item: T

  Returns ModelCollection<T>

addItems

• addItems(added): void

• Parameters

  • added: T[]

  Returns void

addValidator

• addValidator(validator): void

• Parameters

  • validator: IFieldValidator<AbstractModel<any>>

  Returns void

calculateCollectionDirty

• calculateCollectionDirty(): boolean

• Returns boolean

calculateDeepDirty

• calculateDeepDirty(): boolean

• Returns boolean

calculateDirty

• calculateDirty(): boolean

• Returns boolean

clearCollection

• clearCollection(): void

• Returns void

clearValidationResult

• clearValidationResult(): void

• Returns void

clearValidators

• clearValidators(): void

• Returns void

clone

• clone(): ModelCollection<T>

• Returns ModelCollection<T>

commit

• commit(): void

• Returns void

commitCollection

• commitCollection(): void

• Returns void

find

• find(fn): undefined | T

• Search by function among items

  Parameters

  • fn: ((item: T) => boolean)
    • • (item): boolean

      • Parameters

        • item: T

        Returns boolean

  Returns undefined | T

find2

• find2(callback): null | T

• Returns the found collection element or null Iteratively traverses the elements of the collection, and returns the first element of the collection for which callback returns true.

  Parameters

  • callback: ((item: T, index: number, items: T[]) => boolean)

    search function

    • • (item, index, items): boolean

      • Parameters

        • item: T
        • index: number
        • items: T[]

        Returns boolean

  Returns null | T

findIndex

• findIndex(find): number

• Find index of element or -1 by predicate (same as native findIndex method)

  Parameters

  • find: ((item: T, index: number, items: T[]) => boolean)
    • • (item, index, items): boolean

      • Parameters

        • item: T
        • index: number
        • items: T[]

        Returns boolean

  Returns number

forEach

• forEach(callback): void

• Iteratively traverses the collection elements

  Parameters

  • callback: ((item: T, index: number, items: T[]) => void)

    search function

    • • (item, index, items): void

      • Parameters

        • item: T
        • index: number
        • items: T[]

        Returns void

  Returns void

get

• get(index): undefined | T

• Parameters

  • index: number

  Returns undefined | T

getAdded

• getAdded(): T[]

• Returns T[]

getByPropertyValues

• getByPropertyValues(propName, values): T[]

• Parameters

  • propName: string
  • values: any[]

  Returns T[]

getCollectionDirty

• getCollectionDirty(): boolean

• Returns boolean

getCount

• getCount(): number

• Get the number of items in the collection

  Returns number

getDeepDirty

• getDeepDirty(): boolean

• Returns boolean

getDirty

• getDirty(): boolean

• Returns boolean

getOriginal

• getOriginal(): T[]

• Returns T[]

getRange

• getRange(): T[]

• Returns a new array containing all the items in the collection.

  Returns T[]

getRemoved

• getRemoved(): T[]

• Returns T[]

getUpdated

• getUpdated(): T[]

• Returns T[]

getValidationResult

• getValidationResult(level?): IValidationResult

• Parameters

  • Optionallevel: number

  Returns IValidationResult

hasValidator

• hasValidator(validator): boolean

• Parameters

  • validator: ClassCtor<IFieldValidator<AbstractModel<any>>, any[]>

  Returns boolean

indexOf

• indexOf(item): number

• Returns the index of an item in the collection. If the item is not in the collection -1 is returned

  Parameters

  • item: T

  Returns number

insertAfter

• insertAfter(model, after): void

• Inserts an element after an element

  Parameters

  • model: T

    Model
  • after: T

    the element to insert after

  Returns void

insertAt

• insertAt(model, index, skipValidation?): void

• Inserts an item in the collection in the index position

  Parameters

  • model: T
  • index: number
  • OptionalskipValidation: boolean

  Returns void

insertBefore

• insertBefore(model, before): void

• Inserts an element before the element

  Parameters

  • model: T

    Model
  • before: T

    the element to insert before

  Returns void

insertFirst

• insertFirst(model): void

• Inserts the item first in the collection

  Parameters

  • model: T

  Returns void

insertLast

• insertLast(model, skipValidation?): void

• Inserts the item last in the collection

  Parameters

  • model: T
  • OptionalskipValidation: boolean

  Returns void

isEqual

• isEqual(collection, config?): boolean

• Parameters

  • collection: ModelCollection<T>
  • Optionalconfig: EqualConfig

  Returns boolean

moveItem

• moveItem(oldIndex, newIndex): void

• Moves item to new position

  Parameters

  • oldIndex: number
  • newIndex: number

  Returns void

onItemValidation

• onItemValidation(modelId, validationResult): void

• Parameters

  • modelId: number
  • validationResult: IValidationResult

  Returns void

remove

• remove(item): ModelCollection<T>

• Parameters

  • item: T

  Returns ModelCollection<T>

removeAll

• removeAll(): ModelCollection<T>

• Returns ModelCollection<T>

removeAt

• removeAt(index): ModelCollection<T>

• Parameters

  • index: number

  Returns ModelCollection<T>

replaceAll

• replaceAll(added): ModelCollection<T>

• Parameters

  • added: T[]

  Returns ModelCollection<T>

replaceAt

• replaceAt(model, index, skipValidation?): void

• Replace an item in the collection in the index position

  Parameters

  • model: T
  • index: number
  • OptionalskipValidation: boolean

  Returns void

revert

• revert(): void

• Returns void

serialize

• serialize(config?): object[]

• Parameters

  • Optionalconfig: any

  Returns object[]

setAdded

• setAdded(added): void

• Parameters

  • added: T[]

  Returns void

setOriginal

• setOriginal(original): void

• Parameters

  • original: T[]

  Returns void

setPhantomCascade

• setPhantomCascade(phantom): void

• Parameters

  • phantom: boolean

  Returns void

setReactiveCascade

• setReactiveCascade(props): void

• Make all models in the collection and their properties reactive

  Parameters

  • props: ReactiveProp[]

  Returns void

setRemoved

• setRemoved(removed): void

• Parameters

  • removed: T[]

  Returns void

size

• size(): number

• Returns number

sort

• sort(compareFn?): void

• Parameters

  • OptionalcompareFn: ((a: T, b: T) => number)
    • • (a, b): number

      • Parameters

        • a: T
        • b: T

        Returns number

  Returns void

swapItems

• swapItems(a, b): void

• Swaps items in the collection

  Parameters

  • a: T
  • b: T

  Returns void

updateCollectionDirty

• updateCollectionDirty(): void

• Returns void

updateDeepDirty

• updateDeepDirty(): void

• Returns void

updateDirty

• updateDirty(): void

• Returns void

validate

• validate(deep?, disablePropagation?): IValidationResult

• Parameters

  • Optionaldeep: boolean

    flag for validate NOT only collection validators, but validators in each models in collection
  • OptionaldisablePropagation: boolean

    Parent cmp notification flag about validation

  Returns IValidationResult

Staticcreate

• create<T>(type, onChangeDirty?): ModelCollection<T>

• Type Parameters

  • T extends AbstractModel<any>

  Parameters

  • type: ClassCtor<T, any[]>
  • OptionalonChangeDirty: (() => void)
    • • (): void

      • Returns void

  Returns ModelCollection<T>