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.
3.1 KiB
3.1 KiB
+++
-----------------------------------------------------------------------
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
Signature
export declare class Registry<T extends RegistryItem>
Import
import { Registry } from '@grafana/data';
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| constructor(init) | Constructs a new instance of the Registry class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| setInit | (init: () => T[]) => void |
Methods
| Method | Modifiers | Description |
|---|---|---|
| get(id) | ||
| getIfExists(id) | ||
| list(ids) | Return a list of values by ID, or all values if not specified | |
| register(ext) | ||
| selectOptions(current, filter) |
constructor(init)
Constructs a new instance of the Registry class
Signature
constructor(init?: (() => T[]) | undefined);
Parameters
| Parameter | Type | Description |
|---|---|---|
| init | (() => T[]) | undefined |
setInit property
Signature
setInit: (init: () => T[]) => void;
get method
Signature
get(id: string): T;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string |
Returns:
T
getIfExists method
Signature
getIfExists(id: string | undefined): T | undefined;
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | undefined |
Returns:
T | undefined
list method
Return a list of values by ID, or all values if not specified
Signature
list(ids?: any[]): T[];
Parameters
| Parameter | Type | Description |
|---|---|---|
| ids | any[] |
Returns:
T[]
register method
Signature
register(ext: T): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| ext | T |
Returns:
void
selectOptions method
Signature
selectOptions(current?: string[], filter?: (ext: T) => boolean): RegistrySelectInfo;
Parameters
| Parameter | Type | Description |
|---|---|---|
| current | string[] |
|
| filter | (ext: T) => boolean |
Returns:
RegistrySelectInfo