Interface ToRelativeOptions

Hierarchy

  • ToRelativeOptions

Properties

base? locale? numberingSystem? padding? round? style? unit?

Properties

Optional base

base?: DateTime

The DateTime to use as the basis to which this time is compared. Defaults to now.

Optional locale

locale?: string

Optional numberingSystem

numberingSystem?: NumberingSystem

The Intl system may choose not to honor this

Optional padding

padding?: number

Padding in milliseconds. This allows you to round up the result if it fits inside the threshold. Don't use in combination with {round: false} because the decimal output will include the padding. Defaults to 0.

Optional round

round?: boolean

Defaults to true.

Optional style

style?: RelativeTimeFormatStyle

Optional unit

unit?: RelativeTimeFormatUnit

If omitted, the method will pick the unit.

Settings

Member Visibility

Theme

Generated using TypeDoc