Class Collection<TModel>

Type Parameters

TModel extends Model = Model

Hierarchy (View Summary)

ModelBase
- Collection
  - IssueCollection

Implements

Events

Constructors

constructor

new Collection<
    TModel extends Model<any, ModelSetOptions> = Model<any, ModelSetOptions>,
>(
    models?: TModel[] | Object[],
    options?: any,
): Collection<TModel>
Type Parameters
- TModel extends Model<any, ModelSetOptions> = Model<any, ModelSetOptions>
Parameters
- Optionalmodels: TModel[] | Object[]
- Optionaloptions: any
Returns Collection<TModel>
Overrides ModelBase.constructor

Properties

comparator

comparator:
    | string
    | (element: TModel) => string | number
    | (compare: TModel, to?: TModel) => number

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

length

length: number

model

model: new (...args: any[]) => TModel

models

models: TModel[]

url

url: string | () => string

Sets the url property (or function) on a collection to reference its location on the server.

Memberof

Collection

Methods

[iterator]

"[iterator]"(): Iterator<TModel>
Returns Iterator<TModel>

add

add(model: {} | TModel, options?: AddOptions): TModel
Parameters
- model: {} | TModel
- Optionaloptions: AddOptions
Returns TModel
add(models: ({} | TModel)[], options?: AddOptions): TModel[]
Parameters
- models: ({} | TModel)[]
- Optionaloptions: AddOptions
Returns TModel[]

all

all(
iterator?: ListIterator<TModel, boolean, List<TModel>>,
context?: any,
): boolean
Parameters
- Optionaliterator: ListIterator<TModel, boolean, List<TModel>>
- Optionalcontext: any
Returns boolean

any

any(
iterator?: ListIterator<TModel, boolean, List<TModel>>,
context?: any,
): boolean
Parameters
- Optionaliterator: ListIterator<TModel, boolean, List<TModel>>
- Optionalcontext: any
Returns boolean

at

at(index: number): TModel
Parameters
- index: number
Returns TModel

bind

