From a4398aa17fd11c1c78ad5e514756e901dd2eff96 Mon Sep 17 00:00:00 2001 From: Kara Erickson Date: Tue, 6 Nov 2018 14:11:14 -0800 Subject: [PATCH] docs(forms): update description for FormBuilder.group (#26970) PR Close #26970 --- packages/forms/src/form_builder.ts | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/packages/forms/src/form_builder.ts b/packages/forms/src/form_builder.ts index 3e611c55d1..2a42a9a233 100644 --- a/packages/forms/src/form_builder.ts +++ b/packages/forms/src/form_builder.ts @@ -32,7 +32,16 @@ export class FormBuilder { * @param controlsConfig A collection of child controls. The key for each child is the name * under which it is registered. * - * @param extra An object of configuration options for the `FormGroup`. + * @param legacyOrOpts Configuration options object for the `FormGroup`. The object can + * have two shapes: + * + * 1) `AbstractControlOptions` object (preferred), which consists of: + * * `validators`: A synchronous validator function, or an array of validator functions + * * `asyncValidators`: A single async validator or array of async validator functions + * * `updateOn`: The event upon which the control should be updated (options: 'change' | 'blur' | + * submit') + * + * 2) Legacy configuration object, which consists of: * * `validator`: A synchronous validator function, or an array of validator functions * * `asyncValidator`: A single async validator or array of async validator functions *