mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 17:32:42 +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.
90 lines
1.6 KiB
Markdown
90 lines
1.6 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "BuildInfo"
|
|
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## BuildInfo interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface BuildInfo
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { BuildInfo } from '@grafana/runtime';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [commit](#commit-property) | <code>string</code> | |
|
|
| [edition](#edition-property) | <code>string</code> | |
|
|
| [env](#env-property) | <code>string</code> | |
|
|
| [hasUpdate](#hasupdate-property) | <code>boolean</code> | |
|
|
| [isEnterprise](#isenterprise-property) | <code>boolean</code> | |
|
|
| [latestVersion](#latestversion-property) | <code>string</code> | |
|
|
| [version](#version-property) | <code>string</code> | |
|
|
|
|
### commit property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
commit: string;
|
|
```
|
|
|
|
### edition property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
edition: string;
|
|
```
|
|
|
|
### env property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
env: string;
|
|
```
|
|
|
|
### hasUpdate property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
hasUpdate: boolean;
|
|
```
|
|
|
|
### isEnterprise property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
isEnterprise: boolean;
|
|
```
|
|
|
|
### latestVersion property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
latestVersion: string;
|
|
```
|
|
|
|
### version property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
version: string;
|
|
```
|