README.md

@nsf-open/ember-datetime-utils

@nsf-open/ember-datetime-utils

Table of contents

Variables

• BIG_ENDIAN_DATETIME_FORMAT
• BIG_ENDIAN_DATE_FORMAT
• BIG_ENDIAN_TIME_FORMAT
• MIDDLE_ENDIAN_DATETIME_FORMAT
• MIDDLE_ENDIAN_DATE_FORMAT
• MIDDLE_ENDIAN_TIME_FORMAT
• PARSE_FORMATS

Functions

• bigEndianDateString
• middleEndianDateString
• middleEndianDateTimeString
• middleEndianTimeString
• parseDateTime
• toBigEndianDateString
• toBigEndianDateTimeString
• toBigEndianTimeString
• toFormattedString
• toMiddleEndianDateString
• toMiddleEndianDateTimeString
• toMiddleEndianTimeString

Variables

BIG_ENDIAN_DATETIME_FORMAT

• Const BIG_ENDIAN_DATETIME_FORMAT: "YYYY-MM-DD[T]HH:mm:ss.SSS"

Defined in

constants.ts:6

---

BIG_ENDIAN_DATE_FORMAT

• Const BIG_ENDIAN_DATE_FORMAT: "YYYY-MM-DD"

Defined in

constants.ts:4

---

BIG_ENDIAN_TIME_FORMAT

• Const BIG_ENDIAN_TIME_FORMAT: "HH:mm:ss.SSS"

Defined in

constants.ts:5

---

MIDDLE_ENDIAN_DATETIME_FORMAT

• Const MIDDLE_ENDIAN_DATETIME_FORMAT: "MM/DD/YYYY h:mm A"

Defined in

constants.ts:3

---

MIDDLE_ENDIAN_DATE_FORMAT

• Const MIDDLE_ENDIAN_DATE_FORMAT: "MM/DD/YYYY"

Defined in

constants.ts:1

---

MIDDLE_ENDIAN_TIME_FORMAT

• Const MIDDLE_ENDIAN_TIME_FORMAT: "h:mm A"

Defined in

constants.ts:2

---

PARSE_FORMATS

• Const PARSE_FORMATS: string[]

Defined in

constants.ts:9

Functions

bigEndianDateString

▸ bigEndianDateString(dependantKey, defaultValue?, options?): default<any, any>

Exposes the bigEndianDateString formatter as an Ember computed decorator to format a date-like value as "YEAR-MONTH-DAY".

public dateValue: new Date(1970, 9, 25, 13, 10, 50);

@bigEndianDateString('dateValue');
public formattedDate!: string; // => '1970-10-25'

Parameters

Name	Type	Default value
dependantKey	string	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

default<any, any>

Defined in

computed-macros.ts:77

---

middleEndianDateString

▸ middleEndianDateString(dependantKey, defaultValue?, options?): default<any, any>

Exposes the toMiddleEndianDateString formatter as an Ember computed decorator to format a date-like value as "MONTH/DAY/YEAR".

public dateValue: new Date(1970, 9, 25, 13, 10, 50);

@middleEndianDateString('dateValue');
public formattedDate!: string; // => '10/25/1970'

Parameters

Name	Type	Default value
dependantKey	string	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

default<any, any>

Defined in

computed-macros.ts:23

---

middleEndianDateTimeString

▸ middleEndianDateTimeString(dependantKey, defaultValue?, options?): default<any, any>

Exposes the middleEndianDateTimeString formatter as an Ember computed decorator to format a date-like value as "MONTH/DAY/YEAR HOUR:MINUTE MERIDIEM".

public dateValue: new Date(1970, 9, 25, 13, 10, 50);

@middleEndianDateTimeString('dateValue');
public formattedDateTime!: string; // => '10/25/1970 1:10 PM'

Parameters

Name	Type	Default value
dependantKey	string	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

default<any, any>

Defined in

computed-macros.ts:59

