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

ImmutableDataType

Extends:

Type → DataType → ImmutableDataType

Direct Subclass:

ImmutableListOrMapType, ImmutableListType, ImmutableMapType

Indirect Subclass:

ImmutableDictType

Static Member Summary

Static Public Members
public static

Method Summary

Public Methods
public

getField(ref: *, renderOptions: *)

public

getFieldAndValue(value: *, ref: *, renderOptions: *)

public

getNextField(field: *, refs: *, renderOptions: *): *

public

getNextFieldAndValue(field: *, value: *, refs: *, renderOptions: *): *

public

getValue(value: *, ref: *, renderOptions: *): *

public

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

public

setNextValue(field: *, oldValue: *, newValue: *, refs: *, renderOptions: *): *

public

setValue(value: *, ref: *, newValue: *)

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

Public Methods

public getField(ref: *, renderOptions: *) source

Override:

DataType#getField

Params:

NameTypeAttributeDescription
ref *
renderOptions *

public getFieldAndValue(value: *, ref: *, renderOptions: *) source

Override:

DataType#getFieldAndValue

Params:

NameTypeAttributeDescription
value *
ref *
renderOptions *

public getNextField(field: *, refs: *, renderOptions: *): * source

Params:

NameTypeAttributeDescription
field *
refs *
renderOptions *

Return:

*

public getNextFieldAndValue(field: *, value: *, refs: *, renderOptions: *): * source

Params:

NameTypeAttributeDescription
field *
value *
refs *
renderOptions *

Return:

*

public getValue(value: *, ref: *, renderOptions: *): * 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.

Override:

DataType#getValue

Params:

NameTypeAttributeDescription
value *
ref *
renderOptions *

Return:

*

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

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

Override:

DataType#hasValue

Params:

NameTypeAttributeDescription
value *
checkDefault *

Return:

*

public setNextValue(field: *, oldValue: *, newValue: *, refs: *, renderOptions: *): * source

Params:

NameTypeAttributeDescription
field *
oldValue *
newValue *
refs *
renderOptions *

Return:

*

public setValue(value: *, ref: *, newValue: *) source

Params:

NameTypeAttributeDescription
value *
ref *
newValue *