Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Collection

extension of a backbone.js Collection.

The Relution.livedata.Collection can be used like a Backbone Collection, but there are some enhancements to fetch, save and delete the contained models from or to other "data stores".

see WebSqlStore or SyncStore for examples

Hierarchy

  • Collection<Model>
    • Collection

Hierarchy-Diagram

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Collection(models?: any, options?: any): Collection

  • Parameters

    • Optional models: any
    • Optional options: any

    Returns Collection

Properties

_type

_type: string

channel

channel: string

comparator

comparator: string | function | function

Specify a model attribute name (string) or function that will be used to sort the collection.

credentials

credentials: any

endpoint

endpoint: SyncEndpoint

entity

entity: string

isCollection

isCollection: boolean

isModel

isModel: boolean

isStore

isStore: boolean

length

length: number

model

model: ModelCtor

modelId

modelId: function

Type declaration

    • (attrs: any): any

    • Parameters

      • attrs: any

      Returns any

models

models: Model[]

options

options: any

store

store: Store

syncContext

syncContext: SyncContext

url

url: any

Methods

Private _entityFromUrl

  • _entityFromUrl(urlStr: string): string

  • Parameters

    • urlStr: string

    Returns string

Private _updateUrl

  • _updateUrl(): void

  • Returns void

add

  • add(model: object | Model, options?: AddOptions): Model
  • add(models: object | TModel, options?: AddOptions): Model[]

  • Parameters

    • model: object | Model
    • Optional options: AddOptions

    Returns Model

  • Parameters

    • models: object | TModel
    • Optional options: AddOptions

    Returns Model[]

ajax

  • ajax(options: any): any

  • Parameters

    • options: any

    Returns any

all

  • all(iterator?: ListIterator<Model, boolean>, context?: any): boolean

  • Parameters

    • Optional iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns boolean

any

  • any(iterator?: ListIterator<Model, boolean>, context?: any): boolean

  • Parameters

    • Optional iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns boolean

applyFilter

  • applyFilter(callback: ListIterator<Model, boolean>): void

  • Parameters

    • callback: ListIterator<Model, boolean>

    Returns void

at

  • at(index: number): Model

  • Parameters

    • index: number

    Returns Model

bind

  • bind(eventName: string, callback: Function, context?: any): any

  • Parameters

    • eventName: string
    • callback: Function
    • Optional context: any

    Returns any

chain

  • chain(): any

  • Returns any

collect

  • collect<TResult>(iterator: ListIterator<Model, TResult>, context?: any): TResult[]

  • Type parameters

    • TResult

    Parameters

    • iterator: ListIterator<Model, TResult>
    • Optional context: any

    Returns TResult[]

contains

  • contains(value: Model): boolean

  • Parameters

    Returns boolean

countBy

  • countBy(iterator?: ListIterator<Model, any>): Dictionary<number>
  • countBy(iterator: string): Dictionary<number>

  • Parameters

    • Optional iterator: ListIterator<Model, any>

    Returns Dictionary<number>

  • Parameters

    • iterator: string

    Returns Dictionary<number>

create

  • create(attributes: any, options?: ModelSaveOptions): Model

  • Parameters

    • attributes: any
    • Optional options: ModelSaveOptions

    Returns Model

destroy

  • destroy(options?: any): void

  • Parameters

    • Optional options: any

    Returns void

detect

  • detect(iterator: ListIterator<Model, boolean>, context?: any): Model

  • Parameters

    • iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns Model

difference

  • Parameters

    Returns Model[]

drop

  • drop(n?: number): Model[]

  • Parameters

    • Optional n: number

    Returns Model[]

each

  • each(iterator: ListIterator<Model, void>, context?: any): Model[]

  • Parameters

    • iterator: ListIterator<Model, void>
    • Optional context: any

    Returns Model[]

every

  • every(iterator: ListIterator<Model, boolean>, context?: any): boolean

  • Parameters

    • iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns boolean

