formatInterval

Description

Returns an interval rendered as a string, with optional control over which time unit is displayed.

Syntax

Like many functions in DataPrime, formatInterval supports two notations, function and method notation. These interchangeable forms allow flexibility in how you structure expressions.

formatInterval(interval: interval, scale?: timeunit): string

(interval: interval).formatInterval(scale?: timeunit): string

Arguments

Example

Use case: Render an interval in seconds

Even if the interval is 5 minutes, you may want to render it as 300s. Use the scale argument to specify seconds.

{
  "timestamp": 1728636298
}

choose formatInterval(now() - $m.timestamp, 'seconds') as seconds_elapsed

choose (now() - $m.timestamp).formatInterval('seconds') as seconds_elapsed

Output

{
  "seconds_elapsed": "300s"
}