public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions 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
docs/sources/packages_api/runtime/backendsrv.md
+12 -1
View File
@@ -10,6 +10,10 @@ draft = true
## BackendSrv interface
Used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. The BackendSrv is using the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) under the hood to handle all the communication.
The request function can be used to perform a remote call by specifying a [BackendSrvRequest](./runtime/backendsrvrequest.md)<!-- -->. To make the BackendSrv a bit easier to use we have added a couple of shorthand functions that will use default values executing the request.
<b>Signature</b>
```typescript
@@ -20,11 +24,16 @@ export interface BackendSrv
```typescript
import { BackendSrv } from '@grafana/runtime';
```
## Remarks
By default Grafana will display an error message alert if the remote call fails. If you want to prevent this from happending you need to catch the error thrown by the BackendSrv and set the `isHandled = true` on the incoming error.
<b>Methods</b>
| Method | Description |
| --- | --- |
| [datasourceRequest(options)](#datasourcerequest-method) | |
| [datasourceRequest(options)](#datasourcerequest-method) | Special function used to communicate with datasources that will emit core events that the Grafana QueryInspector and QueryEditor is listening for to be able to display datasource query information. Can be skipped by adding <code>option.silent</code> when initializing the request. |
| [delete(url)](#delete-method) | |
| [get(url, params, requestId)](#get-method) | |
| [patch(url, data)](#patch-method) | |
@@ -34,6 +43,8 @@ import { BackendSrv } from '@grafana/runtime';
### datasourceRequest method
Special function used to communicate with datasources that will emit core events that the Grafana QueryInspector and QueryEditor is listening for to be able to display datasource query information. Can be skipped by adding `option.silent` when initializing the request.
<b>Signature</b>
```typescript