fetch

  • fetch(options?: CollectionFetchOptions): JQueryXHR

  • Parameters

    • Optional options: CollectionFetchOptions

    Returns JQueryXHR

fetchMore

  • fetchMore(options?: any): PromiseLike<any>

  • reads an additional page of data into this collection.

    A fetch() must have been performed loading the initial set of data. This method is intended for infinite scrolling implementation.

    When async processing is done, a more attribute is set on the options object in case additional data might be available which can be loaded by calling this method again. Likewise an end attribute is set if the data is fully loaded.

    see

    SyncContext#fetchMore()

    Parameters

    • Optional options: any

      such as pageSize to retrieve.

    Returns PromiseLike<any>

    promise of the load operation.

fetchNext

  • fetchNext(options?: any): PromiseLike<any>

  • reads the next page of data into this collection.

    A fetch() must have been performed loading the initial set of data. This method is intended for paging implementation.

    When async processing is done, a next/prev attribute is set on the options object in case additional pages might be available which can be loaded by calling the corresponding method.

    see

    SyncContext#fetchNext()

    Parameters

    • Optional options: any

      such as pageSize to retrieve.

    Returns PromiseLike<any>

    promise of the load operation.

fetchPrev

  • fetchPrev(options?: any): PromiseLike<any>

  • reads the previous page of data into this collection.

    A fetch() must have been performed loading the initial set of data. This method is intended for paging implementation.

    When async processing is done, a next/prev attribute is set on the options object in case additional pages might be available which can be loaded by calling the corresponding method.

    see

    SyncContext#fetchPrev()

    Parameters

    • Optional options: any

      such as pageSize to retrieve.

    Returns PromiseLike<any>

    promise of the load operation.

filter

  • filter(iterator: ListIterator<Model, boolean>, context?: any): Model[]

  • Parameters

    • iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns Model[]

find

  • find(iterator: ListIterator<Model, boolean>, context?: any): Model

  • Parameters

    • iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns Model

findIndex

  • findIndex(predicate: ListIterator<Model, boolean>, context?: any): number

  • Parameters

    • predicate: ListIterator<Model, boolean>
    • Optional context: any

    Returns number

findLastIndex

  • findLastIndex(predicate: ListIterator<Model, boolean>, context?: any): number

  • Parameters

    • predicate: ListIterator<Model, boolean>
    • Optional context: any

    Returns number

findWhere

  • findWhere(properties: any): Model

  • Parameters

    • properties: any

    Returns Model

first

  • Returns Model

  • Parameters

    • n: number

    Returns Model[]

foldl

  • foldl<TResult>(iterator: MemoIterator<Model, TResult>, memo?: TResult, context?: any): TResult

  • Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<Model, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

foldr

  • foldr<TResult>(iterator: MemoIterator<Model, TResult>, memo?: TResult, context?: any): TResult

  • Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<Model, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

forEach

  • forEach(iterator: ListIterator<Model, void>, context?: any): Model[]

  • Parameters

    • iterator: ListIterator<Model, void>
    • Optional context: any

    Returns Model[]

get

  • get(id: number | string | Model): Model

  • Get a model from a collection, specified by an id, a cid, or by passing in a model.

    Parameters

    • id: number | string | Model

    Returns Model

getUrl

  • getUrl(): string

  • Returns string

getUrlParams

  • getUrlParams(url?: string): any

  • Parameters

    • Optional url: string

    Returns any

getUrlRoot

  • getUrlRoot(): string

  • Returns string

groupBy

  • groupBy(iterator: ListIterator<Model, any>, context?: any): Dictionary<Model[]>
  • groupBy(iterator: string, context?: any): Dictionary<Model[]>

  • Parameters

    • iterator: ListIterator<Model, any>
    • Optional context: any

    Returns Dictionary<Model[]>

  • Parameters

    • iterator: string
    • Optional context: any

    Returns Dictionary<Model[]>

head

  • Returns Model

  • Parameters

    • n: number

    Returns Model[]

include

  • include(value: Model): boolean

  • Parameters

    Returns boolean

