Skip to main content

parseRelativeDate

Stentor API Reference


Stentor API Reference / stentor-utils/src / parseRelativeDate

Function: parseRelativeDate()

parseRelativeDate(relative, now): DateTimeRange | DateTime

Defined in: packages/stentor-utils/src/dateTime.ts:276

Parses the relative date string and returns a date time.

Support is currently limited, see possible RelativeDateType & RelativeDateRangeType for current supported values.

Parameters​

relative​

string

The relative date

now​

Date = ...

Optional date to use to calculate date off of

Returns​

DateTimeRange | DateTime

  • Computed relative data time