Interface KnockoutObservableArray

Hierarchy

Index

Call signatures

Properties

Methods

Call signatures

(): T in KnockoutObservable<T>

Returns

T in KnockoutObservable<T>

(value: T in KnockoutObservable<T>)

Parameters

  • value: T in KnockoutObservable<T>

Properties

optional public valueHasMutated?: () => void

()

optional public valueWillMutate?: () => void

()

Methods

public all(iterator: ListIterator, context?: any): boolean

Parameters

Returns

boolean

public any(iterator?: ListIterator, context?: any): boolean

Parameters

Returns

boolean

public chain(object: any): any

Chaining

Parameters

  • object: any

Returns

any

public collect(iterator: ListIterator, context?: any): Array<TResult>

Parameters

Returns

Array<TResult>

public collect(iterator: ObjectIterator, context?: any): Array<TResult>

Parameters

Returns

Array<TResult>

public compact(): Array<T>

Returns

Array<T>

public compact_(): Array<T>

Returns

Array<T>

public contains(value: T in KnockoutObservableArrayFunctions<T>): boolean

Parameters

  • value: T in KnockoutObservableArrayFunctions<T>

Returns

boolean

public countBy(iterator: ListIterator): Dictionary

Parameters

Returns

Dictionary

public countBy(iterator: string): Dictionary

Parameters

  • iterator: string

Returns

Dictionary

public destroy(item: T in KnockoutObservableArrayFunctions<T>)

Parameters

  • item: T in KnockoutObservableArrayFunctions<T>

public destroyAll(items: Array<T>)

Parameters

  • items: Array<T>

public destroyAll()

public detect(iterator: ListIterator, context?: any): T in KnockoutObservableArrayFunctions<T>

Parameters

Returns

T in KnockoutObservableArrayFunctions<T>

public difference(others?: Array<T[]>): Array<T>

Parameters

  • others?: Array<T[]> optional

Returns

Array<T>

public difference_(others?: Array<T[]>): Array<T>

Parameters

  • others?: Array<T[]> optional

Returns

Array<T>

public drop(n?: number): Array<T>

Parameters

  • n?: number optional

Returns

Array<T>

public drop_(n?: number): Array<T>

Parameters

  • n?: number optional

Returns

Array<T>

public each(iterator: ListIterator, context?: any): Array<TResult>

Collections

Parameters

Returns

Array<TResult>

public each(iterator: ObjectIterator, context?: any): Array<TResult>

Parameters

Returns

Array<TResult>

public equalityComparer(a: any, b: any): boolean

Parameters

  • a: any
  • b: any

Returns

boolean

public every(iterator: ListIterator, context?: any): boolean

Parameters

Returns

boolean

public extend(requestedExtenders: { [key: string]: any; }): KnockoutObservableArray

Parameters

  • requestedExtenders: { [key: string]: any; }

Returns

KnockoutObservableArray

public filter(iterator: ListIterator, context?: any): Array<T>

Parameters

Returns

Array<T>

public filter_(iterator: ListIterator, context?: any): Array<T>

Parameters

Returns

Array<T>

public find(iterator: ListIterator, context?: any): T in KnockoutObservableArrayFunctions<T>

Parameters

Returns

T in KnockoutObservableArrayFunctions<T>

public first(): T in KnockoutObservableArrayFunctions<T>

Arrays

Returns

T in KnockoutObservableArrayFunctions<T>

public first(n: number): Array<T>

Parameters

  • n: number

Returns

Array<T>

public flatten(shallow?: boolean): Array<any>

Parameters

  • shallow?: boolean optional

Returns

Array<any>

public flatten_(shallow?: boolean): Array<any>

Parameters

  • shallow?: boolean optional

Returns

Array<any>

public foldl(iterator: MemoIterator, memo: TResult, context?: any): TResult

Parameters

  • iterator: MemoIterator
  • memo: TResult
  • context?: any optional

Returns

TResult

public foldr(iterator: MemoIterator, memo: TResult, context?: any): TResult

Parameters

  • iterator: MemoIterator
  • memo: TResult
  • context?: any optional

Returns

TResult

public forEach(iterator: ObjectIterator, context?: any): Array<TResult>

Parameters

Returns

Array<TResult>

public forEach(iterator: ListIterator, context?: any): Array<TResult>

Parameters

Returns

Array<TResult>

public getSubscriptionsCount(): number

Returns

number

public groupBy(iterator: ListIterator): Dictionary

Parameters

Returns

Dictionary

public groupBy(iterator: string): Dictionary

Parameters

  • iterator: string

Returns

