RelativeDateTime

Stentor API Reference

---

Stentor API Reference / stentor-models/src / RelativeDateTime

Interface: RelativeDateTime

Defined in: packages/stentor-models/src/DateTime/RelativeDateTime.ts:53

A relative date time contains data about relative dates such as "yesterday" or "last year".

Typically, this object is then converted to a DateTime or DateTimeRange at runtime.

Properties

relativity

relativity: string

Defined in: packages/stentor-models/src/DateTime/RelativeDateTime.ts:58

The relative date. It can be just "LAST_WEEKEND" but can also be "${LAST_WEEKEND}", "${LAST_SUNDAY}T12:00:00", "${LAST_FRIDAY}T12:00:00 --> ${LAST_SATURDAY}T12:00:00" or "${LAST_FRIDAY}T12:00:00/${LAST_SATURDAY}T12:00:00"

---

amount?

optional amount: number

Defined in: packages/stentor-models/src/DateTime/RelativeDateTime.ts:59