Module: format

Methods

---

<inner> dateFormat(date)

Format a date into a SolarNet UTC date format.

Parameters:

Name	Type	Description
date	Date	the date to format

Returns:

the formatted date value - yyyy-MM-dd

Type

string

---

<inner> dateParse(str)

Parse a SolarNet UTC date value.

Parameters:

Name	Type	Description
str	string	the string to parse - yyyy-MM-dd

Returns:

the parsed date, or null

Type

Date

---

<inner> dateParser(str)

Parse a UTC date string, from a variety of supported formats.

Parameters:

Name	Type	Description
str	String	the string to parse into a date

Returns:

the parsed Date, or null if the date can't be parsed

Type

Date

---

<inner> dateTimeFormat(date)

Format a date into a SolarNet UTC date/time format.

Parameters:

Name	Type	Description
date	Date	the date to format

Returns:

the formatted date value - yyyy-MM-dd HH:mm

Type

string

---

<inner> dateTimeParse(str)

Parse a SolarNet UTC date/time.

Parameters:

Name	Type	Description
str	string	the string to parse - `yyyy-MM-dd HH:mm

Returns:

the parsed date, or null

Type

Date

---

<inner> dateTimeUrlFormat(date)

Format a date into a SolarNet URL UTC date/time format.

Parameters:

Name	Type	Description
date	Date	the date to format

Returns:

the formatted date value - yyyy-MM-dd'T'HH:mm

Type

string

---

<inner> dateTimeUrlParse(str)

Parse a SolarNet URL UTC date/time value.

Parameters:

Name	Type	Description
str	string	the string to parse - yyyy-MM-dd'T'HH:mm

Returns:

the parsed date, or null

Type

Date

---

<inner> iso8601Date(date [, includeTime])

Format a date into an ISO 8601 timestamp or date string, in the UTC time zone.

Parameters:

Name	Type	Argument	Default	Description
date	Date			the date to format
includeTime	boolean	<optional>	false	true to format as a timestamp, false as just a date

Returns:

the formatted date string

Type

string

---

<inner> timestampFormat(date)

Format a date into a SolarNet UTC timestamp format.

Parameters:

Name	Type	Description
date	Date	the date to format

Returns:

the formatted date value - yyyy-MM-dd HH:mm:ss.SSS'Z'

Type

string

---

<inner> timestampParse(str)

Parse a SolarNet UTC timestamp value.

Parameters:

Name	Type	Description
str	string	the string to parse - `yyyy-MM-dd HH:mm:ss.SSS'Z'

Returns:

the parsed date, or null

Type

Date