includes

  • includes(value: Model): boolean

  • Parameters

    Returns boolean

indexBy

  • indexBy(iterator: ListIterator<Model, any>, context?: any): Dictionary<Model>
  • indexBy(iterator: string, context?: any): Dictionary<Model>

  • Parameters

    • iterator: ListIterator<Model, any>
    • Optional context: any

    Returns Dictionary<Model>

  • Parameters

    • iterator: string
    • Optional context: any

    Returns Dictionary<Model>

indexOf

  • indexOf(value: Model, isSorted?: boolean): number

  • Parameters

    • value: Model
    • Optional isSorted: boolean

    Returns number

Protected init

  • init(models?: any, options?: any): void

  • Parameters

    • Optional models: any
    • Optional options: any

    Returns void

initial

  • Returns Model

  • Parameters

    • n: number

    Returns Model[]

initialize

  • initialize(models?: Model[] | Object[], options?: any): void

  • Parameters

    • Optional models: Model[] | Object[]
    • Optional options: any

    Returns void

inject

  • inject<TResult>(iterator: MemoIterator<Model, TResult>, memo?: TResult, context?: any): TResult

  • Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<Model, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

invoke

  • invoke(methodName: string, ...args: any[]): any

  • Parameters

    • methodName: string
    • Rest ...args: any[]

    Returns any

isEmpty

  • isEmpty(): boolean

  • Returns boolean

last

  • Returns Model

  • Parameters

    • n: number

    Returns Model[]

lastIndexOf

  • lastIndexOf(value: Model, from?: number): number

  • Parameters

    • value: Model
    • Optional from: number

    Returns number

listenTo

  • listenTo(object: any, events: string, callback: Function): any

  • Parameters

    • object: any
    • events: string
    • callback: Function

    Returns any

listenToOnce

  • listenToOnce(object: any, events: string, callback: Function): any

  • Parameters

    • object: any
    • events: string
    • callback: Function

    Returns any

map

  • map<TResult>(iterator: ListIterator<Model, TResult>, context?: any): TResult[]

  • Type parameters

    • TResult

    Parameters

    • iterator: ListIterator<Model, TResult>
    • Optional context: any

    Returns TResult[]

max

  • max(iterator?: ListIterator<Model, any>, context?: any): Model

  • Parameters

    • Optional iterator: ListIterator<Model, any>
    • Optional context: any

    Returns Model

min

  • min(iterator?: ListIterator<Model, any>, context?: any): Model

  • Parameters

    • Optional iterator: ListIterator<Model, any>
    • Optional context: any

    Returns Model

off

  • off(eventName?: string, callback?: Function, context?: any): any

  • Parameters

    • Optional eventName: string
    • Optional callback: Function
    • Optional context: any

    Returns any

on

  • on(eventName: string, callback?: Function, context?: any): any
  • on(eventMap: EventsHash): any

  • Parameters

    • eventName: string
    • Optional callback: Function
    • Optional context: any

    Returns any

  • Parameters

    • eventMap: EventsHash

    Returns any

once

  • once(events: string, callback: Function, context?: any): any

  • Parameters

    • events: string
    • callback: Function
    • Optional context: any

    Returns any

parse

  • parse(response: any, options?: any): any

  • Parameters

    • response: any
    • Optional options: any

    Returns any

partition

  • partition(iterator: ListIterator<Model, boolean>): Model[]

  • Parameters

    • iterator: ListIterator<Model, boolean>

    Returns Model[]

pluck

  • pluck(attribute: string): any[]

  • Parameters

    • attribute: string

    Returns any[]

pop

  • pop(options?: Silenceable): Model

  • Parameters

    • Optional options: Silenceable

    Returns Model

push

  • Parameters

    • model: Model
    • Optional options: AddOptions

    Returns Model

reduce

  • reduce<TResult>(iterator: MemoIterator<Model, TResult>, memo?: TResult, context?: any): TResult

  • Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<Model, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

