eskema 0.1.0

Small & composable runtime validation library

example/main.dart

// ignore_for_file: unused_local_variable, avoid_print

import 'package:eskema/eskema.dart';

final emailRegexp =
    RegExp(r"^[a-zA-Z0-9.a-zA-Z0-9.!#$%&'*+-/=?^_`{|}~]+@[a-zA-Z0-9]+\.[a-zA-Z]+");

void main() {
  final isEmail = stringMatchesPattern(
    emailRegexp,
    error: 'a valid email address',
  );

  final accountEskema = eskema({
    // You can access some validators directly using the $ prefix
    'id': $isInt,

    // or you can build the validator using the function
    'name': isString(),
  });

  final purchaseEskema = eskema({
    'product_name': $isString,
    'price': $isDouble,
  });

  final userEskema = eskema({
    'username': $isString,
    'age': $isInt,
    // Nullable fields can be defined using the copyWith method
    'accounts': listEach(accountEskema).copyWith(nullable: true),
    // by using the orNullable method
    'email': isEmail.nullable(),
    // or by using the nullable validator
    'purchases': nullable(listEach(purchaseEskema)),
  });

  // Validate user data and get a result
  final isUserValid2 = userEskema.validate({
    'username': 'bob',
    'email': null,
    'age': 43,
    'accounts': [
      {'id': 123, 'name': 'account1'}
    ],
  });
  print(isUserValid2.isValid); // true
  print(isUserValid2.error); // null

  // Check if the validator is valid or not
  final userResult = userEskema.validate({});
  print(userResult.isValid); // should be false
  print(userResult.error); // should contain expected errors

  // You can also use the 'validate' extension method
  final mapData = {
    'username': 'bob',
    'email': null,
    'age': 43,
    'accounts': [
      {'id': 123, 'name': 'account1'}
    ],
  };

  mapData.validate(userEskema);
}