From 2d2300e118ab9f58806ac3c96111afd736874f6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matias=20Niemel=C3=A4?= Date: Thu, 28 Sep 2017 09:34:36 -0700 Subject: [PATCH] docs(animations): document usage of negative limit values for query (#19451) --- packages/animations/src/animation_metadata.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/packages/animations/src/animation_metadata.ts b/packages/animations/src/animation_metadata.ts index b353198fcc..aaac524a82 100755 --- 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; }