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:
@@ -10,6 +10,8 @@ draft = true
|
||||
|
||||
## DataSourceWithBackend class
|
||||
|
||||
Extend this class to implement a data source plugin that is depending on the Grafana backend API.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
@@ -30,8 +32,12 @@ import { DataSourceWithBackend } from '@grafana/runtime';
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [query(request)](#query-method) | | Ideally final -- any other implementation would be wrong! |
|
||||
| [testDatasource()](#testdatasource-method) | | |
|
||||
| [applyTemplateVariables(query)](#applytemplatevariables-method) | | Override to apply template variables |
|
||||
| [callHealthCheck()](#callhealthcheck-method) | | Run the datasource healthcheck |
|
||||
| [getResource(path, params)](#getresource-method) | | Make a GET request to the datasource resource path |
|
||||
| [postResource(path, body)](#postresource-method) | | Send a POST request to the datasource resource path |
|
||||
| [query(request)](#query-method) | | Ideally final -- any other implementation may not work as expected |
|
||||
| [testDatasource()](#testdatasource-method) | | Checks the plugin health |
|
||||
| [toDataQueryResponse(rsp)](#todataqueryresponse-method) | | This makes the arrow library loading async. |
|
||||
|
||||
### constructor(instanceSettings)
|
||||
@@ -49,9 +55,82 @@ constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);
|
||||
| --- | --- | --- |
|
||||
| instanceSettings | <code>DataSourceInstanceSettings<TOptions></code> | |
|
||||
|
||||
### applyTemplateVariables method
|
||||
|
||||
Override to apply template variables
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
/** @virtual */
|
||||
applyTemplateVariables(query: DataQuery): DataQuery;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>DataQuery</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`DataQuery`
|
||||
|
||||
### callHealthCheck method
|
||||
|
||||
Run the datasource healthcheck
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
callHealthCheck(): Promise<HealthCheckResult>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<HealthCheckResult>`
|
||||
|
||||
### getResource method
|
||||
|
||||
Make a GET request to the datasource resource path
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getResource(path: string, params?: any): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| path | <code>string</code> | |
|
||||
| params | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### postResource method
|
||||
|
||||
Send a POST request to the datasource resource path
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
postResource(path: string, body?: any): Promise<any>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| path | <code>string</code> | |
|
||||
| body | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
### query method
|
||||
|
||||
Ideally final -- any other implementation would be wrong!
|
||||
Ideally final -- any other implementation may not work as expected
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
@@ -70,14 +149,16 @@ query(request: DataQueryRequest): Observable<DataQueryResponse>;
|
||||
|
||||
### testDatasource method
|
||||
|
||||
Checks the plugin health
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
testDatasource(): Promise<{}>;
|
||||
testDatasource(): Promise<any>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<{}>`
|
||||
`Promise<any>`
|
||||
|
||||
### toDataQueryResponse method
|
||||
|
||||
|
||||
Reference in New Issue
Block a user