Interface KnockoutObservableArray

Extensions to KO functions to provide validation

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>

(): 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 destroy(item: T in KnockoutObservableArrayFunctions<T>)

Parameters

  • item: T in KnockoutObservableArrayFunctions<T>

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 destroyAll(items: Array<T>)

Parameters

  • items: Array<T>

public destroyAll()

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

Parameters

  • a: any
  • b: any

Returns

boolean

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

Parameters

  • a: any
  • b: any

Returns

boolean

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

Parameters

  • a: any
  • b: any

Returns

boolean

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

Parameters

  • a: any
  • b: any

Returns

boolean

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

Parameters

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

Returns

KnockoutObservableArray

public getSubscriptionsCount(): number

Returns

number

public getSubscriptionsCount(): number

Returns

number

public getSubscriptionsCount(): number

Returns

number

public getSubscriptionsCount(): number

Returns

number

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

Parameters

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

Returns

number

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

Parameters

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

Returns

number

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

Parameters

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

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

Parameters

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

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

Parameters

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

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

Parameters

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

public peek(): T in KnockoutObservable<T>

Returns

T in KnockoutObservable<T>

public peek(): T in KnockoutObservable<T>

Returns

T in KnockoutObservable<T>

public pop(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

public pop(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

public push(items?: Array<T>)

Parameters

  • items?: Array<T> optional

public push(items?: Array<T>)

Parameters

  • items?: Array<T> optional

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 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 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 replace(oldItem: T in KnockoutObservableArrayFunctions<T>, newItem: T in KnockoutObservableArrayFunctions<T>)

Parameters

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

public reverse(): Array<T>

Returns

Array<T>

public reverse(): Array<T>

Returns

Array<T>

public shift(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

public shift(): T in KnockoutObservableArrayFunctions<T>

Returns

T in KnockoutObservableArrayFunctions<T>

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

Parameters

  • start: number
  • end?: number optional

Returns

Array<T>

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

Parameters

  • start: number
  • end?: number optional

Returns

Array<T>

public sort()

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

Parameters

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

public sort()

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

Parameters

  • compareFunction: (left: T, right: T) => 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 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 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 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 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 unshift(items?: Array<T>): number

Parameters

  • items?: Array<T> optional

Returns

number

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

Parameters

  • items?: Array<T> optional

Returns

number

public validate(validationOptions?: ValidationOptions): PropertyValidationState

Parameters

Returns

PropertyValidationState

public validate(validationOptions?: ValidationOptions): PropertyValidationState

Parameters

Returns

PropertyValidationState

public validate(validationOptions?: ValidationOptions): PropertyValidationState

Parameters

Returns

PropertyValidationState

public validateAsModel(): ValidatableModel

Creates and sets a model validation state on a Knockout observable array.
[fluent]

name

ko.observableArray#validateAsModel

method
fluent

Returns

ValidatableModel

the validation state belonging to the observable array

public validateAsModel(): ValidatableModel

Creates and sets a model validation state on a Knockout observable array.
[fluent]

name

ko.observableArray#validateAsModel

method
fluent

Returns

ValidatableModel

the validation state belonging to the observable array