Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cdktf: update documentation #389

Merged
merged 1 commit into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions docs/cdktf/python/functions/duration_parse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
page_title: "duration_parse function - terraform-provider-time"
subcategory: ""
description: |-
Parse a Go duration string https://pkg.go.dev/time#ParseDuration into an object
---


<!-- Please do not edit this file, it is generated. -->
# function: duration_parse

Given a [Go duration string](https://pkg.go.dev/time#ParseDuration), will parse and return an object representation of that duration.

## Example Usage

```terraform
# Configuration using provider functions must include required_providers configuration.
terraform {
required_providers {
time = {
source = "hashicorp/time"
# Setting the provider version is a strongly recommended practice
# version = "..."
}
}
# Provider functions require Terraform 1.8 and later.
required_version = ">= 1.8.0"
}

output "example_output" {
value = provider::time::duration_parse("1h")
}
```

## Signature

<!-- signature generated by tfplugindocs -->
```text
duration_parse(duration string) object
```

## Arguments

<!-- arguments generated by tfplugindocs -->
1. `duration` (String) Go time package duration string to parse


## Return Type

The `object` returned from `duration_parse` has the following attributes:
- `hours` (Number) The duration as a floating point number of hours.
- `minutes` (Number) The duration as a floating point number of minutes.
- `seconds` (Number) The duration as a floating point number of seconds.
- `milliseconds` (Number) The duration as an integer number of milliseconds.
- `microseconds` (Number) The duration as an integer number of microseconds.
- `nanoseconds` (Number) The duration as an integer number of nanoseconds.

<!-- cache-key: cdktf-0.20.8 input-66898324acac2fb949e3bf64d2de78df844e2156cccb3c8e6df146c3383d2c9b -->
58 changes: 58 additions & 0 deletions docs/cdktf/typescript/functions/duration_parse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
page_title: "duration_parse function - terraform-provider-time"
subcategory: ""
description: |-
Parse a Go duration string https://pkg.go.dev/time#ParseDuration into an object
---


<!-- Please do not edit this file, it is generated. -->
# function: duration_parse

Given a [Go duration string](https://pkg.go.dev/time#ParseDuration), will parse and return an object representation of that duration.

## Example Usage

```terraform
# Configuration using provider functions must include required_providers configuration.
terraform {
required_providers {
time = {
source = "hashicorp/time"
# Setting the provider version is a strongly recommended practice
# version = "..."
}
}
# Provider functions require Terraform 1.8 and later.
required_version = ">= 1.8.0"
}

output "example_output" {
value = provider::time::duration_parse("1h")
}
```

## Signature

<!-- signature generated by tfplugindocs -->
```text
duration_parse(duration string) object
```

## Arguments

<!-- arguments generated by tfplugindocs -->
1. `duration` (String) Go time package duration string to parse


## Return Type

The `object` returned from `duration_parse` has the following attributes:
- `hours` (Number) The duration as a floating point number of hours.
- `minutes` (Number) The duration as a floating point number of minutes.
- `seconds` (Number) The duration as a floating point number of seconds.
- `milliseconds` (Number) The duration as an integer number of milliseconds.
- `microseconds` (Number) The duration as an integer number of microseconds.
- `nanoseconds` (Number) The duration as an integer number of nanoseconds.

<!-- cache-key: cdktf-0.20.8 input-66898324acac2fb949e3bf64d2de78df844e2156cccb3c8e6df146c3383d2c9b -->
Loading