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.
1.8 KiB
1.8 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "LanguageProvider" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++
LanguageProvider class
Signature
export declare abstract class LanguageProvider
Import
import { LanguageProvider } from '@grafana/data';
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| datasource | DataSourceApi<any, any> |
||
| request | (url: string, params?: any) => Promise<any> |
||
| start | () => Promise<any[]> |
Returns startTask that resolves with a task list when main syntax is loaded. Task list consists of secondary promises that load more detailed language features. | |
| startTask | Promise<any[]> |
datasource property
Signature
abstract datasource: DataSourceApi<any, any>;
request property
Signature
abstract request: (url: string, params?: any) => Promise<any>;
start property
Returns startTask that resolves with a task list when main syntax is loaded. Task list consists of secondary promises that load more detailed language features.
Signature
abstract start: () => Promise<any[]>;
startTask property
Signature
startTask?: Promise<any[]>;