---

middleEndianTimeString

▸ middleEndianTimeString(dependantKey, defaultValue?, options?): default<any, any>

Exposes the middleEndianTimeString formatter as an Ember computed decorator to format a date-like value as "HOUR:MINUTE MERIDIEM".

public dateValue: new Date(1970, 9, 25, 13, 10, 50);

@middleEndianTimeString('dateValue');
public formattedTime!: string; // => '1:10 PM'

Parameters

Name	Type	Default value
dependantKey	string	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

default<any, any>

Defined in

computed-macros.ts:41

---

parseDateTime

▸ parseDateTime(value, options?): null | Date

Takes a variety of possible inputs and attempts to make a date. This will only ever return either a Date instance, or null.

Parameters

Name	Type
value	any
options	ParseOptions

Returns

null | Date

Defined in

parser.ts:25

---

toBigEndianDateString

▸ toBigEndianDateString(value, defaultValue?, options?): any

Formats a date-like value as "YEAR-MONTH-DAY".

toBigEndianDateString(new Date(1970, 9, 25, 13, 10, 50)); // => '1970-10-25'

Parameters

Name	Type	Default value
value	any	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

any

Defined in

formatters.ts:73

---

toBigEndianDateTimeString

▸ toBigEndianDateTimeString(value, defaultValue?, options?): any

Formats a date-like value as "YEAR-MONTH-DAY HOUR:MINUTE:SECOND.MILLISECOND[TIMEZONE]".

toBigEndianDateTimeString(new Date(1970, 9, 25, 13, 10, 50)); // => '1970-10-25 13:10:50.000-05:00' (assuming EST)

Parameters

Name	Type	Default value
value	any	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

any

Defined in

formatters.ts:97

---

toBigEndianTimeString

▸ toBigEndianTimeString(value, defaultValue?, options?): any

Formats a date-like value as "HOUR:MINUTE:SECOND.MILLISECOND[TIMEZONE]".

toBigEndianTimeString(new Date(1970, 9, 25, 13, 10, 50)); // => '13:10:50.000-05:00' (assuming EST)

Parameters

Name	Type	Default value
value	any	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

any

Defined in

formatters.ts:85

---

toFormattedString

▸ toFormattedString(value, formatOut, defaultValue?, options?): any

Given a value that can be converted into a valid MomentJS instance, format it with the provided mask. If it cannot be converted, a default value (usually a string) is returned.

Parameters

Name	Type	Default value
value	any	undefined
formatOut	string	undefined
defaultValue	any	''
options	ParseOptions	{}

Returns

any

Defined in

formatters.ts:21

---

toMiddleEndianDateString

▸ toMiddleEndianDateString(value, defaultValue?, options?): any

Formats a date-like value as "MONTH/DAY/YEAR".

toMiddleEndianDateString(new Date(1970, 9, 25, 13, 10, 50)); // => '10/25/1970'

Parameters

Name	Type	Default value
value	any	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

any

Defined in

formatters.ts:37

---

toMiddleEndianDateTimeString

▸ toMiddleEndianDateTimeString(value, defaultValue?, options?): any

Formats a date-like value as "MONTH/DAY/YEAR HOUR:MINUTE MERIDIEM".

toMiddleEndianDateTimeString(new Date(1970, 9, 25, 13, 10, 50)); // => '10/25/1970 1:10 PM'

Parameters

Name	Type	Default value
value	any	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

any

Defined in

formatters.ts:61

---

toMiddleEndianTimeString

▸ toMiddleEndianTimeString(value, defaultValue?, options?): any

Formats a date-like value as "HOUR:MINUTE MERIDIEM".

toMiddleEndianTimeString(new Date(1970, 9, 25, 13, 10, 50)); // => '1:10 PM'

Parameters

Name	Type	Default value
value	any	undefined
defaultValue	any	'None'
options	ParseOptions	{}

Returns

any

Defined in

formatters.ts:49