docs(animations): document usage of negative limit values for query (#19451)

2017-09-28 09:34:36 -07:00 · 2017-09-28 09:34:36 -07:00 · 2d2300e118
parent f24ea59f74
commit 2d2300e118
1 changed files with 7 additions and 0 deletions
--- a/packages/animations/src/animation_metadata.ts
+++ b/packages/animations/src/animation_metadata.ts
@ -220,6 +220,13 @@ export interface AnimationGroupMetadata extends AnimationMetadata {
 */
 export declare interface AnimationQueryOptions extends AnimationOptions {
  optional?: boolean;
+  /**
+   * Used to limit the total amount of results from the start of the query list.
+   *
+   * If a negative value is provided then the queried results will be limited from the
+   * end of the query list towards the beginning (e.g. if `limit: -3` is used then the
+   * final 3 (or less) queried results will be used for the animation).
+   */
  limit?: number;
 }