Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ObservableArray<T>

Advanced array like class used when you want to be notified when a change occurs.

Type parameters

  • T

Hierarchy

Index

Constructors

constructor

Properties

Private _addArgs

_addArgs: ChangedData<T>

Private _array

_array: any[]

Private _deleteArgs

_deleteArgs: ChangedData<T>

_isViewBase

_isViewBase: boolean

Static changeEvent

changeEvent: string

String value used when hooking to change event.

Static propertyChangeEvent

propertyChangeEvent: string

Accessors

length

  • get (): number
  • set (value: number): void
  • Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Returns number

  • Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

    Parameters

    • value: number

    Returns void

Methods

_createPropertyChangeData

  • _createPropertyChangeData(propertyName: string, value: any, oldValue?: any): PropertyChangeData

_emit

  • _emit(eventNames: string): void

_notifyLengthChange

  • _notifyLengthChange(): void

addEventListener

  • addEventListener(eventNames: string, callback: function, thisArg?: any): void

concat

  • concat(...args: any[]): T[]

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: T, index: number, array: T[]): boolean
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

filter

  • filter(callbackfn: function, thisArg?: any): T[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): boolean
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns T[]

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function
        • (value: any, index: number, obj: any[]): unknown
        • Parameters

          • value: any
          • index: number
          • obj: any[]

          Returns unknown

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): void
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

get

  • get(name: string): any

getItem

  • getItem(index: number): T

hasListeners

  • hasListeners(eventName: string): boolean

indexOf

  • indexOf(searchElement: T, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

lastIndexOf

  • lastIndexOf(searchElement: T, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): U
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

notify

  • notify<T>(data: T): void

notifyPropertyChange

  • notifyPropertyChange(name: string, value: any, oldValue?: any): void

off

  • off(eventNames: string, callback?: any, thisArg?: any): void

on

  • on(eventNames: string, callback: function, thisArg?: any): void
  • on(event: "change", callback: function, thisArg?: any): void
  • A basic method signature to hook an event listener (shortcut alias to the addEventListener method).

    Parameters

    • eventNames: string

      String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by , (e.g. "propertyChange", "change").

    • callback: function

      Callback function which will be executed when event is raised.

    • Optional thisArg: any

      An optional parameter which will be used as this context for callback execution.

    Returns void

  • Parameters

    • event: "change"
    • callback: function
    • Optional thisArg: any

    Returns void

once

  • once(event: string, callback: function, thisArg?: any): void

pop

  • pop(): T

push

  • push(...args: any): number

reduce

  • reduce(callbackfn: function, initialValue?: T): T
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    • Optional initialValue: T

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns T

reduceRight

  • reduceRight(callbackfn: function, initialValue?: T): T
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    • Optional initialValue: T

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns T

removeEventListener

  • removeEventListener(eventNames: string, callback?: any, thisArg?: any): void

reverse

  • reverse(): T[]

set

  • set(name: string, value: any): void

setItem

  • setItem(index: number, value: T): void

setProperty

  • setProperty(name: string, value: any): void

shift

  • shift(): T

slice

  • slice(start?: number, end?: number): T[]
  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array.

    Returns T[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: T, index: number, array: T[]): boolean
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: function): T[]
  • Sorts an array.

    Parameters

    • Optional compareFn: function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

        • (a: T, b: T): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns T[]

splice

  • splice(start: number, deleteCount?: number, ...items: any): T[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    • Rest ...items: any

      Elements to insert into the array in place of the deleted elements.

    Returns T[]

toLocaleString

  • toLocaleString(): string

toString

  • toString(): string

unshift

  • unshift(...args: any): number

Static addEventListener

  • addEventListener(eventName: string, callback: any, thisArg?: any): void

Static off

  • off(eventName: string, callback?: any, thisArg?: any): void

Static on

  • on(eventName: string, callback: any, thisArg?: any): void

Static once

  • once(eventName: string, callback: any, thisArg?: any): void

Static removeEventListener

  • removeEventListener(eventName: string, callback?: any, thisArg?: any): void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method