Open Asterune
DateTime

DateTime

Represents an instant with Unix timestamp and calendar conversions.

Behavior

DateTime represents an instant with Unix timestamp and calendar conversions.

Summary

Constructors6
Functions6
  • DateTime.fromIsoDate(isoDate: string): DateTime?

    Parses an ISO date string.

  • DateTime.fromLocalTime(year: number?, month: number?, day: number?, hour: number?, minute: number?, second: number?, millisecond: number?): DateTime

    Creates a DateTime from local calendar fields.

  • DateTime.fromUniversalTime(year: number?, month: number?, day: number?, hour: number?, minute: number?, second: number?, millisecond: number?): DateTime

    Creates a DateTime from UTC calendar fields.

  • DateTime.fromUnixTimestamp(unixTimestamp: number): DateTime

    Creates a DateTime from seconds since the Unix epoch.

  • DateTime.fromUnixTimestampMillis(unixTimestampMillis: number): DateTime

    Creates a DateTime from milliseconds since the Unix epoch.

  • DateTime.now(): DateTime

    Returns the current date and time.

Members7
Properties2
Methods5

Constructors

fromIsoDate

DateTime.fromIsoDate(isoDate: string): DateTime?

Parses an ISO date string. Returns nil when the input cannot be parsed.

fromLocalTime

DateTime.fromLocalTime(year: number?, month: number?, day: number?, hour: number?, minute: number?, second: number?, millisecond: number?): DateTime

Creates a DateTime from local calendar fields.

fromUniversalTime

DateTime.fromUniversalTime(year: number?, month: number?, day: number?, hour: number?, minute: number?, second: number?, millisecond: number?): DateTime

Creates a DateTime from UTC calendar fields.

fromUnixTimestamp

DateTime.fromUnixTimestamp(unixTimestamp: number): DateTime

Creates a DateTime from seconds since the Unix epoch.

fromUnixTimestampMillis

DateTime.fromUnixTimestampMillis(unixTimestampMillis: number): DateTime

Creates a DateTime from milliseconds since the Unix epoch.

now

DateTime.now(): DateTime

Returns the current date and time.

Properties

UnixTimestamp

DateTime.UnixTimestamp: number

The time in seconds since the Unix epoch.

UnixTimestampMillis

DateTime.UnixTimestampMillis: number

The time in milliseconds since the Unix epoch.

Methods

Format

DateTime:Format(pattern: string): string

Formats the date and time using the supplied pattern.

ToIsoDate

DateTime:ToIsoDate(): string

Returns the date and time as an ISO-formatted string.

ToLocalTime

DateTime:ToLocalTime(): table

Returns local calendar fields as a table.

ToUniversalIsoDate

DateTime:ToUniversalIsoDate(): string

Returns the date and time as a UTC ISO-formatted string.

ToUniversalTime

DateTime:ToUniversalTime(): table

Returns UTC calendar fields as a table.

Operators

__eq · __le · __lt · __tostring · __type