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

ImmutableDictType

Extends:

Type → DataType → ImmutableDataType → ImmutableListType → ImmutableDictType

The DataType for dictionary values using Immutable.js.

Allowed options:

Name Type Attribute Description
keyType DataType The DataType to use for keys.
valueType DataType The DataType to use for values.

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
public

getKeyType(): *

public
public

isOfType(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.
From class ImmutableDataType
public static
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: *)

From class ImmutableListType
public static
public static

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

public
public

getDisplay(value: *, renderOptions: *): string

public

getField(refs: *, renderOptions: *): *

public

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

public

getFieldFromRef(ref: *, renderOptions: *): *

public
public

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

public

initialize(value: *, renderOptions: *): *

public

isOfType(value: *): *

public

setValue(list: *, ref: *, newValue: *, renderOptions: *): *

public

validate(list: *): *

Static Public Members

public static typeName: * source

The data type name. This must be overridden.

Override:

ImmutableListType#typeName

Static Public Methods

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

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

Override:

ImmutableListType#parseOptions

Params:

NameTypeAttributeDescription
field *
parseField *

Return:

*

Public Methods

public getDefaultValue(): * source

Override:

ImmutableListType#getDefaultValue

Return:

*

public getItemType(): * source

Override:

ImmutableListType#getItemType

Return:

*

public getKeyType(): * source

Return:

*

public getValueType(): * source

Return:

*

public isOfType(value: *): * source

Override:

ImmutableListType#isOfType

Params:

NameTypeAttributeDescription
value *

Return:

*