Docs: run the api-extractor on master to update docs (#23726)
* regenerated packages docs. * fixed spelling issues. * fixed spelling issues.
This commit is contained in:
@@ -24,19 +24,54 @@ import { QueryResultMeta } from '@grafana/data';
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [custom](#custom-property) | <code>Record<string, any></code> | |
|
||||
| [alignmentPeriod](#alignmentperiod-property) | <code>string</code> | |
|
||||
| [custom](#custom-property) | <code>Record<string, any></code> | DatasSource Specific Values |
|
||||
| [gmdMeta](#gmdmeta-property) | <code>any[]</code> | Legacy data source specific, should be moved to custom |
|
||||
| [json](#json-property) | <code>boolean</code> | |
|
||||
| [limit](#limit-property) | <code>number</code> | |
|
||||
| [requestId](#requestid-property) | <code>string</code> | |
|
||||
| [notices](#notices-property) | <code>QueryResultMetaNotice[]</code> | Meta Notices |
|
||||
| [query](#query-property) | <code>string</code> | |
|
||||
| [rawQuery](#rawquery-property) | <code>string</code> | |
|
||||
| [searchWords](#searchwords-property) | <code>string[]</code> | |
|
||||
| [stats](#stats-property) | <code>QueryResultMetaStat[]</code> | Stats |
|
||||
| [transformations](#transformations-property) | <code>string[]</code> | Used to track transformation ids that where part of the processing |
|
||||
|
||||
### alignmentPeriod property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alignmentPeriod?: string;
|
||||
```
|
||||
|
||||
### custom property
|
||||
|
||||
DatasSource Specific Values
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
custom?: Record<string, any>;
|
||||
```
|
||||
|
||||
### gmdMeta property
|
||||
|
||||
Legacy data source specific, should be moved to custom
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
gmdMeta?: any[];
|
||||
```
|
||||
|
||||
### json property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
json?: boolean;
|
||||
```
|
||||
|
||||
### limit property
|
||||
|
||||
<b>Signature</b>
|
||||
@@ -45,12 +80,30 @@ custom?: Record<string, any>;
|
||||
limit?: number;
|
||||
```
|
||||
|
||||
### requestId property
|
||||
### notices property
|
||||
|
||||
Meta Notices
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
requestId?: string;
|
||||
notices?: QueryResultMetaNotice[];
|
||||
```
|
||||
|
||||
### query property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
query?: string;
|
||||
```
|
||||
|
||||
### rawQuery property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
rawQuery?: string;
|
||||
```
|
||||
|
||||
### searchWords property
|
||||
@@ -60,3 +113,23 @@ requestId?: string;
|
||||
```typescript
|
||||
searchWords?: string[];
|
||||
```
|
||||
|
||||
### stats property
|
||||
|
||||
Stats
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
stats?: QueryResultMetaStat[];
|
||||
```
|
||||
|
||||
### transformations property
|
||||
|
||||
Used to track transformation ids that where part of the processing
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
transformations?: string[];
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user