API overview

Core module “isomorphic-validation”

The core module of the library exports two entities: Validation and Predicate.

Instance methods:

• Validation().started()
• Validation().valid()
• Validation().invalid()
• Validation().changed()
• Validation().validated()
• Validation().error()
• Validation().constraint()
• Validation().bind()
• Validation().dataMapper()
• Validation().validate()

• Predicate().started()
• Predicate().valid()
• Predicate().invalid()
• Predicate().changed()
• Predicate().validated()
• Predicate().error()
• Predicate().restored()

Instance properties:

• Validation().client
• Validation().server
• Validation().isomorphic
• Validation().isValid
• Validation().constraints
• Validation().validations

• Predicate().client
• Predicate().server
• Predicate().isomorphic

Static methods:

• Validation.group()
• Validation.glue()
• Validation.clone()
• Validation.profile()

Validation object

A Validation object can be created several ways:

• a single Validation is created by the constructor function.
• a grouping Validation is created by the static methods Validation.group() and Validation.glue()
• also a grouping Validation with nested (grouped), bound to form fields Validation objects is created by the Validation.profile() static method.
• and lastly, a single Validation is created by the Validation.clone() method from another Validation.

Nested (grouped) Validation objects are accessed through:

• the Validation().validations property.
• by form field names when created using the Validation.profile() method.

Predicate object

A Predicate object can be created:

• by the constructor function.
• cloned from another Predicate object when passed into the constructor function.

Predicate objects added to validations can be accessed:

• through the Validation().constraints property.
• in state callbacks through the ValidationResult object passed in.

UI module “isomorphic-validation/ui”

The UI module exports the following set of helper, renderer and effect functions for performing UI side effects:

Helper functions

• firstInvalid()
• allInvalid()
• toEventHandler()
• createApplyEffect()

Renderer functions

• renderFirstError()
• renderAllErrors()
• renderProperty()

Effect functions

• applyClass()
• applyOutline()
• applyBackground()
• applyAccess()
• applyBox()