opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 19:52:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: run the api-extractor on master to update docs (#23726)

Browse Source 
* regenerated packages docs.

* fixed spelling issues.

* fixed spelling issues.
This commit is contained in:
Marcus Andersson
2020-04-21 10:41:50 +02:00
committed by GitHub
parent 017767ae39
commit a2d741f60f
275 changed files with 6448 additions and 2193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/packages_api/data/datemath/ismathstring.md
View File

@ -15,7 +15,7 @@ draft = true
<b>Signature</b>
```typescript
function isMathString(text: string | DateTime | Date): boolean;
export declare function isMathString(text: string | DateTime | Date): boolean;
```
<b>Import</b>

2
docs/sources/packages_api/data/datemath/isvalid.md
View File

@ -17,7 +17,7 @@ Checks if text is a valid date which in this context means that it is either a M
<b>Signature</b>
```typescript
function isValid(text: string | DateTime): boolean;
export declare function isValid(text: string | DateTime): boolean;
```
<b>Import</b>

8
docs/sources/packages_api/data/datemath/parse.md
View File

@ -17,7 +17,7 @@ Parses different types input to a moment instance. There is a specific formattin
<b>Signature</b>
```typescript
function parse(text: string | DateTime | Date, roundUp?: boolean, timezone?: TimeZone): DateTime | undefined;
export declare function parse(text?: string | DateTime | Date | null, roundUp?: boolean, timezone?: TimeZone): DateTime | undefined;
```
<b>Import</b>
@ -29,9 +29,9 @@ const { parse } = dateMath;
| Parameter | Type | Description |
| --- | --- | --- |
| text | <code>string &#124; DateTime &#124; Date</code> | |
| roundUp | <code>boolean</code> | |
| timezone | <code>TimeZone</code> | |
| text | <code>string &#124; DateTime &#124; Date &#124; null</code> | |
| roundUp | <code>boolean</code> | See parseDateMath function. |
| timezone | <code>TimeZone</code> | Only string 'utc' is acceptable here, for anything else, local timezone is used. |
<b>Returns:</b>

4
docs/sources/packages_api/data/datemath/parsedatemath.md
View File

@ -17,7 +17,7 @@ Parses math part of the time string and shifts supplied time according to that m
<b>Signature</b>
```typescript
function parseDateMath(mathString: string, time: any, roundUp?: boolean): DateTime | undefined;
export declare function parseDateMath(mathString: string, time: any, roundUp?: boolean): DateTime | undefined;
```
<b>Import</b>
@ -31,7 +31,7 @@ const { parseDateMath } = dateMath;
| --- | --- | --- |
| mathString | <code>string</code> | |
| time | <code>any</code> | |
| roundUp | <code>boolean</code> | |
| roundUp | <code>boolean</code> | If true it will round the time to endOf time unit, otherwise to startOf time unit. |
<b>Returns:</b>