Docs: adding first version of the auto-generated packages API docs. (#22107)

* 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.
2020-02-26 10:03:53 +01:00
parent 89e6c45090
commit 6bc369629d
594 changed files with 30265 additions and 1 deletions
@@ -0,0 +1,70 @@
+++
+# -----------------------------------------------------------------------
+# 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
+
+<b>Signature</b>
+
+```typescript
+export interface DataQueryResponse 
+```
+<b>Import</b>
+
+```typescript
+import { DataQueryResponse } from '@grafana/data';
+```
+<b>Properties</b>
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [data](#data-property) | <code>DataQueryResponseData[]</code> | The response data. When streaming, this may be empty or a partial result set |
+|  [error](#error-property) | <code>DataQueryError</code> | Optionally include error info along with the response data |
+|  [key](#key-property) | <code>string</code> | 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](#state-property) | <code>LoadingState</code> | 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
+
+<b>Signature</b>
+
+```typescript
+data: DataQueryResponseData[];
+```
+
+### error property
+
+Optionally include error info along with the response data
+
+<b>Signature</b>
+
+```typescript
+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)
+
+<b>Signature</b>
+
+```typescript
+key?: string;
+```
+
+### state property
+
+Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined
+
+<b>Signature</b>
+
+```typescript
+state?: LoadingState;
+```