docs-v2/content/v2.0/reference/flux/stdlib/date/truncate.md

1.1 KiB

title description aliases menu weight
date.truncate() function The `date.truncate()` function truncates a time to a specified unit.
/v2.0/reference/flux/functions/date/truncate/
v2_0_ref
name parent
date.truncate Date
301

The date.truncate() function truncates a time to a specified unit.

Function type: Transformation

import "date"

date.truncate(
  t: 2019-07-17T12:05:21.012Z
  unit: 1s
)

// Returns 2019-07-17T12:05:21.000000000Z

Parameters

t

The time to operate on.

Data type: Time

unit

The unit of time to truncate to.

Data type: Duration

{{% note %}} Only use 1 and the unit of time to specify the unit. For example: 1s, 1m, 1h. {{% /note %}}

Examples

import "date"

date.truncate(t: "2019-06-03T13:59:01.000000000Z", unit: 1s)
// Returns  2019-06-03T13:59:01.000000000Z

date.truncate(t: "2019-06-03T13:59:01.000000000Z", unit: 1m)
// Returns  2019-06-03T13:59:00.000000000Z

date.truncate(t: "2019-06-03T13:59:01.000000000Z", unit: 1h)
// Returns  2019-06-03T13:00:00.000000000Z