mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 12:22:15 +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.
2.9 KiB
2.9 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "BackendSrv" keywords = ["grafana","documentation","sdk","@grafana/runtime"] type = "docs" draft = true +++
BackendSrv interface
Signature
export interface BackendSrv
Import
import { BackendSrv } from '@grafana/runtime';
Methods
| Method | Description |
|---|---|
| datasourceRequest(options) | |
| delete(url) | |
| get(url, params, requestId) | |
| patch(url, data) | |
| post(url, data) | |
| put(url, data) | |
| request(options) |
datasourceRequest method
Signature
datasourceRequest(options: BackendSrvRequest): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | BackendSrvRequest |
Returns:
Promise<any>
delete method
Signature
delete(url: string): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
Returns:
Promise<any>
get method
Signature
get(url: string, params?: any, requestId?: string): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
|
| params | any |
|
| requestId | string |
Returns:
Promise<any>
patch method
Signature
patch(url: string, data?: any): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
|
| data | any |
Returns:
Promise<any>
post method
Signature
post(url: string, data?: any): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
|
| data | any |
Returns:
Promise<any>
put method
Signature
put(url: string, data?: any): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
|
| data | any |
Returns:
Promise<any>
request method
Signature
request(options: BackendSrvRequest): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | BackendSrvRequest |
Returns:
Promise<any>