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. These interchangeable forms allow flexibility in how you structure expressions.

Function notation

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

Method notation

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

Arguments

Name	Type	Required	Description
interval	interval	true	The interval to format
scale	timeunit	false	The largest unit to display. Does not cascade into smaller units. Defaults to nano.

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
}

Example query

Function notation

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

Method notation

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

Example output

{
  "seconds_elapsed": "300s"
}