Docs: fixing link issues in auto generated frontend docs. (#29326)

* updating api-documenter package and fixed failed link.

* added documentation for matcher code.

* decreasing number of lint errors.
This commit is contained in:
Marcus Andersson
2020-11-25 08:54:42 +01:00
committed by GitHub
parent f7567f2266
commit e4f465929d
5 changed files with 31 additions and 60 deletions
@@ -12,6 +12,10 @@ import {
} from '../types/transformations';
import { Registry } from '../utils/Registry';
/**
* Registry that contains all of the built in field matchers.
* @public
*/
export const fieldMatchers = new Registry<FieldMatcherInfo>(() => {
return [
...getFieldPredicateMatchers(), // Predicates
@@ -20,6 +24,10 @@ export const fieldMatchers = new Registry<FieldMatcherInfo>(() => {
];
});
/**
* Registry that contains all of the built in frame matchers.
* @public
*/
export const frameMatchers = new Registry<FrameMatcherInfo>(() => {
return [
...getFramePredicateMatchers(), // Predicates
@@ -28,6 +36,11 @@ export const frameMatchers = new Registry<FrameMatcherInfo>(() => {
];
});
/**
* Resolves a field matcher from the registry for given config.
* Will throw an error if matcher can not be resolved.
* @public
*/
export function getFieldMatcher(config: MatcherConfig): FieldMatcher {
const info = fieldMatchers.get(config.id);
if (!info) {
@@ -36,6 +49,11 @@ export function getFieldMatcher(config: MatcherConfig): FieldMatcher {
return info.get(config.options);
}
/**
* Resolves a frame matcher from the registry for given config.
* Will throw an error if matcher can not be resolved.
* @public
*/
export function getFrameMatchers(config: MatcherConfig): FrameMatcher {
const info = frameMatchers.get(config.id);
if (!info) {
@@ -64,7 +64,7 @@ export interface DataRequestEventPayload extends DataRequestInfo {
export type MetaAnalyticsEventPayload = DashboardViewEventPayload | DataRequestEventPayload;
/**
* Describes meta analytics event with predefined {@link EchoEventType.MetaAnalytics} type.
* Describes meta analytics event with predefined {@link EchoEventType.EchoEventType} type.
*
* @public
*/