79 lines
1.5 KiB
Markdown
79 lines
1.5 KiB
Markdown
---
|
|
title: date.truncate() function
|
|
description: >
|
|
The `date.truncate()` function truncates a time to a specified unit.
|
|
aliases:
|
|
- /v2.0/reference/flux/functions/date/truncate/
|
|
menu:
|
|
v2_0_ref:
|
|
name: date.truncate
|
|
parent: Date
|
|
weight: 301
|
|
---
|
|
|
|
The `date.truncate()` function truncates a time to a specified unit.
|
|
|
|
_**Function type:** Transformation_
|
|
|
|
```js
|
|
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.
|
|
Use an absolute time or relative duration.
|
|
Durations are relative to `now()`.
|
|
|
|
_**Data type:** Time | Duration_
|
|
|
|
### 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
|
|
|
|
##### Truncate time values
|
|
```js
|
|
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
|
|
```
|
|
|
|
##### Truncate time values using durations
|
|
```js
|
|
import "date"
|
|
|
|
option now = () => 2020-01-01T00:00:30.500000000Z
|
|
|
|
date.truncate(t: -30s, unit: 1s)
|
|
// Returns 2019-12-31T23:59:30.000000000Z
|
|
|
|
date.truncate(t: -1m, unit: 1m)
|
|
// Returns 2019-12-31T23:59:00.000000000Z
|
|
|
|
date.truncate(t: -1h, unit: 1h)
|
|
// Returns 2019-12-31T23:00:00.000000000Z
|
|
```
|