import ImmutableMapType from 'formatron/src/types/data/map.js'

public class | source

ImmutableMapType

Extends:

Type → DataType → ImmutableDataType → ImmutableMapType

The data type for maps of data.

Allowed options:

Name	Type	Description
data	(Object \| DataType)[]	A list of children data types. Its key in the map is the name of the child data type. If a data types is provided without a path, the path is assumed to be the name of the data type.
data.path	string[]	Where to access the child data type. @see https://facebook.github.io/immutable-js/docs/#/Map/getIn
data.field	DataType	The child data type.

Static Member Summary

Static Public Members
public static	typeName: *

Static Method Summary

Static Public Methods
public static	parseOptions(field: , parseField: ): *

Method Summary

Public Methods
public	exclude(model: , deep: boolean):
public	getData(): *
public	getDataNames(): *
public	getDefaultValue(): *
public	getDisplay(model: , renderOptions: ): *
public	getField(refs: , renderOptions: ): *
public	getFieldAndValue(model: , refs: , renderOptions: ):
public	getFieldData(ref: ):
public	getValue(model: , ref: , renderOptions: ):
public	hasValue(model: , checkDefault: ): *
public	initialize(value: , renderOptions: ): *
public	setValue(model: , refs: , newValue: , renderOptions: ): *
public	validate(model: ):
public	validateSingle(model: , ref: ): *

Inherited Summary

From class Type
public static	typeName: * 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	typeName: * 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	getValidationLinks(): *
public	getValidator(): *
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	isGenerated(): *
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	typeName: *
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: *)

Static Public Members

public static typeName: * source

The data type name. This must be overridden.

Override:

ImmutableDataType#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:

Name	Type	Attribute	Description
field	*
parseField	*

Return:

Public Methods

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

Override:

DataType#exclude

Params:

Name	Type	Attribute	Description
model	*
deep	boolean	optional default: true

Return:

public getData(): * source

Return:

public getDataNames(): * source

Return:

public getDefaultValue(): * source

Override:

DataType#getDefaultValue

Return:

public getDisplay(model: , renderOptions: ): * source

Returns the value parsed for human consumption.

Override:

DataType#getDisplay

Params:

Name	Type	Attribute	Description
model	*
renderOptions	*

Return:

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

Override:

ImmutableDataType#getField

Params:

Name	Type	Attribute	Description
refs	*
renderOptions	*

Return:

public getFieldAndValue(model: , refs: , renderOptions: ): source

Override:

ImmutableDataType#getFieldAndValue

Params:

Name	Type	Attribute	Description
model	*
refs	*
renderOptions	*

Return:

public getFieldData(ref: ): source

Params:

Name	Type	Attribute	Description
ref	*

Return:

public getValue(model: , 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:

ImmutableDataType#getValue

Params:

Name	Type	Attribute	Description
model	*
ref	*
renderOptions	*

Return:

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

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

Override:

ImmutableDataType#hasValue

Params:

Name	Type	Attribute	Description
model	*
checkDefault	*

Return:

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

Params:

Name	Type	Attribute	Description
value	*
renderOptions	*

Return:

public setValue(model: , refs: , newValue: , renderOptions: ): * source

Override:

ImmutableDataType#setValue

Params:

Name	Type	Attribute	Description
model	*
refs	*
newValue	*
renderOptions	*

Return:

public validate(model: ): source

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

Override:

DataType#validate

Params:

Name	Type	Attribute	Description
model	*

Return:

public validateSingle(model: , ref: ): * source

Params:

Name	Type	Attribute	Description
model	*
ref	*

ImmutableMapType

Extends:

Static Member Summary

Static Method Summary

Method Summary

Inherited Summary

Static Public Members

public static typeName: * source

Override:

Static Public Methods

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

Override:

Params:

Return:

Public Methods

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

Override:

Params:

Return:

public getData(): * source

Return:

public getDataNames(): * source

Return:

public getDefaultValue(): * source

Override:

Return:

public getDisplay(model: *, renderOptions: *): * source

Override:

Params:

Return:

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

Override:

Params:

Return:

public getFieldAndValue(model: *, refs: *, renderOptions: *): * source

Override:

Params:

Return:

public getFieldData(ref: *): * source

Params:

Return:

public getValue(model: *, ref: *, renderOptions: *): * source

Override:

Params:

Return:

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

Override:

Params:

Return:

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

Params:

Return:

public setValue(model: *, refs: *, newValue: *, renderOptions: *): * source

Override:

Params:

Return:

public validate(model: *): * source

Override:

Params:

Return:

public validateSingle(model: *, ref: *): * source

Params:

Return:

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

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

public getDisplay(model: , renderOptions: ): * source

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

public getFieldAndValue(model: , refs: , renderOptions: ): source

public getFieldData(ref: ): source

public getValue(model: , ref: , renderOptions: ): source

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

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

public setValue(model: , refs: , newValue: , renderOptions: ): * source

public validate(model: ): source

public validateSingle(model: , ref: ): * source