cargdev/angular
1
0
Fork 0
Code Issues 9 Pull Requests Actions Packages Projects Releases Wiki Activity

feat(aio): first pass API docs redesign (#21874)

Browse Source 
Includes:

* display ToC for API docs
* update dgeni-packages to 0.24.1
* add floating sidebar in API docs
* add breadcrumbs and structured data for Google crawler
* improved rendering of method overloads
* properties rendered in a table
* params rendered with docs
* removal of outdated "infobox" from all API docs

PR Close #21874
This commit is contained in:
Pete Bacon Darwin
2018-02-08 15:00:53 +00:00
committed by Miško Hevery
parent bc1e22922a
commit 7007f51c35
33 changed files with 831 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
packages/forms/src/model.ts
View File

@ -117,6 +117,9 @@ function isOptionsObj(
* that are shared between all sub-classes, like `value`, `valid`, and `dirty`. It shouldn't be
* instantiated directly.
*
* @see [Forms Guide](/guide/forms)
* @see [Reactive Forms Guide](/guide/reactive-forms)
* @see [Dynamic Forms Guide](/guide/dynamic-form)
* @stable
*/
export abstract class AbstractControl {
@ -136,6 +139,12 @@ export abstract class AbstractControl {
private _asyncValidationSubscription: any;
public readonly value: any;
/**
* Initialize the AbstractControl instance.
* @param validator The function that will determine the synchronous validity of this control.
* @param asyncValidator The function that will determine the asynchronous validity of this
* control.
*/
constructor(public validator: ValidatorFn|null, public asyncValidator: AsyncValidatorFn|null) {}
/**
@ -1033,10 +1042,6 @@ export class FormGroup extends AbstractControl {
* Sets the value of the {@link FormGroup}. It accepts an object that matches
* the structure of the group, with control names as keys.
*
* This method performs strict checks, so it will throw an error if you try
* to set the value of a control that doesn't exist or if you exclude the
* value of a control.
*
* ### Example
*
* ```
@ -1050,6 +1055,9 @@ export class FormGroup extends AbstractControl {
* console.log(form.value); // {first: 'Nancy', last: 'Drew'}
*
* ```
* @throws This method performs strict checks, so it will throw an error if you try
* to set the value of a control that doesn't exist or if you exclude the
* value of a control.
*/
setValue(value: {[key: string]: any}, options: {onlySelf?: boolean, emitEvent?: boolean} = {}):
void {