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

EnumType

Extends:

Type → DataType → EnumType

DataType for enumerated values.

Allowed options:

Name Type Attribute Description
multi boolean
  • optional
  • default: false
 Specifies whether this enum value holds one or multiple values.
values Object[] | string[] The list of enum values. If a list of strings is passed in, each string is interpreted as both the value and the label.
values.value string The unique value used by Formatron to identify this enum value.
values.label string The value used to display this enum to the user.

TODO:

  • Split this into MultiEnumType and EnumType.

Static Member Summary

Static Public Members
public static

Static Method Summary

Static Public Methods
public static

parseOptions(field: *, parseField: *): *

Method Summary

Public Methods
public
public

getDisplay(value: *): *

public

getValues(): *

public

hasValue(value: *, checkDefault: *): *

public

isMulti(): *

public

validate(value: *): *

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.
From class DataType
public static

The data type name.
public static

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

public

name: *

public

options: *

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.

Static Public Members

public static typeName: * source

The data type name. This must be overridden.

Override:

DataType#typeName

Static Public Methods

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

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

Override:

Type#parseOptions

Params:

NameTypeAttributeDescription
field *
parseField *

Return:

*

Public Methods

public getDefaultValue(): * source

Override:

DataType#getDefaultValue

Return:

*

public getDisplay(value: *): * source

Returns the value parsed for human consumption.

Override:

DataType#getDisplay

Params:

NameTypeAttributeDescription
value *

Return:

*

public getValues(): * source

Return:

*

public hasValue(value: *, checkDefault: *): * source

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

Override:

DataType#hasValue

Params:

NameTypeAttributeDescription
value *
checkDefault *

Return:

*

public isMulti(): * source

Return:

*

public validate(value: *): * source

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

Override:

DataType#validate

Params:

NameTypeAttributeDescription
value *

Return:

*