datetime

Functions for date and time manipulation.

Summary

datetime	Functions for date and time manipulation.
Types
Instant	Represents a particular instant in global time.
DateTime	Represents a particular instant in global time, broken down to components in UTC.
Interval	Represents a time period between a start and an end time.
Duration	Represents a specific amount of time measured in seconds.
Period	Represents an amount of time measured by components.
Functions
now	Return the current timestamp as a DateTime.
makeFromInstant	Convert a specific instant into a DateTime record.
makeFromParts	Given timestamp parts, return a DateTime representing the instant.
makeFromString	Make a DateTime from a string representation.
DateTime.minusDuration	Subtract a Duration from a DateTime and return a new DateTime.
DateTime.minusPeriod	Subtract a Period from a DateTime and return a new DateTime.
DateTime.plusDuration	Add a Duration to a DateTime and return a new DateTime.
DateTime.plusPeriod	Add a Period to a DateTime and return a new DateTime.
DateTime.toString	Return an ISO 8601 formatted representation of a DateTime.
DateTime.withDate	Return a new DateTime with the given year, month, and day based on an existing DateTime.
DateTime.withYear	Return a new DateTime with the given year based on an existing DateTime.
DateTime.withMonth	Return a new DateTime with the given month based on an existing DateTime.
DateTime.withDay	Return a new DateTime with the given day based on an existing DateTime.
DateTime.withTime	Return a new DateTime with the given hour, minute, and second based on an existing DateTime.
DateTime.withHour	Return a new DateTime with the given hour based on an existing DateTime.
DateTime.withMinute	Return a new DateTime with the given minute based on an existing DateTime.
DateTime.withSecond	Return a new DateTime with the given second based on an existing DateTime.

Types

Instant

Represents a particular instant in global time.

DateTime

Represents a particular instant in global time, broken down to components in UTC.

Fields

year	year
month	month (1=January, 12=December)
day	day
weekday	weekday (1=Monday, 7=Sunday)
hour	hour
minute	minute
second	second

Interval

Represents a time period between a start and an end time.

Fields

start	start
end	end

Duration

Represents a specific amount of time measured in seconds.

Period

Represents an amount of time measured by components.

Fields

years	years
months	months
days	days
hours	hours
minutes	minutes
seconds	seconds

Functions

now

FUNCTION now(): DateTime

Return the current timestamp as a DateTime.

makeFromInstant

FUNCTION makeFromInstant( inst: Instant ): DateTime

Convert a specific instant into a DateTime record.

makeFromParts

FUNCTION makeFromParts( dt: DateTime ): DateTime

Given timestamp parts, return a DateTime representing the instant. This function must be called after filling in an empty DateTime.

makeFromString

FUNCTION makeFromString( s: String ): DateTime

Make a DateTime from a string representation.

DateTime.minusDuration

FUNCTION DateTime.minusDuration( self: DateTime,
duration: Duration ): DateTime

Subtract a Duration from a DateTime and return a new DateTime.

DateTime.minusPeriod

FUNCTION DateTime.minusPeriod( self: DateTime,
period: Period ): DateTime

Subtract a Period from a DateTime and return a new DateTime.

DateTime.plusDuration

FUNCTION DateTime.plusDuration( self: DateTime,
duration: Duration ): DateTime

Add a Duration to a DateTime and return a new DateTime.

DateTime.plusPeriod

FUNCTION DateTime.plusPeriod( self: DateTime,
period: Period ): DateTime

Add a Period to a DateTime and return a new DateTime.

DateTime.toString

FUNCTION DateTime.toString( self: DateTime ): String

Return an ISO 8601 formatted representation of a DateTime.

DateTime.withDate

FUNCTION DateTime.withDate( self: DateTime,
year,
month,
day: Number ): DateTime

Return a new DateTime with the given year, month, and day based on an existing DateTime.

DateTime.withYear

FUNCTION DateTime.withYear( self: DateTime,
year: Number ): DateTime

Return a new DateTime with the given year based on an existing DateTime.

DateTime.withMonth

FUNCTION DateTime.withMonth( self: DateTime,
month: Number ): DateTime

Return a new DateTime with the given month based on an existing DateTime.

DateTime.withDay

FUNCTION DateTime.withDay( self: DateTime,
day: Number ): DateTime

Return a new DateTime with the given day based on an existing DateTime.

DateTime.withTime

FUNCTION DateTime.withTime( self: DateTime,
hour,
minute,
second: Number ): DateTime

Return a new DateTime with the given hour, minute, and second based on an existing DateTime.

DateTime.withHour

FUNCTION DateTime.withHour( self: DateTime,
hour: Number ): DateTime

Return a new DateTime with the given hour based on an existing DateTime.

DateTime.withMinute

FUNCTION DateTime.withMinute( self: DateTime,
minute: Number ): DateTime

Return a new DateTime with the given minute based on an existing DateTime.

DateTime.withSecond

FUNCTION DateTime.withSecond( self: DateTime,
second: Number ): DateTime

Return a new DateTime with the given second based on an existing DateTime.