Options which configure the behavior of the field
The initially provided options which configure the data field
The field name of this DataField instance. This is assigned by SchemaField#initialize.
A reference to the parent schema to which this DataField belongs. This is assigned by SchemaField#initialize.
A dot-separated string representation of the field path within the parent schema.
Default parameters for this field type
Apply a function to this DataField which propagates through recursively to any contained data schema.
The function to apply
The current value of this field
The results object
Coerce source data to ensure that it conforms to the correct data type for the field. Data coercion operations should be simple and synchronous as these are applied whenever a DataModel is constructed. For one-off cleaning of user-provided input the sanitize method should be used.
The initial value
The cast value
Attempt to retrieve a valid initial value for the DataField.
The source data object for which an initial value is required
A valid initial value
Validate a candidate input for this field, ensuring it meets the field requirements. A validation failure can be provided as a raised Error (with a string message) or by returning false. A validator which returns true denotes that the result is certainly valid and further validations are unnecessary.
The initial value
Returns a ModelValidationError if a validation failure occurred
Initialize the original source data into a mutable copy for the DataModel instance.
The source value of the field
The DataModel instance that this field belongs to
An initialized copy of the source data
Export the current value of the field into a serializable object.
The initialized value of the field
An exported representation of the field
Apply any cleaning logic specific to this DataField type.
The appropriately coerced value.
The cleaned value.
Cast a non-default value to ensure it is the correct type for the field
The provided non-default value
The standardized value
Special validation rules which supersede regular field validation. This validator screens for certain values which are otherwise incompatible with this field like null or undefined.
The candidate value
A boolean to indicate with certainty whether the value is valid. Otherwise, return void.
A default type-specific validator that can be overridden by child classes
The candidate value
A boolean to indicate with certainty whether the value is valid. Otherwise, return void.
An abstract class that defines the base pattern for a data field within a data schema.
{string} name The name of this data field within the schema that contains it
{boolean} required=false Is this field required to be populated?
{boolean} nullable=false Can this field have null values?
{Function|*} initial The initial value of a field, or a function which assigns that initial value.
{Function} validate A data validation function which accepts one argument with the current value.
{boolean} [readonly=false] Should the prepared value of the field be read-only, preventing it from being changed unless a change to the _source data is applied.
{string} label A localizable label displayed on forms which render this field.
{string} hint Localizable help text displayed on forms which render this field.
{string} validationError A custom validation error string. When displayed will be prepended with the document name, field name, and candidate value.