Introduction

Acanthis is a Validation library for Dart & Flutter heavily inspired by Zod. It is designed to be a simple, and easy to use validation library.

Features

Acanthis is designed to be composable. Schemas can be composed together to create more complex schemas.

Also Acanthis doesn't require any runtime dependencies other than Dart.

Getting Started

To get started with Acanthis, you can install it using the following command:

dart pub add acanthis

Example

Here is a simple example of how to use Acanthis:

import 'package:acanthis/acanthis.dart';

void main() {
  final schema = object({
	  'name': string().min(3),
	  'age': number().positive(),
  });

  final result = schema.tryParse({
	  'name': 'Francesco',
	  'age': 24,
  });

  /// The result is a AcanthisParseResult object
  /// that has the following properties:
  /// - success: A boolean that indicates if the parsing was successful or not.
  /// - value: The value of the parsing. If the parsing was successful, this will contain the parsed value.
  /// - errors: The errors of the parsing. If the parsing was unsuccessful, this will contain the errors of the parsing.

  if (result.success) {
	  print('The schema is valid!');
  } else {
	  print('The schema is invalid!');
  }
}

As you can see if you come from a Zod background, the API is very similar and should be familiar to you. Also all the values are required.

Differences between the parsing methods

Acanthis provide four different methods to parse a value:

Method	Description
tryParse	This method will return a AcanthisParseResult object that contains the result of the parsing.
parse	This method will return a AcanthisParseResult object that contains the result of the parsing. If the parsing was unsuccessful, it will throw an exception.
tryParseAsync	This method will return a Future<AcanthisParseResult> object that contains the result of the parsing.
parseAsync	This method will return a Future<AcanthisParseResult> object that contains the result of the parsing. If the parsing was unsuccessful, it will throw an exception.

AcanthisParseResult

The AcanthisParseResult object contains the result of the parsing. It has the following properties:

• success: A boolean that indicates if the parsing was successful or not.
• value: The value of the parsing. If the parsing was successful, this will contain the parsed value.
• errors: The errors of the parsing. If the parsing was unsuccessful, this will contain the errors of the parsing.