Skip to content

Commit a4398aa

Browse files
committed
docs(forms): update description for FormBuilder.group (angular#26970)
PR Close angular#26970
1 parent 53e4e0c commit a4398aa

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

packages/forms/src/form_builder.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,16 @@ export class FormBuilder {
3232
* @param controlsConfig A collection of child controls. The key for each child is the name
3333
* under which it is registered.
3434
*
35-
* @param extra An object of configuration options for the `FormGroup`.
35+
* @param legacyOrOpts Configuration options object for the `FormGroup`. The object can
36+
* have two shapes:
37+
*
38+
* 1) `AbstractControlOptions` object (preferred), which consists of:
39+
* * `validators`: A synchronous validator function, or an array of validator functions
40+
* * `asyncValidators`: A single async validator or array of async validator functions
41+
* * `updateOn`: The event upon which the control should be updated (options: 'change' | 'blur' |
42+
* submit')
43+
*
44+
* 2) Legacy configuration object, which consists of:
3645
* * `validator`: A synchronous validator function, or an array of validator functions
3746
* * `asyncValidator`: A single async validator or array of async validator functions
3847
*

0 commit comments

Comments
 (0)