QueryList — Angular | Spec-Zone.ru

Неизменяемый список элементов, который Angular поддерживает в актуальном состоянии при изменении состояния приложения.

API

class QueryList<T> implements Iterable<T> {
  constructor(_emitDistinctChangesOnly?: boolean): QueryList<T>;
  readonly dirty: true;
  readonly length: number;
  readonly first: T;
  readonly last: T;
  readonly changes: Observable<any>;
  get(index: number): T | undefined;
  map<U>(fn: (item: T, index: number, array: T[]) => U): U[];
  filter<S extends T>(predicate: (value: T, index: number, array: readonly T[]) => value is S): S[];
  filter(predicate: (value: T, index: number, array: readonly T[]) => unknown): T[];
  find(fn: (item: T, index: number, array: T[]) => boolean): T | undefined;
  reduce<U>(fn: (prevValue: U, curValue: T, curIndex: number, array: T[]) => U, init: U): U;
  forEach(fn: (item: T, index: number, array: T[]) => void): void;
  some(fn: (value: T, index: number, array: T[]) => boolean): boolean;
  toArray(): T[];
  toString(): string;
  reset(resultsTree: (any[] | T)[], identityAccessor?: ((value: T) => unknown) | undefined): void;
  notifyOnChanges(): void;
  setDirty(): void;
  destroy(): void;
  [Symbol.iterator]: () => Iterator<T, any, any>;
}

constructor

QueryList<T>

@param_emitDistinctChangesOnlyboolean

@returnsQueryList<T>

dirty

true

length

number

first

T

last

T

changes

Observable<any>

Возвращает Observable QueryList, уведомляющий подписчика об изменениях.

get

T | undefined

Возвращает элемент QueryList с индексом index.

@paramindexnumber

@returnsT | undefined

map

U[]

См. Array.map

@paramfn(item: T, index: number, array: T[]) => U

@returnsU[]

filter

2 перегрузки

См. Array.filter

@parampredicate(value: T, index: number, array: readonly T[]) => value is S

@returnsS[]

@parampredicate(value: T, index: number, array: readonly T[]) => unknown

@returnsT[]

find

T | undefined

См. Array.find

@paramfn(item: T, index: number, array: T[]) => boolean

@returnsT | undefined

reduce

U

См. Array.reduce

@paramfn(prevValue: U, curValue: T, curIndex: number, array: T[]) => U

@paraminitU

@returnsU

forEach

void

См. Array.forEach

@paramfn(item: T, index: number, array: T[]) => void

@returnsvoid

some

boolean

См. Array.some

@paramfn(value: T, index: number, array: T[]) => boolean

@returnsboolean

toArray

T[]

Возвращает копию внутреннего списка результатов в виде массива.

@returnsT[]

toString

string

@returnsstring

reset

void

Обновляет сохранённые данные списка запросов и сбрасывает флаг dirty в значение false, чтобы при обнаружении изменений не сообщать об изменениях в запросах, если не произошло новое изменение.

@paramresultsTree(any[] | T)[]

Результаты запроса для сохранения

@paramidentityAccessor((value: T) => unknown) | undefined

Необязательная функция для извлечения стабильной идентичности объекта из значения массива. Эта функция выполняется для каждого элемента списка результатов запроса при сравнении текущего списка запросов с новым (переданным первым аргументом функции reset), чтобы определить, отличаются ли списки. Если функция не указана, элементы сравниваются как есть (без предварительной обработки).

@returnsvoid

notifyOnChanges

void

Вызывает событие изменения, отправляя его через changes EventEmitter.

@returnsvoid

setDirty

void

внутренний

@returnsvoid

destroy

void

внутренний

@returnsvoid

[Symbol.iterator]

() => Iterator<T, any, any>

Описание

Тип объекта, который предоставляют ViewChildren, ContentChildren и QueryList.

Реализует интерфейс итератора, поэтому его можно использовать как в циклах ES6 JavaScript for (var i of items), так и в шаблонах Angular с помощью @for(i of myList; track $index).

За изменениями можно следить, подписавшись на changes Observable. *

Примечания по использованию

Пример

@Component({...})
class Container {
  @ViewChildren(Item) items:QueryList<Item>;
}