bind(eventName: string, callback: EventHandler, context?: any): this
Parameters
- eventName: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Implementation of Events.bind
Inherited from ModelBase.bind
bind(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Implementation of Events.bind
Inherited from ModelBase.bind

chain

chain(): any
Returns any

clone

clone(): this
Returns this

collect

collect<TResult>(
iterator: ListIterator<TModel, TResult>,
context?: any,
): TResult[]
Type Parameters
- TResult
Parameters
- iterator: ListIterator<TModel, TResult>
- Optionalcontext: any
Returns TResult[]

contains

contains(value: TModel): boolean
Parameters
- value: TModel
Returns boolean

countBy

countBy(iterator?: ListIterator<TModel, any, List<TModel>>): Dictionary<number>
Parameters
- Optionaliterator: ListIterator<TModel, any, List<TModel>>
Returns Dictionary<number>
countBy(iterator: string): Dictionary<number>
Parameters
- iterator: string
Returns Dictionary<number>

create

create(attributes: any, options?: ModelSaveOptions): TModel
Parameters
- attributes: any
- Optionaloptions: ModelSaveOptions
Returns TModel

detect

detect(iterator: ListIterator<TModel, boolean>, context?: any): TModel
Parameters
- iterator: ListIterator<TModel, boolean>
- Optionalcontext: any
Returns TModel

difference

difference(others: TModel[]): TModel[]
Parameters
- others: TModel[]
Returns TModel[]

drop

drop(n?: number): TModel[]
Parameters
- Optionaln: number
Returns TModel[]

each

each(iterator: ListIterator<TModel, void>, context?: any): TModel[]
Parameters
- iterator: ListIterator<TModel, void>
- Optionalcontext: any
Returns TModel[]

entries

entries(): Iterator<[any, TModel]>
Returns Iterator<[any, TModel]>

every

every(iterator: ListIterator<TModel, boolean>, context?: any): boolean
Parameters
- iterator: ListIterator<TModel, boolean>
- Optionalcontext: any
Returns boolean

fetch

fetch(options?: CollectionFetchOptions): JQueryXHR
Parameters
- Optionaloptions: CollectionFetchOptions
Returns JQueryXHR

filter

filter(iterator: ListIterator<TModel, boolean>, context?: any): TModel[]
Parameters
- iterator: ListIterator<TModel, boolean>
- Optionalcontext: any
Returns TModel[]

find

find(iterator: ListIterator<TModel, boolean>, context?: any): TModel
Parameters
- iterator: ListIterator<TModel, boolean>
- Optionalcontext: any
Returns TModel

findIndex

findIndex(predicate: ListIterator<TModel, boolean>, context?: any): number
Parameters
- predicate: ListIterator<TModel, boolean>
- Optionalcontext: any
Returns number

findLastIndex

findLastIndex(predicate: ListIterator<TModel, boolean>, context?: any): number
Parameters
- predicate: ListIterator<TModel, boolean>
- Optionalcontext: any
Returns number

findWhere

findWhere(properties: any): TModel
Parameters
- properties: any
Returns TModel

first

first(): TModel
Returns TModel
first(n: number): TModel[]
Parameters
- n: number
Returns TModel[]

foldl

foldl<TResult>(
    iterator: MemoIterator<TModel, TResult>,
    memo?: TResult,
    context?: any,
): TResult
Type Parameters
- TResult
Parameters
- iterator: MemoIterator<TModel, TResult>
- Optionalmemo: TResult
- Optionalcontext: any
Returns TResult

foldr

foldr<TResult>(
    iterator: MemoIterator<TModel, TResult>,
    memo?: TResult,
    context?: any,
): TResult
Type Parameters
- TResult
Parameters
- iterator: MemoIterator<TModel, TResult>
- Optionalmemo: TResult
- Optionalcontext: any
Returns TResult

forEach

forEach(iterator: ListIterator<TModel, void>, context?: any): TModel[]
Parameters
- iterator: ListIterator<TModel, void>
- Optionalcontext: any
Returns TModel[]

get

get(id: string | number | Model<any, ModelSetOptions>): TModel
Get a model from a collection, specified by an id, a cid, or by passing in a model.
Parameters
- id: string | number | Model<any, ModelSetOptions>
Returns TModel

groupBy

groupBy(
iterator: ListIterator<TModel, any>,
context?: any,
): Dictionary<TModel[]>
Parameters
- iterator: ListIterator<TModel, any>
- Optionalcontext: any
Returns Dictionary<TModel[]>
groupBy(iterator: string, context?: any): Dictionary<TModel[]>
Parameters
- iterator: string
- Optionalcontext: any
Returns Dictionary<TModel[]>

has

has(key: string | number | Model<any, ModelSetOptions>): boolean
Parameters
- key: string | number | Model<any, ModelSetOptions>
Returns boolean

head

head(): TModel
Returns TModel
head(n: number): TModel[]
Parameters
- n: number
Returns TModel[]

include

include(value: TModel): boolean
Parameters
- value: TModel
Returns boolean

includes

includes(value: TModel): boolean
Parameters
- value: TModel
Returns boolean

indexBy

indexBy(iterator: ListIterator<TModel, any>, context?: any): Dictionary<TModel>
Parameters
- iterator: ListIterator<TModel, any>
- Optionalcontext: any
Returns Dictionary<TModel>
indexBy(iterator: string, context?: any): Dictionary<TModel>
Parameters
- iterator: string
- Optionalcontext: any
Returns Dictionary<TModel>

indexOf

indexOf(value: TModel, isSorted?: boolean): number
Parameters
- value: TModel
- OptionalisSorted: boolean
Returns number

initial

initial(): TModel
Returns TModel
initial(n: number): TModel[]
Parameters
- n: number
Returns TModel[]

initialize

initialize(models?: TModel[] | Object[], options?: any): void
Parameters
- Optionalmodels: TModel[] | Object[]
- Optionaloptions: any
Returns void

inject

inject<TResult>(
    iterator: MemoIterator<TModel, TResult>,
    memo?: TResult,
    context?: any,
): TResult
Type Parameters
- TResult
Parameters
- iterator: MemoIterator<TModel, TResult>
- Optionalmemo: TResult
- Optionalcontext: any
Returns TResult

invoke

invoke(methodName: string, ...args: any[]): any
Parameters
- methodName: string
- ...args: any[]
Returns any

isEmpty

isEmpty(): boolean
Returns boolean

keys

keys(): Iterator<any>
Returns Iterator<any>

last

last(): TModel
Returns TModel
last(n: number): TModel[]
Parameters
- n: number
Returns TModel[]

lastIndexOf

lastIndexOf(value: TModel, from?: number): number
Parameters
- value: TModel
- Optionalfrom: number
Returns number

listenTo

listenTo(object: any, events: string, callback: EventHandler): this
Parameters
- object: any
- events: string
- callback: EventHandler
Returns this
Implementation of Events.listenTo
Inherited from ModelBase.listenTo
listenTo(object: any, eventMap: EventMap): this
Parameters
- object: any
- eventMap: EventMap
Returns this
Implementation of Events.listenTo
Inherited from ModelBase.listenTo

listenToOnce

listenToOnce(object: any, events: string, callback: EventHandler): this
Parameters
- object: any
- events: string
- callback: EventHandler
Returns this
Implementation of Events.listenToOnce
Inherited from ModelBase.listenToOnce
listenToOnce(object: any, eventMap: EventMap): this
Parameters
- object: any
- eventMap: EventMap
Returns this
Implementation of Events.listenToOnce
Inherited from ModelBase.listenToOnce

map

map<TResult>(iterator: ListIterator<TModel, TResult>, context?: any): TResult[]
Type Parameters
- TResult
Parameters
- iterator: ListIterator<TModel, TResult>
- Optionalcontext: any
Returns TResult[]

max

max(iterator?: ListIterator<TModel, any, List<TModel>>, context?: any): TModel
Parameters
- Optionaliterator: ListIterator<TModel, any, List<TModel>>
- Optionalcontext: any
Returns TModel

min

min(iterator?: ListIterator<TModel, any, List<TModel>>, context?: any): TModel
Parameters
- Optionaliterator: ListIterator<TModel, any, List<TModel>>
- Optionalcontext: any
Returns TModel

modelId

modelId(attrs: any): any
Parameters
- attrs: any
Returns any

off

off(eventName?: string, callback?: EventHandler, context?: any): this
Parameters
- OptionaleventName: string
- Optionalcallback: EventHandler
- Optionalcontext: any
Returns this
Implementation of Events.off
Inherited from ModelBase.off

on

on(eventName: string, callback: EventHandler, context?: any): this
Parameters
- eventName: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Implementation of Events.on
Inherited from ModelBase.on
on(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Implementation of Events.on
Inherited from ModelBase.on

once

once(events: string, callback: EventHandler, context?: any): this
Parameters
- events: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Implementation of Events.once
Inherited from ModelBase.once
once(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Implementation of Events.once
Inherited from ModelBase.once

parse

parse(response: any, options?: any): any
Parameters
- response: any
- Optionaloptions: any
Returns any
Inherited from ModelBase.parse

partition

partition(iterator: ListIterator<TModel, boolean>): TModel[][]
Parameters
- iterator: ListIterator<TModel, boolean>
Returns TModel[][]

pluck

pluck(attribute: string): any[]
Parameters
- attribute: string
Returns any[]

pop

pop(options?: Silenceable): TModel
Parameters
- Optionaloptions: Silenceable
Returns TModel

preinitialize

preinitialize(models?: TModel[] | Object[], options?: any): void
For use with collections as ES classes. If you define a preinitialize method, it will be invoked when the Collection is first created and before any instantiation logic is run for the Collection.
Parameters
- Optionalmodels: TModel[] | Object[]
- Optionaloptions: any
Returns void
See
https://backbonejs.org/#Collection-preinitialize

push

push(model: TModel, options?: AddOptions): TModel
Parameters
- model: TModel
- Optionaloptions: AddOptions
Returns TModel

reduce

reduce<TResult>(
    iterator: MemoIterator<TModel, TResult>,
    memo?: TResult,
    context?: any,
): TResult
Type Parameters
- TResult
Parameters
- iterator: MemoIterator<TModel, TResult>
- Optionalmemo: TResult
- Optionalcontext: any
Returns TResult

reduceRight

reduceRight<TResult>(
    iterator: MemoIterator<TModel, TResult>,
    memo?: TResult,
    context?: any,
): TResult
Type Parameters
- TResult
Parameters
- iterator: MemoIterator<TModel, TResult>
- Optionalmemo: TResult
- Optionalcontext: any
Returns TResult

reject

reject(iterator: ListIterator<TModel, boolean>, context?: any): TModel[]
Parameters
- iterator: ListIterator<TModel, boolean>
- Optionalcontext: any
Returns TModel[]

remove

remove(model: {} | TModel, options?: Silenceable): TModel
Parameters
- model: {} | TModel
- Optionaloptions: Silenceable
Returns TModel
remove(models: ({} | TModel)[], options?: Silenceable): TModel[]
Parameters
- models: ({} | TModel)[]
- Optionaloptions: Silenceable
Returns TModel[]

reset

reset(models?: TModel[], options?: Silenceable): TModel[]
Parameters
- Optionalmodels: TModel[]
- Optionaloptions: Silenceable
Returns TModel[]

rest

rest(n?: number): TModel[]
Parameters
- Optionaln: number
Returns TModel[]

sample

sample(): TModel
Returns TModel
sample(n: number): TModel[]
Parameters
- n: number
Returns TModel[]

select

select(iterator: ListIterator<TModel, boolean>, context?: any): TModel[]
Parameters
- iterator: ListIterator<TModel, boolean>
- Optionalcontext: any
Returns TModel[]

set

set(models?: TModel[], options?: CollectionSetOptions): TModel[]
The set method performs a "smart" update of the collection with the passed list of models. If a model in the list isn't yet in the collection it will be added; if the model is already in the collection its attributes will be merged; and if the collection contains any models that aren't present in the list, they'll be removed. All of the appropriate "add", "remove", and "change" events are fired as this happens. Returns the touched models in the collection. If you'd like to customize the behavior, you can disable it with options: {add: false}, {remove: false}, or {merge: false}.
Parameters
- Optionalmodels: TModel[]
- Optionaloptions: CollectionSetOptions
Returns TModel[]

shift

shift(options?: Silenceable): TModel
Parameters
- Optionaloptions: Silenceable
Returns TModel

shuffle

shuffle(): TModel[]
Returns TModel[]

size

size(): number
Returns number

slice

slice(min?: number, max?: number): TModel[]
Return a shallow copy of this collection's models, using the same options as native Array#slice.
Parameters
- Optionalmin: number
- Optionalmax: number
Returns TModel[]

some

some(
iterator?: ListIterator<TModel, boolean, List<TModel>>,
context?: any,
): boolean
Parameters
- Optionaliterator: ListIterator<TModel, boolean, List<TModel>>
- Optionalcontext: any
Returns boolean

sort

sort(options?: Silenceable): Collection<TModel>
Parameters
- Optionaloptions: Silenceable
Returns Collection<TModel>

sortBy

sortBy<TSort>(
iterator?: ListIterator<TModel, TSort, List<TModel>>,
context?: any,
): TModel[]
Type Parameters
- TSort
Parameters
- Optionaliterator: ListIterator<TModel, TSort, List<TModel>>
- Optionalcontext: any
Returns TModel[]
sortBy(iterator: string, context?: any): TModel[]
Parameters
- iterator: string
- Optionalcontext: any
Returns TModel[]

stopListening

stopListening(object?: any, events?: string, callback?: EventHandler): this
Parameters
- Optionalobject: any
- Optionalevents: string
- Optionalcallback: EventHandler
Returns this
Implementation of Events.stopListening
Inherited from ModelBase.stopListening

sync

sync(...arg: any[]): JQueryXHR
Parameters
- ...arg: any[]
Returns JQueryXHR
Inherited from ModelBase.sync

tail

tail(n?: number): TModel[]
Parameters
- Optionaln: number
Returns TModel[]

take

take(): TModel
Returns TModel
take(n: number): TModel[]
Parameters
- n: number
Returns TModel[]

toArray

toArray(): TModel[]
Returns TModel[]

toJSON

toJSON(options?: any): any
Parameters
- Optionaloptions: any
Returns any
Inherited from ModelBase.toJSON

trigger

trigger(eventName: string, ...args: any[]): this
Parameters
- eventName: string
- ...args: any[]
Returns this
Implementation of Events.trigger
Inherited from ModelBase.trigger

unbind

unbind(eventName?: string, callback?: EventHandler, context?: any): this
Parameters
- OptionaleventName: string
- Optionalcallback: EventHandler
- Optionalcontext: any
Returns this
Implementation of Events.unbind
Inherited from ModelBase.unbind

unshift

unshift(model: TModel, options?: AddOptions): TModel
Parameters
- model: TModel
- Optionaloptions: AddOptions
Returns TModel

values

values(): Iterator<TModel>
Returns Iterator<TModel>

where

where(properties: any): TModel[]
Parameters
- properties: any
Returns TModel[]

without

without(...values: TModel[]): TModel[]
Parameters
- ...values: TModel[]
Returns TModel[]

`Static`extend

extend(properties: any, classProperties?: any): any
Do not use, prefer TypeScript's extend functionality.
Parameters
- properties: any
- OptionalclassProperties: any
Returns any

Class Collection<TModel>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Collection<TModel>

Properties

comparator

length

model

models

url

Memberof

Methods

[iterator]

Returns Iterator<TModel>

add

Parameters

Returns TModel

Parameters

Returns TModel[]

all

Parameters

Returns boolean

any

Parameters

Returns boolean

at

Parameters

Returns TModel

bind

Parameters

Returns this

Parameters

Returns this

chain

Returns any

clone

Returns this

collect

Type Parameters

Parameters

Returns TResult[]

contains

Parameters

Returns boolean

countBy

Parameters

Returns Dictionary<number>

Parameters

Returns Dictionary<number>

create

Parameters

Returns TModel

detect

Parameters

Returns TModel

difference

Parameters

Returns TModel[]

drop

Parameters

Returns TModel[]

each

Parameters

Returns TModel[]

entries

Returns Iterator<[any, TModel]>

every

Parameters

Returns boolean

fetch

Parameters