mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 08:52:38 +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.
156 lines
3.1 KiB
Markdown
156 lines
3.1 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "Registry"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## Registry class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class Registry<T extends RegistryItem>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { Registry } from '@grafana/data';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [constructor(init)](#constructor-init) | | Constructs a new instance of the <code>Registry</code> class |
|
|
|
|
<b>Properties</b>
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [setInit](#setinit-property) | | <code>(init: () => T[]) => void</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [get(id)](#get-method) | | |
|
|
| [getIfExists(id)](#getifexists-method) | | |
|
|
| [list(ids)](#list-method) | | Return a list of values by ID, or all values if not specified |
|
|
| [register(ext)](#register-method) | | |
|
|
| [selectOptions(current, filter)](#selectoptions-method) | | |
|
|
|
|
### constructor(init)
|
|
|
|
Constructs a new instance of the `Registry` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor(init?: (() => T[]) | undefined);
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| init | <code>(() => T[]) | undefined</code> | |
|
|
|
|
### setInit property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
setInit: (init: () => T[]) => void;
|
|
```
|
|
|
|
### get method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
get(id: string): T;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| id | <code>string</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`T`
|
|
|
|
### getIfExists method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
getIfExists(id: string | undefined): T | undefined;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| id | <code>string | undefined</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`T | undefined`
|
|
|
|
### list method
|
|
|
|
Return a list of values by ID, or all values if not specified
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
list(ids?: any[]): T[];
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| ids | <code>any[]</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`T[]`
|
|
|
|
### register method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
register(ext: T): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| ext | <code>T</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### selectOptions method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
selectOptions(current?: string[], filter?: (ext: T) => boolean): RegistrySelectInfo;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| current | <code>string[]</code> | |
|
|
| filter | <code>(ext: T) => boolean</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`RegistrySelectInfo`
|
|
|