mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 22:52:20 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
35 lines
1.3 KiB
Markdown
35 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"
|
|
draft = true
|
|
+++
|
|
|
|
## dateMath namespace
|
|
|
|
### dateMath namespace
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare namespace dateMath
|
|
```
|
|
<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. |
|
|
|