mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
f6a096e3d4
Replace `new Error()` in a forms Validators function with `RuntimeError`, for better tree-shakability. Also, improve the error messages, and add documentation. PR Close #46537
30 lines
No EOL
877 B
Markdown
30 lines
No EOL
877 B
Markdown
@name Wrong Async Validator Return Type
|
|
@category forms
|
|
@shortDescription Async validator must return a Promise or Observable
|
|
|
|
@description
|
|
Async validators must return a promise or an observable, and emit/resolve them whether the validation fails or succeeds. In particular, they must implement the [AsyncValidatorFn API](api/forms/AsyncValidator)
|
|
|
|
```typescript
|
|
export function isTenAsync(control: AbstractControl):
|
|
Observable<ValidationErrors> | null {
|
|
const v: number = control.value;
|
|
if (v !== 10) {
|
|
// Emit an object with a validation error.
|
|
return of({ 'notTen': true, 'requiredValue': 10 });
|
|
}
|
|
// Emit null, to indicate no error occurred.
|
|
return of(null);
|
|
}
|
|
```
|
|
|
|
@debugging
|
|
Did you mistakenly use a synchronous validator instead of an async validator?
|
|
|
|
<!-- links -->
|
|
|
|
<!-- external links -->
|
|
|
|
<!-- end links -->
|
|
|
|
@reviewed 2022-06-28 |