revert: refactor(ivy): Update query-related comments (#29342)

This commit is contained in:
Matias Niemelä 2019-03-18 13:39:10 -07:00
parent fe759ee0cf
commit b759d63389
4 changed files with 6 additions and 22 deletions

View File

@ -93,33 +93,20 @@ export class QueryList<T>/* implements Iterable<T> */ {
return this._results.some(fn); return this._results.some(fn);
} }
/**
* Returns a copy of the internal results list as an Array.
*/
toArray(): T[] { return this._results.slice(); } toArray(): T[] { return this._results.slice(); }
[getSymbolIterator()](): Iterator<T> { return (this._results as any)[getSymbolIterator()](); } [getSymbolIterator()](): Iterator<T> { return (this._results as any)[getSymbolIterator()](); }
toString(): string { return this._results.toString(); } toString(): string { return this._results.toString(); }
/** reset(res: Array<T|any[]>): void {
* Updates the stored data of the query list, and resets the `dirty` flag to `false`, so that this._results = flatten(res);
* on change detection, it will not notify of changes to the queries, unless a new change
* occurs.
*
* @param resultsTree The results tree to store
*/
reset(resultsTree: Array<T|any[]>): void {
this._results = depthFirstFlatten(resultsTree);
(this as{dirty: boolean}).dirty = false; (this as{dirty: boolean}).dirty = false;
(this as{length: number}).length = this._results.length; (this as{length: number}).length = this._results.length;
(this as{last: T}).last = this._results[this.length - 1]; (this as{last: T}).last = this._results[this.length - 1];
(this as{first: T}).first = this._results[0]; (this as{first: T}).first = this._results[0];
} }
/**
* Triggers a change event by emitting on the `changes` {@link EventEmitter}.
*/
notifyOnChanges(): void { (this.changes as EventEmitter<any>).emit(this); } notifyOnChanges(): void { (this.changes as EventEmitter<any>).emit(this); }
/** internal */ /** internal */
@ -132,9 +119,9 @@ export class QueryList<T>/* implements Iterable<T> */ {
} }
} }
function depthFirstFlatten<T>(list: Array<T|T[]>): T[] { function flatten<T>(list: Array<T|T[]>): T[] {
return list.reduce((flat: any[], item: T | T[]): T[] => { return list.reduce((flat: any[], item: T | T[]): T[] => {
const flatItem = Array.isArray(item) ? depthFirstFlatten(item) : item; const flatItem = Array.isArray(item) ? flatten(item) : item;
return (<T[]>flat).concat(flatItem); return (<T[]>flat).concat(flatItem);
}, []); }, []);
} }

View File

@ -365,9 +365,7 @@ export function query<T>(
/** /**
* Refreshes a query by combining matches from all active views and removing matches from deleted * Refreshes a query by combining matches from all active views and removing matches from deleted
* views. * views.
* * Returns true if a query got dirty during change detection, false otherwise.
* @returns `true` if a query got dirty during change detection or if this is a static query
* resolving in creation mode, `false` otherwise.
*/ */
export function queryRefresh(queryList: QueryList<any>): boolean { export function queryRefresh(queryList: QueryList<any>): boolean {
const queryListImpl = (queryList as any as QueryList_<any>); const queryListImpl = (queryList as any as QueryList_<any>);

View File

@ -1603,7 +1603,6 @@ describe('query', () => {
}); });
// https://stackblitz.com/edit/angular-7vvo9j?file=src%2Fapp%2Fapp.component.ts // https://stackblitz.com/edit/angular-7vvo9j?file=src%2Fapp%2Fapp.component.ts
// https://stackblitz.com/edit/angular-xzwp6n
it('should report results when the same TemplateRef is inserted into different ViewContainerRefs', it('should report results when the same TemplateRef is inserted into different ViewContainerRefs',
() => { () => {
let tpl: TemplateRef<{}>; let tpl: TemplateRef<{}>;

View File

@ -721,7 +721,7 @@ export declare class QueryList<T> {
map<U>(fn: (item: T, index: number, array: T[]) => U): U[]; map<U>(fn: (item: T, index: number, array: T[]) => U): U[];
notifyOnChanges(): void; notifyOnChanges(): void;
reduce<U>(fn: (prevValue: U, curValue: T, curIndex: number, array: T[]) => U, init: U): U; reduce<U>(fn: (prevValue: U, curValue: T, curIndex: number, array: T[]) => U, init: U): U;
reset(resultsTree: Array<T | any[]>): void; reset(res: Array<T | any[]>): void;
setDirty(): void; setDirty(): void;
some(fn: (value: T, index: number, array: T[]) => boolean): boolean; some(fn: (value: T, index: number, array: T[]) => boolean): boolean;
toArray(): T[]; toArray(): T[];