Class DateTime

This class is used to represent a date and time in the Tai64 format.

import { DateTime } from 'fuels';

// Constants
const tai64 = '4611686020108779340';
const unixMilliseconds = 1681391398000;
const seconds = 1681391398;

// Instantiation
let date: DateTime = DateTime.now();
date = DateTime.fromTai64(tai64);
date = DateTime.fromUnixMilliseconds(unixMilliseconds);
date = DateTime.fromUnixSeconds(seconds);

// Utility functions
tai64.toTai64() // '4611686020108779340'
milliseconds.toUnixMilliseconds() // 1681391398000
seconds.toUnixSeconds() // 1681391398

// All date methods are available
const now: Date = DateTime.now();
now.toISOString(); // '2023-04-13T13:09:58.000Z'
now.getTime(); // 1681391398000

Hierarchy

  • Date
    • DateTime

Implements

  • Date

Properties

TAI64_NULL

Methods

[toPrimitive] getDate getDay getFullYear getHours getMilliseconds getMinutes getMonth getSeconds getTime getTimezoneOffset getUTCDate getUTCDay getUTCFullYear getUTCHours getUTCMilliseconds getUTCMinutes getUTCMonth getUTCSeconds setDate setFullYear setHours setMilliseconds setMinutes setMonth setSeconds setTime setUTCDate setUTCFullYear setUTCHours setUTCMilliseconds setUTCMinutes setUTCMonth setUTCSeconds toDateString toISOString toJSON toLocaleDateString toLocaleString toLocaleTimeString toString toTai64 toTimeString toUTCString toUnixMilliseconds toUnixSeconds valueOf UTC fromTai64 fromUnixMilliseconds fromUnixSeconds now parse

Properties

StaticTAI64_NULL

TAI64_NULL: string = ''

Methods

[toPrimitive]

  • [toPrimitive](hint): string

  • Converts a Date object to a string.

    Parameters

    • hint: "default"

    Returns string

  • [toPrimitive](hint): string

  • Converts a Date object to a string.

    Parameters

    • hint: "string"

    Returns string

  • [toPrimitive](hint): number

  • Converts a Date object to a number.

    Parameters

    • hint: "number"

    Returns number

  • [toPrimitive](hint): string | number

  • Converts a Date object to a string or number.

    Parameters

    • hint: string

      The strings "number", "string", or "default" to specify what primitive to return.

    Returns string | number

    A number if 'hint' was "number", a string if 'hint' was "string" or "default".

    Throws

    If 'hint' was given something other than "number", "string", or "default".

getDate

  • getDate(): number

  • Gets the day-of-the-month, using local time.

    Returns number

getDay

  • getDay(): number

  • Gets the day of the week, using local time.

    Returns number

getFullYear

  • getFullYear(): number

  • Gets the year, using local time.

    Returns number

getHours

  • getHours(): number

  • Gets the hours in a date, using local time.

    Returns number

getMilliseconds

  • getMilliseconds(): number

  • Gets the milliseconds of a Date, using local time.

    Returns number

getMinutes

  • getMinutes(): number

  • Gets the minutes of a Date object, using local time.

    Returns number

getMonth

  • getMonth(): number

  • Gets the month, using local time.

    Returns number

getSeconds

  • getSeconds(): number

  • Gets the seconds of a Date object, using local time.

    Returns number

getTime

  • getTime(): number

  • Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.

    Returns number

getTimezoneOffset

  • getTimezoneOffset(): number

  • Gets the difference in minutes between Universal Coordinated Time (UTC) and the time on the local computer.

    Returns number

getUTCDate

  • getUTCDate(): number

  • Gets the day-of-the-month, using Universal Coordinated Time (UTC).

    Returns number

getUTCDay

  • getUTCDay(): number

  • Gets the day of the week using Universal Coordinated Time (UTC).

    Returns number

getUTCFullYear

  • getUTCFullYear(): number

  • Gets the year using Universal Coordinated Time (UTC).

    Returns number

getUTCHours

  • getUTCHours(): number

  • Gets the hours value in a Date object using Universal Coordinated Time (UTC).

    Returns number

getUTCMilliseconds

  • getUTCMilliseconds(): number

  • Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).

    Returns number

getUTCMinutes

  • getUTCMinutes(): number

  • Gets the minutes of a Date object using Universal Coordinated Time (UTC).

    Returns number

getUTCMonth

  • getUTCMonth(): number

  • Gets the month of a Date object using Universal Coordinated Time (UTC).

    Returns number

getUTCSeconds

  • getUTCSeconds(): number

  • Gets the seconds of a Date object using Universal Coordinated Time (UTC).

    Returns number

