API Reference@grafana/dataparse

dateMath.parse() function

dateMath.parse() function

Parses different types input to a moment instance. There is a specific formatting language that can be used if text arg is string. See unit tests for examples.

Signature

export declare function parse(text?: string | DateTime | Date | null, roundUp?: boolean, timezone?: TimeZone, fiscalYearStartMonth?: number): DateTime | undefined;

Import

import { dateMath } from '@grafana/data';
const { parse } = dateMath;

Parameters

ParameterTypeDescription
textstring | DateTime | Date | null
roundUpbooleanSee parseDateMath function.
timezoneTimeZoneOnly string ‘utc’ is acceptable here, for anything else, local timezone is used.
fiscalYearStartMonthnumber

Returns:

DateTime | undefined