API Reference

This page provides a quick reference for the core Ack classes, methods, and annotations. For detailed explanations and usage examples, refer to the specific guides linked below.

Core Ack Class

Entry point for creating schemas. See Schema Types.

• Ack.string: Creates a StringSchema.
• Ack.int: Creates an IntSchema.
• Ack.double: Creates a DoubleSchema.
• Ack.boolean: Creates a BooleanSchema.
• Ack.list(AckSchema itemSchema): Creates a ListSchema.
• Ack.object(...): Creates an ObjectSchema.

AckSchema<T> (Base Class)

Base class for all schema types.

• Result<T> validate(dynamic data): Validates the input data against the schema.
• AckSchema<T?> nullable(): Returns a new schema that also accepts null.
• AckSchema<T> description(String description): Adds a description (used by toJsonSchema()).
• AckSchema<T> defaultValue(T value): Sets a default value (used by toJsonSchema()).
• AckSchema<T> constrain(...): Applies a custom validation constraint.
• Map<String, dynamic> toJsonSchema(): Converts the schema to a JSON Schema Object map (requires package:ack/json_schema.dart).

See also TypeSafe Schemas for working with schemas and Dart models.

StringSchema

Schema for validating strings. See String Constraints.

• minLength(...)
• maxLength(...)
• length(...)
• isNotEmpty(...)
• matches(...)
• contains(...)
• isEmail(...)
• isUrl(...)
• isDate(...)
• isDateTime(...)
• isEnum(...)

IntSchema / DoubleSchema (Number Schemas)

Schemas for validating numbers. See Number Constraints.

• min(...)
• max(...)
• positive(...)
• negative(...)
• multipleOf(...)

BooleanSchema

Schema for validating booleans. See Boolean Schema. No specific constraints beyond type.

ListSchema<E>

Schema for validating lists. See List Constraints.

• minItems(...)
• maxItems(...)
• length(...)
• isNotEmpty(...)
• uniqueItems(...)

ObjectSchema

Schema for validating objects (maps). See Object Schema.

• Constructed using Ack.object(...).
• Configuration includes properties, required, additionalProperties.

Result<T>

Object returned by validate(). See The Result Object.

• bool isOk
• bool isFail
• T getOrThrow()
• T? getOrNull()
• SchemaError? getError()
• T getOrElse(T Function() defaultValue)

SchemaError (and Subclasses)

Object representing a validation failure. See Understanding SchemaError and Error Types.

• String name
• String message
• List<String> path
• dynamic value
• dynamic expected

Subclasses: SchemaTypeError, SchemaRequiredError, SchemaConstraintsError, SchemaNestedError.

SchemaConstraint<T>

Base class for creating custom validation rules. See Custom Validation Guide.

• SchemaConstraint({required String name, required String message})
• bool validate(T value, [Map<String, dynamic>? data])

Code Generation (ack_generator)

Annotations for use on model classes when using code generation. See Code Generation Guide.

Class Annotations: @Schema(...)

Property Annotations: @Required, @Nullable, @Description, @IsEmail, @IsUrl, @IsDate, @IsDateTime, @MinLength, @MaxLength, @Length, @Matches, @Contains, @IsNotEmpty, @EnumValues, @Min, @Max, @Positive, @Negative, @MultipleOf, @MinItems, @MaxItems, @UniqueItems.

Refer to the individual guides for detailed usage and examples.