date.add() function

date.add() adds a duration to a time value and returns the resulting time value.

Function type signature

(d: duration, to: A, ?location: {zone: string, offset: duration}) => time where A: Timeable

Parameters

d

(Required) Duration to add.

to

(Required) Time to add the duration to.

location

Location to use for the time value.

Use an absolute time or a relative duration. Durations are relative to now().

Examples

• Add six hours to a timestamp
• Add one month to yesterday
• Add six hours to a relative duration

Add six hours to a timestamp

import "date"

date.add(d: 6h, to: 2019-09-16T12:00:00Z)// Returns 2019-09-16T18:00:00.000000000Z

Add one month to yesterday

A time may be represented as either an explicit timestamp or as a relative time from the current now time. add can support either type of value.

import "date"

option now = () => 2021-12-10T16:27:40Z

date.add(d: 1mo, to: -1d)// Returns 2022-01-09T16:27:40Z

Add six hours to a relative duration

import "date"

option now = () => 2022-01-01T12:00:00Z

date.add(d: 6h, to: 3h)// Returns 2022-01-01T21:00:00.000000000Z