Home Reference Source 
import DataType from 'formatron/src/types/data/index.js'
public class | source

DataType

Extends:

Type → DataType

Direct Subclass:

BoolType, DateType, EnumType, ImmutableDataType, NumberType, TextType

Indirect Subclass:

ImmutableDictType, ImmutableListOrMapType, ImmutableListType, ImmutableMapType

The base data type. Every registered data type must eventually inherit from this.

Allowed options:

Name Type Attribute Description
required boolean
  • optional
  • default: false
 Marks if this data type is required to have a value to pass validation.
unique boolean
  • optional
  • default: false
 Marks if this data type is required to be unique across all models.
generated boolean
  • optional
  • default: false
 Marks if this data type will have a value generated by the server if it is not assigned one by the client.
excluded boolean
  • optional
  • default: false
 Marks if this data type will be excluded from the output model.
defaultValue any
  • optional
 The default value to use if one is not provided by the user.
validator function(value: any, rootValue: any): boolean
  • optional
 A custom validation function.
validationLinks string[]
  • optional
 A list of other data types in this model to also validate when this data type is validated.

Static Member Summary

Static Public Members
public static

The data type name.

Static Method Summary

Static Public Methods
public static

parse(field: *, parseField: *): *

Constructor Summary

Public Constructor
public

constructor(name: string, options: Object)

Creates a new instance of a data type.

Member Summary

Public Members
public

name: *

public

options: *

Method Summary

Public Methods
public

exclude(model: *, deep: boolean): *

public

filter(filterValue: *, rowValue: *): *

public

getDefaultValue(defaultValue: undefined): *

public

getDisplay(value: *): string

Returns the value parsed for human consumption.
public

getField(ref: *): *

public

getFieldAndValue(value: *, ref: *): {"field": *, "value": *}

public

getName(): *

public

getOptions(): *

public
public
public

getValue(value: *, defaultValue: *): *

Returns a parsed value.
public

hasValue(value: object, checkDefault: boolean): boolean

Checks if the passed in value is "not empty".
public

isExcluded(): *

public
public

isRequired(): *

public

isUnique(): *

public

validate(value: *, callback: *): *

Validates that the given value follows the rules of the data type.

Inherited Summary

From class Type
public static

The type name.
public static

parse(field: object | Immutable.Map, parseField: function): Type

Parses a JS or Immutable.js object into a type.
public static

parseOneOrMany(parseField: func): oneOrManyParser

Creates a one or many parser with the passed in field parser.
public static

parseOptions(field: Immutable.Map, parseField: function): Immutable.Map

Override this function if you want the type to reference other types.

Static Public Members

public static typeName: * source

The data type name. This must be overridden.

Override:

Type#typeName

Static Public Methods

public static parse(field: *, parseField: *): * source

Parses a JS or Immutable.js object into a type.

Override:

Type#parse

Params:

NameTypeAttributeDescription
field *
parseField *

Return:

*

Public Constructors

public constructor(name: string, options: Object) source

Creates a new instance of a data type.

Params:

NameTypeAttributeDescription
name string

The unique name of this instance.
options Object

Options to apply to this instance. See the top of this file for allowed options.

Public Members

public name: * source

public options: * source

Public Methods

public exclude(model: *, deep: boolean): * source

Params:

NameTypeAttributeDescription
model *
deep boolean
  • optional
  • default: true

Return:

*

public filter(filterValue: *, rowValue: *): * source

Params:

NameTypeAttributeDescription
filterValue *
rowValue *

Return:

*

public getDefaultValue(defaultValue: undefined): * source

Params:

NameTypeAttributeDescription
defaultValue undefined
  • optional
  • default: undefined

Return:

*

public getDisplay(value: *): string source

Returns the value parsed for human consumption.

Params:

NameTypeAttributeDescription
value *

Return:

string

The parsed value.

public getField(ref: *): * source

Params:

NameTypeAttributeDescription
ref *

Return:

*

public getFieldAndValue(value: *, ref: *): {"field": *, "value": *} source

Params:

NameTypeAttributeDescription
value *
ref *

Return:

{"field": *, "value": *}

public getName(): * source

Return:

*

public getOptions(): * source

Return:

*

Return:

*

public getValidator(): * source

Return:

*

public getValue(value: *, defaultValue: *): * source

Returns a parsed value. A value of undefined implies that the value is missing and should be filled in by a default value, first supplied in the options, and if not, the one supplied by the type.

Params:

NameTypeAttributeDescription
value *
defaultValue *

Return:

*

public hasValue(value: object, checkDefault: boolean): boolean source

Checks if the passed in value is "not empty".

Params:

NameTypeAttributeDescription
value object

The data value to check.
checkDefault boolean
  • optional
  • default: true

Check if the value is the default value or not.

Return:

boolean

true if it is "not empty", otherwise, false.

public isExcluded(): * source

Return:

*

public isGenerated(): * source

Return:

*

public isRequired(): * source

Return:

*

public isUnique(): * source

Return:

*

public validate(value: *, callback: *): * source

Validates that the given value follows the rules of the data type.

Params:

NameTypeAttributeDescription
value *
callback *

Return:

*

An error if one was found, undefined otherwise.