mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 01:41:50 +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.
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "DataSourceConstructor"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## DataSourceConstructor interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface DataSourceConstructor<DSType extends DataSourceApi<TQuery, TOptions>, TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { DataSourceConstructor } from '@grafana/data';
|
|
```
|
|
<b>Methods</b>
|
|
|
|
| Method | Description |
|
|
| --- | --- |
|
|
| [new(instanceSettings, args)](#new-instancesettingsargs) | |
|
|
|
|
### new(instanceSettings, args)
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
new (instanceSettings: DataSourceInstanceSettings<TOptions>, ...args: any[]): DSType;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| instanceSettings | <code>DataSourceInstanceSettings<TOptions></code> | |
|
|
| args | <code>any[]</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`DSType`
|
|
|