docs-v2/content/flux/v0/stdlib/experimental/subduration.md

title	description	menu	weight	flux/v0/tags	introduced	deprecated
experimental.subDuration() function	`experimental.subDuration()` subtracts a duration from a time value and returns the resulting time value.	flux_v0_ref name parent identifier experimental.subDuration experimental experimental/subDuration	101	date/time	0.39.0	0.162.0

experimental.subDuration() subtracts a duration from a time value and returns the resulting time value.

{{% warn %}}

Deprecated

experimental.subDuration() is deprecated in favor of date.sub(). {{% /warn %}}

Function type signature

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

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

from

({{< req >}}) Time to subtract the duration from.

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

d

({{< req >}}) Duration to subtract.

location

Location to use for the time value.

Examples

• Subtract six hours from a timestamp
• Subtract six hours from a relative duration
• Subtract two days from one hour ago

Subtract six hours from a timestamp

import "experimental"

experimental.subDuration(from: 2019-09-16T12:00:00Z, d: 6h)// Returns 2019-09-16T06:00:00.000000000Z

Subtract six hours from a relative duration

import "experimental"

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

experimental.subDuration(d: 6h, from: -3h)// Returns 2022-01-01T03:00:00.000000000Z

Subtract two days from one hour ago

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

import "experimental"

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

experimental.subDuration(from: -1h, d: 2d)// Returns 2021-12-08T15:27:40Z