reduceRight

  • reduceRight<TResult>(iterator: MemoIterator<Model, TResult>, memo?: TResult, context?: any): TResult

  • Type parameters

    • TResult

    Parameters

    • iterator: MemoIterator<Model, TResult>
    • Optional memo: TResult
    • Optional context: any

    Returns TResult

reject

  • reject(iterator: ListIterator<Model, boolean>, context?: any): Model[]

  • Parameters

    • iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns Model[]

remove

  • remove(model: object | Model, options?: Silenceable): Model
  • remove(models: object | TModel, options?: Silenceable): Model[]

  • Parameters

    • model: object | Model
    • Optional options: Silenceable

    Returns Model

  • Parameters

    • models: object | TModel
    • Optional options: Silenceable

    Returns Model[]

reset

  • reset(models?: Model[], options?: Silenceable): Model[]

  • Parameters

    • Optional models: Model[]
    • Optional options: Silenceable

    Returns Model[]

rest

  • rest(n?: number): Model[]

  • Parameters

    • Optional n: number

    Returns Model[]

sample

  • Returns Model

  • Parameters

    • n: number

    Returns Model[]

save

  • save(): void

  • save all containing models

    Returns void

select

  • select(iterator: ListIterator<Model, boolean>, context?: any): Model[]

  • Parameters

    • iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns Model[]

set

  • set(models?: Model[], options?: Silenceable): Model[]

  • Parameters

    • Optional models: Model[]
    • Optional options: Silenceable

    Returns Model[]

shift

  • shift(options?: Silenceable): Model

  • Parameters

    • Optional options: Silenceable

    Returns Model

shuffle

  • Returns Model[]

size

  • size(): number

  • Returns number

slice

  • slice(min: number, max?: number): Model[]

  • Return a shallow copy of this collection's models, using the same options as native Array#slice.

    Parameters

    • min: number
    • Optional max: number

    Returns Model[]

some

  • some(iterator?: ListIterator<Model, boolean>, context?: any): boolean

  • Parameters

    • Optional iterator: ListIterator<Model, boolean>
    • Optional context: any

    Returns boolean

sort

  • sort(options?: Silenceable): Collection<Model>

  • Parameters

    • Optional options: Silenceable

    Returns Collection<Model>

sortBy

  • sortBy<TSort>(iterator?: ListIterator<Model, TSort>, context?: any): Model[]
  • sortBy(iterator: string, context?: any): Model[]

  • Type parameters

    • TSort

    Parameters

    • Optional iterator: ListIterator<Model, TSort>
    • Optional context: any

    Returns Model[]

  • Parameters

    • iterator: string
    • Optional context: any

    Returns Model[]

stopListening

  • stopListening(object?: any, events?: string, callback?: Function): any

  • Parameters

    • Optional object: any
    • Optional events: string
    • Optional callback: Function

    Returns any

sync

  • sync(method: string, model: ModelBase, options?: any): any

  • Parameters

    • method: string
    • model: ModelBase
    • Optional options: any

    Returns any

tail

  • tail(n?: number): Model[]

  • Parameters

    • Optional n: number

    Returns Model[]

take

  • Returns Model

  • Parameters

    • n: number

    Returns Model[]

toArray

  • Returns Model[]

toJSON

  • toJSON(options?: any): any

  • Parameters

    • Optional options: any

    Returns any

trigger

  • trigger(eventName: string, ...args: any[]): any

  • Parameters

    • eventName: string
    • Rest ...args: any[]

    Returns any

unbind

  • unbind(eventName?: string, callback?: Function, context?: any): any

  • Parameters

    • Optional eventName: string
    • Optional callback: Function
    • Optional context: any

    Returns any

unshift

  • unshift(model: Model, options?: AddOptions): Model

  • Parameters

    • model: Model
    • Optional options: AddOptions

    Returns Model

where

  • where(properties: any): Model[]

  • Parameters

    • properties: any

    Returns Model[]

without

  • Parameters

    • Rest ...values: Model[]

    Returns Model[]

Generated using TypeDoc