Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana/v8.4/packages_api/data/datemath/parse.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana/v8.4/packages_api/data/datemath/parse/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
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
| Parameter | Type | Description |
|---|---|---|
| text | string | DateTime | Date | null | |
| roundUp | boolean | See parseDateMath function. |
| timezone | TimeZone | Only string ‘utc’ is acceptable here, for anything else, local timezone is used. |
| fiscalYearStartMonth | number |
Returns:
DateTime | undefined