From ca0a55f4ee2276d27991c746cd0c77914b030a9b Mon Sep 17 00:00:00 2001 From: Georgios Kalpakas Date: Wed, 2 Aug 2017 17:02:58 +0300 Subject: [PATCH] docs(upgrade): add API docs for `propagateDigest` (#18487) (#18487) PR Close #18487 PR Close #18487 --- packages/upgrade/src/common/downgrade_component.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/upgrade/src/common/downgrade_component.ts b/packages/upgrade/src/common/downgrade_component.ts index 8dd26698b5..9a642fca1d 100644 --- a/packages/upgrade/src/common/downgrade_component.ts +++ b/packages/upgrade/src/common/downgrade_component.ts @@ -46,6 +46,11 @@ interface Thenable { * @param info contains information about the Component that is being downgraded: * * * `component: Type`: The type of the Component that will be downgraded + * * `propagateDigest?: boolean`: Whether to perform {@link ChangeDetectorRef#detectChanges + * change detection} on the component on every + * [$digest](https://docs.angularjs.org/api/ng/type/$rootScope.Scope#$digest). If set to `false`, + * change detection will still be performed when any of the component's inputs changes. + * (Default: true) * * @returns a factory function that can be used to register the component in an * AngularJS module.