UNPKG

@report-toolkit/transformers

Version:

See docs at [https://ibm.github.io/report-toolkit](https://ibm.github.io/report-toolkit)

51 lines (50 loc) 1.88 kB
/** * @type {Readonly<string[]>} */ export const builtinTransformerIds: Readonly<string[]>; export function loadTransformer(id: string, config?: object): Transformer<any, any>; export function isKnownTransformer(id: string): boolean; export { Transformer }; export function toTransformer(): OperatorFunction<TransformerConfig, Transformer<any, any>>; export function validateTransformerChain({ beginWith, endWith, defaultTransformer, defaultTransformerConfig }?: Partial<TransformOptions>): OperatorFunction<Transformer<any, any>, Transformer<any, any>>; export function runTransformer(source: Observable<any>): (observable: Observable<Transformer<any, any>>) => observable.Observable<any>; export function compatibleTransformers(sourceType: string): string[]; export type TransformerMeta = { id: string; description?: string; input?: string[]; output: string; alias?: string[]; defaults?: any; }; export type Report = import("../../diff/node_modules/@report-toolkit/common/src/report.js").Report; export type TransformFunction<T, U> = (opts?: any) => import("rxjs").OperatorFunction<T, U>; export type Observable<T> = observable.Observable<T>; export type OperatorFunction<T, U> = import("rxjs").OperatorFunction<T, U>; export type TransformerConfig = { id: string; config: object; }; /** * for {@link validateTransformerChain} */ export type TransformOptions = { /** * - Begin transformer chain with this type */ beginWith: string; /** * - End transformer chain with this type */ endWith: string; /** * - Default transformer */ defaultTransformer: string; /** * - Default transformer config */ defaultTransformerConfig: object; }; import { Transformer } from "./transformer.js"; import { observable } from "../../diff/node_modules/@report-toolkit/common/src/index.js";