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.5 KiB
2.5 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "@grafana/runtime" keywords = ["grafana","documentation","sdk","@grafana/runtime"] type = "docs" draft = true +++
@grafana/runtime package
A library containing services, configurations etc. used to interact with the Grafana engine.
Classes
| Class | Description |
|---|---|
| DataSourceWithBackend | |
| GrafanaBootConfig |
Enumerations
| Enumeration | Description |
|---|---|
| EchoEventType |
Functions
Interfaces
| Interface | Description |
|---|---|
| AngularComponent | |
| AngularLoader | |
| BackendSrv | |
| BuildInfo | |
| DataSourceSrv | |
| EchoBackend | |
| EchoEvent | |
| EchoMeta | |
| EchoSrv | |
| LocationSrv | |
| LocationUpdate | |
| MetaAnalyticsEvent | |
| MetaAnalyticsEventPayload |
Variables
| Variable | Description |
|---|---|
| config | |
| getBackendSrv | |
| registerEchoBackend | |
| reportMetaAnalytics | |
| setBackendSrv | |
| SystemJS |
Type Aliases
| Type Alias | Description |
|---|---|
| BackendSrvRequest | Currently implemented with: https://docs.angularjs.org/api/ng/service/$http#usage but that will likely change in the future |
| UrlQueryMap | |
| UrlQueryValue |