Files
grafana/docs/sources/packages_api/data/dataqueryerror.md
Marcus Andersson 6bc369629d 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

84 lines
1.6 KiB
Markdown

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DataQueryError"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
draft = true
+++
## DataQueryError interface
<b>Signature</b>
```typescript
export interface DataQueryError
```
<b>Import</b>
```typescript
import { DataQueryError } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [cancelled](#cancelled-property) | <code>boolean</code> | |
| [data](#data-property) | <code>{</code><br/><code> message?: string;</code><br/><code> error?: string;</code><br/><code> }</code> | |
| [message](#message-property) | <code>string</code> | |
| [refId](#refid-property) | <code>string</code> | |
| [status](#status-property) | <code>string</code> | |
| [statusText](#statustext-property) | <code>string</code> | |
### cancelled property
<b>Signature</b>
```typescript
cancelled?: boolean;
```
### data property
<b>Signature</b>
```typescript
data?: {
message?: string;
error?: string;
};
```
### message property
<b>Signature</b>
```typescript
message?: string;
```
### refId property
<b>Signature</b>
```typescript
refId?: string;
```
### status property
<b>Signature</b>
```typescript
status?: string;
```
### statusText property
<b>Signature</b>
```typescript
statusText?: string;
```