setDate

  • setDate(date): number

  • Sets the numeric day-of-the-month value of the Date object using local time.

    Parameters

    • date: number

      A numeric value equal to the day of the month.

    Returns number

setFullYear

  • setFullYear(year, month?, date?): number

  • Sets the year of the Date object using local time.

    Parameters

    • year: number

      A numeric value for the year.

    • Optionalmonth: number

      A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified.

    • Optionaldate: number

      A numeric value equal for the day of the month.

    Returns number

setHours

  • setHours(hours, min?, sec?, ms?): number

  • Sets the hour value in the Date object using local time.

    Parameters

    • hours: number

      A numeric value equal to the hours value.

    • Optionalmin: number

      A numeric value equal to the minutes value.

    • Optionalsec: number

      A numeric value equal to the seconds value.

    • Optionalms: number

      A numeric value equal to the milliseconds value.

    Returns number

setMilliseconds

  • setMilliseconds(ms): number

  • Sets the milliseconds value in the Date object using local time.

    Parameters

    • ms: number

      A numeric value equal to the millisecond value.

    Returns number

setMinutes

  • setMinutes(min, sec?, ms?): number

  • Sets the minutes value in the Date object using local time.

    Parameters

    • min: number

      A numeric value equal to the minutes value.

    • Optionalsec: number

      A numeric value equal to the seconds value.

    • Optionalms: number

      A numeric value equal to the milliseconds value.

    Returns number

setMonth

  • setMonth(month, date?): number

  • Sets the month value in the Date object using local time.

    Parameters

    • month: number

      A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.

    • Optionaldate: number

      A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used.

    Returns number

setSeconds

  • setSeconds(sec, ms?): number

  • Sets the seconds value in the Date object using local time.

    Parameters

    • sec: number

      A numeric value equal to the seconds value.

    • Optionalms: number

      A numeric value equal to the milliseconds value.

    Returns number

setTime

  • setTime(time): number

  • Sets the date and time value in the Date object.

    Parameters

    • time: number

      A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT.

    Returns number

setUTCDate

  • setUTCDate(date): number

  • Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).

    Parameters

    • date: number

      A numeric value equal to the day of the month.

    Returns number

setUTCFullYear

  • setUTCFullYear(year, month?, date?): number

  • Sets the year value in the Date object using Universal Coordinated Time (UTC).

    Parameters

    • year: number

      A numeric value equal to the year.

    • Optionalmonth: number

      A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied.

    • Optionaldate: number

      A numeric value equal to the day of the month.

    Returns number

setUTCHours

  • setUTCHours(hours, min?, sec?, ms?): number

  • Sets the hours value in the Date object using Universal Coordinated Time (UTC).

    Parameters

    • hours: number

      A numeric value equal to the hours value.

    • Optionalmin: number

      A numeric value equal to the minutes value.

    • Optionalsec: number

      A numeric value equal to the seconds value.

    • Optionalms: number

      A numeric value equal to the milliseconds value.

    Returns number

setUTCMilliseconds

  • setUTCMilliseconds(ms): number

  • Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).

    Parameters

    • ms: number

      A numeric value equal to the millisecond value.

    Returns number

setUTCMinutes

  • setUTCMinutes(min, sec?, ms?): number

  • Sets the minutes value in the Date object using Universal Coordinated Time (UTC).

    Parameters

    • min: number

      A numeric value equal to the minutes value.

    • Optionalsec: number

      A numeric value equal to the seconds value.

    • Optionalms: number

      A numeric value equal to the milliseconds value.

    Returns number

setUTCMonth

  • setUTCMonth(month, date?): number

  • Sets the month value in the Date object using Universal Coordinated Time (UTC).

    Parameters

    • month: number

      A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.

    • Optionaldate: number

      A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used.

    Returns number

setUTCSeconds

  • setUTCSeconds(sec, ms?): number

  • Sets the seconds value in the Date object using Universal Coordinated Time (UTC).

    Parameters

    • sec: number

      A numeric value equal to the seconds value.

    • Optionalms: number

      A numeric value equal to the milliseconds value.

    Returns number

toDateString

  • toDateString(): string

  • Returns a date as a string value.

    Returns string

toISOString

  • toISOString(): string

  • Returns a date as a string value in ISO format.

    Returns string

toJSON

  • toJSON(key?): string

  • Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization.

    Parameters

    • Optionalkey: any

    Returns string

toLocaleDateString

  • toLocaleDateString(): string

  • Returns a date as a string value appropriate to the host environment's current locale.

    Returns string

  • toLocaleDateString(locales?, options?): string

  • Converts a date to a string by using the current or specified locale.

    Parameters

    • Optionallocales: string | string[]

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

    • Optionaloptions: DateTimeFormatOptions

      An object that contains one or more properties that specify comparison options.

    Returns string

  • toLocaleDateString(locales?, options?): string

  • Converts a date to a string by using the current or specified locale.

    Parameters

    • Optionallocales: LocalesArgument

      A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

    • Optionaloptions: DateTimeFormatOptions

      An object that contains one or more properties that specify comparison options.

    Returns string

