mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 19:52:35 +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.5 KiB
2.5 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "DataSourceWithBackend" keywords = ["grafana","documentation","sdk","@grafana/runtime"] type = "docs" draft = true +++
DataSourceWithBackend class
Signature
export declare class DataSourceWithBackend<TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> extends DataSourceApi<TQuery, TOptions>
Import
import { DataSourceWithBackend } from '@grafana/runtime';
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| constructor(instanceSettings) | Constructs a new instance of the DataSourceWithBackend class |
Methods
| Method | Modifiers | Description |
|---|---|---|
| query(request) | Ideally final -- any other implementation would be wrong! | |
| testDatasource() | ||
| toDataQueryResponse(rsp) | This makes the arrow library loading async. |
constructor(instanceSettings)
Constructs a new instance of the DataSourceWithBackend class
Signature
constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);
Parameters
| Parameter | Type | Description |
|---|---|---|
| instanceSettings | DataSourceInstanceSettings<TOptions> |
query method
Ideally final -- any other implementation would be wrong!
Signature
query(request: DataQueryRequest): Observable<DataQueryResponse>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| request | DataQueryRequest |
Returns:
Observable<DataQueryResponse>
testDatasource method
Signature
testDatasource(): Promise<{}>;
Returns:
Promise<{}>
toDataQueryResponse method
This makes the arrow library loading async.
Signature
toDataQueryResponse(rsp: any): Promise<DataQueryResponse>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| rsp | any |
Returns:
Promise<DataQueryResponse>