mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 12:32:43 +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.0 KiB
2.0 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "DataQueryResponse" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
DataQueryResponse interface
Signature
export interface DataQueryResponse
Import
import { DataQueryResponse } from '@grafana/data';
Properties
| Property | Type | Description |
|---|---|---|
| data | DataQueryResponseData[] |
The response data. When streaming, this may be empty or a partial result set |
| error | DataQueryError |
Optionally include error info along with the response data |
| key | string |
When returning multiple partial responses or streams Use this key to inform Grafana how to combine the partial responses Multiple responses with same key are replaced (latest used) |
| state | LoadingState |
Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined |
data property
The response data. When streaming, this may be empty or a partial result set
Signature
data: DataQueryResponseData[];
error property
Optionally include error info along with the response data
Signature
error?: DataQueryError;
key property
When returning multiple partial responses or streams Use this key to inform Grafana how to combine the partial responses Multiple responses with same key are replaced (latest used)
Signature
key?: string;
state property
Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined
Signature
state?: LoadingState;