Dictionary

public groupBy_(iterator: ListIterator): Dictionary

Parameters

Returns

Dictionary

public groupBy_(iterator: string): Dictionary

Parameters

  • iterator: string

Returns

Dictionary

public head(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

public head(n: number): Array<T>

Parameters

  • n: number

Returns

Array<T>

public include(value: T in KnockoutObservableArrayFunctions<T>): boolean

Parameters

  • value: T in KnockoutObservableArrayFunctions<T>

Returns

boolean

public indexOf(searchElement: T in KnockoutObservableArrayFunctions<T>, fromIndex?: number): number

Parameters

  • searchElement: T in KnockoutObservableArrayFunctions<T>
  • fromIndex?: number optional

Returns

number

public initial(n?: number): Array<T>

Parameters

  • n?: number optional

Returns

Array<T>

public inject(iterator: MemoIterator, memo: TResult, context?: any): TResult

Parameters

  • iterator: MemoIterator
  • memo: TResult
  • context?: any optional

Returns

TResult

public intersection(arrays?: Array<T[]>): Array<T>

Parameters

  • arrays?: Array<T[]> optional

Returns

Array<T>

public intersection_(arrays?: Array<T[]>): Array<T>

Parameters

  • arrays?: Array<T[]> optional

Returns

Array<T>

public invoke(methodName: string, arguments?: Array<any>): any

Parameters

  • methodName: string
  • arguments?: Array<any> optional

Returns

any

public invoke_(methodName: string, arguments?: Array<any>): any

Parameters

  • methodName: string
  • arguments?: Array<any> optional

Returns

any

public last(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

public last(n: number): Array<T>

Parameters

  • n: number

Returns

Array<T>

public lastIndexOf(value: T in KnockoutObservableArrayFunctions<T>, fromIndex?: number): number

Parameters

  • value: T in KnockoutObservableArrayFunctions<T>
  • fromIndex?: number optional

Returns

number

public lastIndexOf(value: T in KnockoutObservableArrayFunctions<T>, isSorted?: boolean): number

Parameters

  • value: T in KnockoutObservableArrayFunctions<T>
  • isSorted?: boolean optional

Returns

number

public map(iterator: ListIterator, context?: any): Array<TResult>

Parameters

Returns

Array<TResult>

public map(iterator: ObjectIterator, context?: any): Array<TResult>

Parameters

Returns

Array<TResult>

public max(iterator: ListIterator, context?: any): any

Parameters

Returns

any

public min(iterator: ListIterator, context?: any): any

Parameters

Returns

any

public notifySubscribers(valueToWrite?: T in KnockoutSubscribableFunctions<T>, event?: string)

Parameters

  • valueToWrite?: T in KnockoutSubscribableFunctions<T> optional
  • event?: string optional

public object(): any

Returns

any

public peek(): T in KnockoutObservable<T>

Returns

T in KnockoutObservable<T>

public pluck(propertyName: string): Array<T>

Parameters

  • propertyName: string

Returns

Array<T>

public pop(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

public push(items?: Array<T>)

Parameters

  • items?: Array<T> optional

public range(stop: number): Array<any>

Parameters

  • stop: number

Returns

Array<any>

public range(start: number, stop: number, step?: number): Array<any>

Parameters

  • start: number
  • stop: number
  • step?: number optional

Returns

Array<any>

public reduce(iterator: MemoIterator, memo: TResult, context?: any): TResult

Parameters

  • iterator: MemoIterator
  • memo: TResult
  • context?: any optional

Returns

TResult

public reduceRight(iterator: MemoIterator, memo: TResult, context?: any): TResult

Parameters

  • iterator: MemoIterator
  • memo: TResult
  • context?: any optional

Returns

TResult

public reject(iterator: ListIterator, context?: any): Array<T>

Parameters

Returns

Array<T>

public reject_(iterator: ListIterator, context?: any): Array<T>

Parameters

Returns

Array<T>

public remove(item: T in KnockoutObservableArrayFunctions<T>): Array<T>

Parameters

  • item: T in KnockoutObservableArrayFunctions<T>

Returns

Array<T>

public remove(removeFunction: (item: T) => boolean): Array<T>

Parameters

  • removeFunction: (item: T) => boolean

Returns

Array<T>

public removeAll(items: Array<T>): Array<T>

Parameters

  • items: Array<T>

Returns

Array<T>

public removeAll(): Array<T>

Returns

Array<T>

public replace(oldItem: T in KnockoutObservableArrayFunctions<T>, newItem: T in KnockoutObservableArrayFunctions<T>)

Parameters

  • oldItem: T in KnockoutObservableArrayFunctions<T>
  • newItem: T in KnockoutObservableArrayFunctions<T>

public rest(n?: number): Array<T>

Parameters

  • n?: number optional

Returns

Array<T>

public rest_(n?: number): Array<T>

Parameters

  • n?: number optional

Returns

Array<T>

public reverse(): Array<T>

Returns

Array<T>

public select(iterator: ListIterator, context?: any): Array<T>

Parameters

Returns

Array<T>

public select_(iterator: ListIterator, context?: any): Array<T>

Parameters

Returns

Array<T>

public shift(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

public shuffle(): Array<T>

Returns

Array<T>

public shuffle_(): Array<T>

Returns

Array<T>

public size(): number

Returns

number

public slice(start: number, end?: number): Array<T>

Parameters

  • start: number
  • end?: number optional

Returns

Array<T>

public some(iterator?: ListIterator, context?: any): boolean

Parameters

Returns

boolean

public sort()

public sort(compareFunction: (left: T, right: T) => number)

Parameters

  • compareFunction: (left: T, right: T) => number

public sortBy(iterator: ListIterator, context?: any): Array<T>

Parameters

Returns

Array<T>

public sortBy(iterator: string, context?: any): Array<T>

Parameters

  • iterator: string
  • context?: any optional

Returns

Array<T>

public sortBy_(iterator: ListIterator, context?: any): Array<T>

Parameters

Returns

Array<T>

public sortBy_(iterator: string, context?: any): Array<T>

Parameters

  • iterator: string
  • context?: any optional

Returns

Array<T>

public sortedIndex(value: T in KnockoutObservableArrayFunctions<T>, iterator?: ListIterator): number

Parameters

  • value: T in KnockoutObservableArrayFunctions<T>
  • iterator?: ListIterator optional

Returns

number

public splice(start: number): Array<T>

Parameters

  • start: number

Returns

Array<T>

public splice(start: number, deleteCount: number, items?: Array<T>): Array<T>

Parameters

  • start: number
  • deleteCount: number
  • items?: Array<T> optional

Returns

Array<T>

public subscribe(callback: (newValue: T) => void, target?: any, event?: string): KnockoutSubscription

Parameters

  • callback: (newValue: T) => void
  • target?: any optional
  • event?: string optional

Returns

KnockoutSubscription

public subscribe(callback: (newValue: TEvent) => void, target: any, event: string): KnockoutSubscription

Parameters

  • callback: (newValue: TEvent) => void
  • target: any
  • event: string

Returns

KnockoutSubscription

public tail(n?: number): Array<T>

Parameters

  • n?: number optional

Returns

Array<T>

public tail_(n?: number): Array<T>

Parameters

  • n?: number optional

Returns

Array<T>

public take(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

public take(n: number): Array<T>

Parameters

  • n: number

Returns

Array<T>

public union(arrays?: Array<T[]>): Array<T>

Parameters

  • arrays?: Array<T[]> optional

Returns

Array<T>

public union_(arrays?: Array<T[]>): Array<T>

Parameters

  • arrays?: Array<T[]> optional

Returns

Array<T>

public uniq(isSorted?: boolean, iterator?: ListIterator): Array<T>

Parameters

  • isSorted?: boolean optional
  • iterator?: ListIterator optional

Returns

Array<T>

public uniq_(isSorted?: boolean, iterator?: ListIterator): Array<T>

Parameters

  • isSorted?: boolean optional
  • iterator?: ListIterator optional

Returns

Array<T>

public unique(isSorted?: boolean, iterator?: ListIterator): Array<T>

Parameters

  • isSorted?: boolean optional
  • iterator?: ListIterator optional

Returns

Array<T>

public unique_(isSorted?: boolean, iterator?: ListIterator): Array<T>

Parameters

  • isSorted?: boolean optional
  • iterator?: ListIterator optional

Returns

Array<T>

public unshift(items?: Array<T>): number

Parameters

  • items?: Array<T> optional

Returns

number

public where(properties: U): Array<T>

Parameters

  • properties: U

Returns

Array<T>

public without(values?: Array<T>): Array<T>

Parameters

  • values?: Array<T> optional

Returns

Array<T>

public without_(values?: Array<T>): Array<T>

Parameters

  • values?: Array<T> optional

Returns

Array<T>

public zip(arrays?: Array<any>): Array<any>

Parameters

  • arrays?: Array<any> optional

Returns

Array<any>

public zip_(arrays?: Array<any>): Array<any>

Parameters

  • arrays?: Array<any> optional

Returns

Array<any>