toLocaleString

  • toLocaleString(): string

  • Returns a value as a string value appropriate to the host environment's current locale.

    Returns string

  • toLocaleString(locales?, options?): string

  • Converts a date and time to a string by using the current or specified locale.

    Parameters

    • Optionallocales: string | string[]

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

    • Optionaloptions: DateTimeFormatOptions

      An object that contains one or more properties that specify comparison options.

    Returns string

  • toLocaleString(locales?, options?): string

  • Converts a date and time to a string by using the current or specified locale.

    Parameters

    • Optionallocales: LocalesArgument

      A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

    • Optionaloptions: DateTimeFormatOptions

      An object that contains one or more properties that specify comparison options.

    Returns string

toLocaleTimeString

  • toLocaleTimeString(): string

  • Returns a time as a string value appropriate to the host environment's current locale.

    Returns string

  • toLocaleTimeString(locales?, options?): string

  • Converts a time to a string by using the current or specified locale.

    Parameters

    • Optionallocales: string | string[]

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

    • Optionaloptions: DateTimeFormatOptions

      An object that contains one or more properties that specify comparison options.

    Returns string

  • toLocaleTimeString(locales?, options?): string

  • Converts a time to a string by using the current or specified locale.

    Parameters

    • Optionallocales: LocalesArgument

      A locale string, array of locale strings, Intl.Locale object, or array of Intl.Locale objects that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

    • Optionaloptions: DateTimeFormatOptions

      An object that contains one or more properties that specify comparison options.

    Returns string

toString

  • toString(): string

  • Returns a string representation of a date. The format of the string depends on the locale.

    Returns string

toTai64

  • toTai64(): string

  • Returns the Tai64 timestamp.

    Returns string

    the Tai64 timestamp

toTimeString

  • toTimeString(): string

  • Returns a time as a string value.

    Returns string

toUTCString

  • toUTCString(): string

  • Returns a date converted to a string using Universal Coordinated Time (UTC).

    Returns string

toUnixMilliseconds

  • toUnixMilliseconds(): number

  • Returns number

    the unix milliseconds timestamp

toUnixSeconds

  • toUnixSeconds(): number

  • Returns number

    the unix seconds timestamp

valueOf

  • valueOf(): number

  • Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.

    Returns number

StaticUTC

  • UTC(year, monthIndex, date?, hours?, minutes?, seconds?, ms?): number

  • Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date.

    Parameters

    • year: number

      The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year.

    • monthIndex: number

      The month as a number between 0 and 11 (January to December).

    • Optionaldate: number

      The date as a number between 1 and 31.

    • Optionalhours: number

      Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour.

    • Optionalminutes: number

      Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes.

    • Optionalseconds: number

      Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds.

    • Optionalms: number

      A number from 0 to 999 that specifies the milliseconds.

    Returns number

  • UTC(year, monthIndex?, date?, hours?, minutes?, seconds?, ms?): number

  • Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date.

    Parameters

    • year: number

      The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year.

    • OptionalmonthIndex: number

      The month as a number between 0 and 11 (January to December).

    • Optionaldate: number

      The date as a number between 1 and 31.

    • Optionalhours: number

      Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour.

    • Optionalminutes: number

      Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes.

    • Optionalseconds: number

      Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds.

    • Optionalms: number

      A number from 0 to 999 that specifies the milliseconds.

    Returns number

StaticfromTai64

  • fromTai64(tai64): DateTime

  • Generates a new DateTime instance from a Tai64 timestamp.

    Parameters

    • tai64: string

      Tai64 timestamp

    Returns DateTime

    a new DateTime instance

StaticfromUnixMilliseconds

  • fromUnixMilliseconds(unixMilliseconds): DateTime

  • Parameters

    • unixMilliseconds: number

      unix milliseconds timestamp

    Returns DateTime

    a new DateTime instance

StaticfromUnixSeconds

  • fromUnixSeconds(unixSeconds): DateTime

  • Parameters

    • unixSeconds: number

      unix seconds timestamp

    Returns DateTime

    a new DateTime instance

Staticnow

  • now(): number

  • Returns the number of milliseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).

    Returns number

Staticparse

  • parse(s): number

  • Parses a string containing a date, and returns the number of milliseconds between that date and midnight, January 1, 1970.

    Parameters

    • s: string

      A date string

    Returns number

Settings

Member Visibility

On This Page

Properties
Methods