IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: exposing the getTimeZone function to be able to get the current selected timeZone. (#31900)

Browse Source
This commit is contained in:
Marcus Andersson
2021-03-11 22:24:49 +01:00
committed by GitHub
parent fe628c6282
commit 66e810a5aa
2 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
packages/grafana-data/src/datetime/common.ts
View File

@@ -1,19 +1,26 @@
import { TimeZone, DefaultTimeZone } from '../types/time';
/**
* Used for helper functions handling time zones.
*
* @public
*/
export interface TimeZoneOptions {
/**
* Specify this if you want to override the timeZone used when parsing or formatting
* a date and time value. If no timeZone is set, the default timeZone for the current
* user is used.
*/
timeZone?: TimeZone;
}
/**
* The type describing date and time options. Used for all the helper functions
* available to parse or format date and time values.
*
* @public
*/
export interface DateTimeOptions {
/**
* Specify this if you want to override the timeZone used when parsing or formatting
* a date and time value. If no timeZone is set, the default timeZone for the current
* user is used.
*/
timeZone?: TimeZone;
export interface DateTimeOptions extends TimeZoneOptions {
/**
* Specify a {@link https://momentjs.com/docs/#/displaying/format | momentjs} format to
* use a custom formatting pattern or parsing pattern. If no format is set,
@@ -43,11 +50,12 @@ export const setTimeZoneResolver = (resolver: TimeZoneResolver) => {
};
/**
* Used within this package to get timeZone from an options value. If timezone
* is not set in the options, then a default timeZone is be resolved instead.
* Used to get the current selected time zone. If a valid time zone is passed in the
* options it will be returned. If no valid time zone is passed either the time zone
* configured for the user account will be returned or the default for Grafana.
*
* @internal
* @public
*/
export const getTimeZone = <T extends DateTimeOptions>(options?: T): TimeZone => {
export const getTimeZone = <T extends TimeZoneOptions>(options?: T): TimeZone => {
return options?.timeZone ?? defaultTimeZoneResolver() ?? DefaultTimeZone;
};

2
packages/grafana-data/src/datetime/index.ts
View File

@@ -7,4 +7,4 @@ export * from './formats';
export * from './formatter';
export * from './parser';
export { dateMath, rangeUtil };
export { DateTimeOptions, setTimeZoneResolver, TimeZoneResolver } from './common';
export { DateTimeOptions, setTimeZoneResolver, TimeZoneResolver, getTimeZone } from './common';