Class IntlDate

Creates a date tied to a given locale (default system locale) which can be formatted in that locale's language using the native Intl Apis directly or using a formatting string.

See

Intl Apis

Hierarchy

  • IntlDate

Constructors

constructor

Properties

intlRelativeFormat locale?

Accessors

day dayOfWeek hour millisecond minute month relativeFormat second year

Methods

add clone compare dayOfYear daysInMonth daysInYear diff endOf eq format from fromNow getTime inspect isAfter isBefore isBetween isLeapYear isSame isValid isoWeek isoWeeksInYear lt relativeTime set startOf subtract timestamp to toDate toISODate toISOString toISOTime toNow toObject toSeconds toString unix utcOffset valueOf week weeksInYear zone zoneName UTC max min now unix

Constructors

constructor

  • Creates a new IntlDate in local time and specified locale (default is system locale). Note: The allowed values for month start at 1, which is different from legacy Date

    Returns

    Parameters

    • Optional obj: DateLike

      The date value (default is current local time)

    • opts: any = {}

      The options for this date

    Returns IntlDate

Properties

intlRelativeFormat

intlRelativeFormat: RelativeTimeFormat

Optional Readonly locale

locale?: string

Accessors

day

dayOfWeek

  • get dayOfWeek(): number

  • Returns the weekday as a number between 1 and 7, inclusive, where Monday is 1 and Sunday is 7.

    Returns number

hour

millisecond

minute

month

  • get month(): number

  • Get the this date's month as a number from 1 to 12, inclusive.

    Returns number

relativeFormat

second

year

Methods

add

clone

compare

dayOfYear

daysInMonth

daysInYear

diff

endOf

eq

format

  • Returns a localized string representation of this date, according to the given format string. Format codes use the same specification as moment.

    See

    List of formats

    Example

    new IntlDate().format('MM/DD/YYYY') // '10/31/2022'

    Parameters

    • str: string

      The format string to use

    Returns string

from

fromNow

  • Parameters

    • unit: RelativeTimeFormatUnit = 'seconds'

    Returns string

getTime

  • Returns the number of milliseconds since the Unix Epoch (January 1, 1970 UTC)

    Returns number

inspect

isAfter

  • Check if this date is after another date. The other value will be parsed as an IntlDate if not already so.

    Returns

    Returns true if this date is after the given value

    Parameters

    • other: DateLike

      Another date or date like object

    Returns boolean

isBefore

  • Check if this date is before another date. The other value will be parsed as an IntlDate if not already so.

    Returns

    Returns true if this date is before the given value

    Parameters

    • other: DateLike

      Another date or date like object

    Returns boolean

isBetween

  • Check if this date is strictly after the given start and before stop dates. The values will be parsed as an IntlDate if not already so.

    Returns

    Returns true if this date is greater than start and less than stop.

    Parameters

    Returns boolean

isLeapYear

isSame

  • Check if this date is the same as other.

    Returns

    Returns true if this date is the same as other

    Parameters

    • other: Date | IntlDate

      Another date object

    Returns boolean

isValid

isoWeek

isoWeeksInYear

  • Gets the number of weeks in the current year, according to ISO weeks.

    Returns number

lt

relativeTime

  • Parameters

    • n: number
    • unit: RelativeTimeFormatUnit = 'seconds'

    Returns string

set

startOf

subtract

timestamp

  • Returns the number of seconds since the Unix Epoch (January 1, 1970 UTC).

    See

    Example

    new IntlDate().timestamp() // 1318874398

    Returns number

to

toDate

  • Returns a new copy of the native Date object used by this instance.

    Returns

    A new Date object

    Returns Date

toISODate

  • Returns the date part formatted as ISO8601.

    Example

    new IntlDate().toISODate() // '2022-10-31'

    Returns string

toISOString

  • Formats a string to the ISO8601 standard.

    Example

    new IntlDate().toISOString() // '2022-10-31T22:44:30.652Z'

    Returns string

toISOTime

  • Returns the time part formatted as ISO8601.

    Example

    new IntlDate().toISOTime() // 'T22:44:30.652Z'

    Returns string

toNow

  • Parameters

    • unit: RelativeTimeFormatUnit = 'seconds'

    Returns string

toObject

  • Returns an object containing year, month, day-of-month, hours, minutes, seconds, milliseconds.

    Returns

    An object like {year, month, date, hours, minutes, seconds, ms}

    Returns DateObject

toSeconds

  • Returns the number of seconds since the Unix Epoch (January 1, 1970 UTC).

    See

    Example

    new IntlDate().toSeconds() // 1318874398

    Returns number

toString

  • Returns a localized string representation of this date.

    See

    Intl.DateTimeFormat()

    Parameters

    • Optional opts: DateTimeFormatOptions

      The options to use for the format

    Returns string

unix

utcOffset

  • Returns the difference in minutes between this date and UTC

    Returns number

valueOf

week

weeksInYear

  • Gets the number of weeks according to locale in the current year.

    Returns number

zone

zoneName

Static UTC

Static max

Static min

Static now

Static unix

Settings

Member Visibility

Theme

Generated using TypeDoc