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

DateType

Extends:

Type → DataType → DateType

The DataType for date values. Stores a value of seconds since January 1st 1970.

Allowed options:

Name Type Attribute Description
dateType string
  • optional
  • default: 'datetime'
 Whether to handle just a date, time or both. 'date' | 'time' | 'datetime'

Static Member Summary

Static Public Members
public static

Method Summary

Public Methods
public

convert(value: string | Date | moment | number, toType: string): string | moment | number

Converts between strings, JS Date objects, moment objects, or unix time values.
public

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

this method was deprecated. Filtering will be refactored to its own module.
public
this method was deprecated. Will be moved to ViewType
public

getDisplay(value: *): *

this method was deprecated. Will be moved to view types.
public

getFormat(): *

this method was deprecated. Will be moved to ViewType
public

getType(): *

public

getValue(value: *): *

public

hasValue(value: any): boolean

Checks if the passed in value holds a valid date 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

Public Methods

public convert(value: string | Date | moment | number, toType: string): string | moment | number source

Converts between strings, JS Date objects, moment objects, or unix time values.

Params:

NameTypeAttributeDescription
value string | Date | moment | number

The date value to convert
toType string
  • optional
  • default: 'string'|'datetime'|'unix'

The type to convert to.

Return:

string | moment | number

The date value in a new format.

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

this method was deprecated. Filtering will be refactored to its own module.

Override:

DataType#filter

Params:

NameTypeAttributeDescription
filterValue *
rowValue *

Return:

*

public getDefaultFormat(): string source

this method was deprecated. Will be moved to ViewType

Return:

string

public getDisplay(value: *): * source

this method was deprecated. Will be moved to view types.

Returns the value parsed for human consumption.

Override:

DataType#getDisplay

Params:

NameTypeAttributeDescription
value *

Return:

*

public getFormat(): * source

this method was deprecated. Will be moved to ViewType

Return:

*

public getType(): * source

Return:

*

<string> "date" | "time" | "datetime"

public getValue(value: *): * source

See DataType#getValue.

Override:

DataType#getValue

Params:

NameTypeAttributeDescription
value *

Return:

*

public hasValue(value: any): boolean source

Checks if the passed in value holds a valid date value.

Override:

DataType#hasValue

Params:

NameTypeAttributeDescription
value any

The date value

Return:

boolean