grafana/docs/sources/packages_api/data/datemath.md
Marcus Andersson cc3fc18076
Docs: enable packages reference docs for 7-beta (#23953)
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
2020-04-28 09:53:58 +02:00

32 lines
1.3 KiB
Markdown

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "dateMath"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## dateMath namespace
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
### dateMath namespace
<b>Import</b>
```typescript
import { dateMath } from '@grafana/data';
```
## Functions
| Function | Description |
| --- | --- |
| [isMathString(text)](./ismathstring/) | |
| [isValid(text)](./isvalid/) | Checks if text is a valid date which in this context means that it is either a Moment instance or it can be parsed by parse function. See parse function to see what is considered acceptable. |
| [parse(text, roundUp, timezone)](./parse/) | 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. |
| [parseDateMath(mathString, time, roundUp)](./parsedatemath/) | Parses math part of the time string and shifts supplied time according to that math. See unit tests for examples. |