docs-v2/content/flux/v0.x/stdlib/timezone/location.md

title	description	menu	weight	flux/v0.x/tags
timezone.location() function	`timezone.location()` returns a location record based on a location or timezone name.	flux_0_x_ref name parent identifier timezone.location timezone timezone/location	101	date/time location

timezone.location() returns a location record based on a location or timezone name.

Function type signature

(name: string) => {zone: string, offset: duration}

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

Parameters

name

({{< req >}}) Location name (as defined by your operating system timezone database).

Examples

• Return a timezone-based location record
• Set the location option using a timezone-based location

Return a timezone-based location record

import "timezone"

timezone.location(name: "America/Los_Angeles")// Returns {offset: 0ns, zone: "America/Los_Angeles"}

Set the location option using a timezone-based location

import "timezone"

option location = timezone.location(name: "America/Los_Angeles")