Skip to content

Commit

Permalink
docs: update validate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alestiago committed Nov 29, 2023
1 parent cb7457f commit f18a041
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions lib/formz.dart
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,14 @@ mixin FormzInputErrorCacheMixin<T, E> on FormzInput<T, E> {
/// Class which contains methods that help manipulate and manage
/// validity of [FormzInput] instances.
class Formz {
/// Returns a [bool] given a list of [FormzInput] indicating whether
/// the inputs are all valid.
/// Returns whether or not a given a list of [FormzInput] has all valid
/// inputs.
///
/// This method will return `true` if all inputs are valid and `false`
/// otherwise.
///
/// If some inputs validations are asynchronous, this method will return as
/// soon as one of the inputs is invalid.
static FutureOr<bool> validate(
List<FormzInput<dynamic, dynamic>> inputs,
) async {
Expand Down

0 comments on commit f18a041

Please sign in to comment.