grafana/docs/sources/packages_api/data/datemath/parsedatemath.md
Marcus Andersson a2d741f60f
Docs: run the api-extractor on master to update docs (#23726)
* regenerated packages docs.

* fixed spelling issues.

* fixed spelling issues.
2020-04-21 10:41:50 +02:00

1.1 KiB

+++

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

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

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

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

dateMath.parseDateMath() function

dateMath.parseDateMath() function

Parses math part of the time string and shifts supplied time according to that math. See unit tests for examples.

Signature

export declare function parseDateMath(mathString: string, time: any, roundUp?: boolean): DateTime | undefined;

Import

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

Parameters

Parameter Type Description
mathString string
time any
roundUp boolean If true it will round the time to endOf time unit, otherwise to startOf time unit.

Returns:

DateTime | undefined