Class Collection<T>

Reflection

never

Type Parameters

T extends IdInterface

Hierarchy

ReplaySubject<T[]>
- Collection

Index

Constructors

constructor

new Collection<T>(classType: ClassType<T>): Collection<T>
Type Parameters
- T extends IdInterface
Parameters
- classType: ClassType<T>
Returns Collection<T>
Overrides ReplaySubject<T[]>.constructor
- Defined in packages/rpc/src/collection.ts:200

Properties

`Readonly` added

added: Subject<T> = ...

`Readonly` classType

classType: ClassType<T>

`Readonly` deepChange

deepChange: Subject<T> = ...

`Protected` `Optional` entitySubjectFetcher

entitySubjectFetcher?: CollectionEntitySubjectFetcher

`Readonly` entitySubjects

entitySubjects: Map<string | number, EntitySubject<T>> = ...

`Readonly` event

event: Subject<CollectionEvent<T>> = ...

`Protected` items

items: T[] = []

`Protected` itemsMap

itemsMap: Map<string | number, T> = ...

model

model: CollectionQueryModel<T> = ...

`Protected` `Optional` nextChange

nextChange?: Promise<void>

`Protected` `Optional` nextChangeResolver

nextChangeResolver?: (() => void)

Type declaration

- (): void
- Returns void

`Readonly` removed

removed: Subject<T> = ...

state

state: CollectionState = ...

`Protected` `Readonly` teardowns

teardowns: TeardownLogic[] = []

Accessors

nextStateChange

get nextStateChange(): Promise<void>
Resolves when next change happened.

Returns Promise<void>
- Defined in packages/rpc/src/collection.ts:282

Methods

add

add(items: T | T[], withEvent?: boolean): void
Parameters
- items: T | T[]
- withEvent: boolean = true
Returns void
- Defined in packages/rpc/src/collection.ts:444

addTeardown

addTeardown(teardown: TeardownLogic): void
Parameters
- teardown: TeardownLogic
Returns void
- Defined in packages/rpc/src/collection.ts:303

all

all(): T[]
Returns T[]
- Defined in packages/rpc/src/collection.ts:328

apply

apply(): Promise<void>
Returns Promise<void>
- Defined in packages/rpc/src/collection.ts:245

count

count(): number
Count of current page if paging is used, otherwise total count.

Returns number
- Defined in packages/rpc/src/collection.ts:335

empty

empty(): boolean
Returns boolean
- Defined in packages/rpc/src/collection.ts:348

get

get(id: string | number): undefined | T
Parameters
- id: string | number
Returns undefined | T
- Defined in packages/rpc/src/collection.ts:259

getEntitySubject

getEntitySubject(idOrItem: string | number | T): undefined | EntitySubject<T>
Parameters
- idOrItem: string | number | T
Returns undefined | EntitySubject<T>
- Defined in packages/rpc/src/collection.ts:250

getItemsPerPage

getItemsPerPage(): number
Returns number
- Defined in packages/rpc/src/collection.ts:210

getPage

getPage(): number
Returns number
- Defined in packages/rpc/src/collection.ts:241

getPageOf

getPageOf(item: T, itemsPerPage?: number): number
Returns the page zero-based of the current item.
Parameters
- item: T
- itemsPerPage: number = 10
Returns number
- Defined in packages/rpc/src/collection.ts:314

getPages

getPages(): number
Returns number
- Defined in packages/rpc/src/collection.ts:214

getParameter

getParameter(name: string): any
Parameters
- name: string
Returns any
- Defined in packages/rpc/src/collection.ts:222

getSort

getSort(): undefined | Sort<T, any>
Returns undefined | Sort<T, any>
- Defined in packages/rpc/src/collection.ts:218

getTotal

getTotal(): number
Returns number
- Defined in packages/rpc/src/collection.ts:206

has

has(id: string | number): boolean
Parameters
- id: string | number
Returns boolean
- Defined in packages/rpc/src/collection.ts:255

ids

ids(): (string | number)[]
Returns (string | number)[]
- Defined in packages/rpc/src/collection.ts:339

index

index(item: T): number
Parameters
- item: T
Returns number
- Defined in packages/rpc/src/collection.ts:307

loaded

loaded(): void
Returns void
- Defined in packages/rpc/src/collection.ts:359

map

map(): Map<string | number, T>
All items from id -> value map.

Returns Map<string | number, T>
- Defined in packages/rpc/src/collection.ts:355

orderByField

orderByField(name: keyof T & string, order?: any): Collection<T>
Parameters
- name: keyof T & string
- order: any = 'asc'
Returns Collection<T>
- Defined in packages/rpc/src/collection.ts:231

remove

remove(ids: string | number | (string | number)[], withEvent?: boolean): void
Parameters
- ids: string | number | (string | number)[]
- withEvent: boolean = true
Returns void
- Defined in packages/rpc/src/collection.ts:469

removeMany

removeMany(ids: (string | number)[], withEvent?: boolean): void
Parameters
- ids: (string | number)[]
- withEvent: boolean = true
Returns void
- Defined in packages/rpc/src/collection.ts:402

reset

reset(): void
Returns void
- Defined in packages/rpc/src/collection.ts:322

set

set(items: T[], withEvent?: boolean): void
Parameters
- items: T[]
- withEvent: boolean = true
Returns void
- Defined in packages/rpc/src/collection.ts:372

setPage

setPage(page: number): Collection<T>
Parameters
- page: number
Returns Collection<T>
- Defined in packages/rpc/src/collection.ts:236

setParameter

setParameter(name: string, value: any): Collection<T>
Parameters
- name: string
- value: any
Returns Collection<T>
- Defined in packages/rpc/src/collection.ts:226

setSort

setSort(ids: (string | number)[]): void
Parameters
- ids: (string | number)[]
Returns void
- Defined in packages/rpc/src/collection.ts:268

setState

setState(state: CollectionState): void
Parameters
- state: CollectionState
Returns void
- Defined in packages/rpc/src/collection.ts:263

unsubscribe

unsubscribe(): void
Returns void
Overrides ReplaySubject.unsubscribe
- Defined in packages/rpc/src/collection.ts:291

update

update(items: T | T[], withEvent?: boolean): void
Parameters
- items: T | T[]
- withEvent: boolean = true
Returns void
- Defined in packages/rpc/src/collection.ts:425

Generated using TypeDoc