grafana/docs/sources/packages_api/data/datemath/parse.md

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "parse" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++

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): 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.

Returns:

DateTime | undefined