Skip to main contentreport-toolkit

transformers/src/transformer.d

Index

Classes

Type aliases

Functions

Type aliases

Formatters

Ƭ Formatters: “table” | “json” | “csv”


Report

Ƭ Report: Report


TransformFunction

Ƭ TransformFunction: function

Type declaration:

▸ (opts?: any): OperatorFunction‹T, U›

Parameters:

NameType
opts?any

TransformerField

Ƭ TransformerField: object

Type declaration:

  • color? : string | function

  • label: string

  • value: string | function


TransformerMeta

Ƭ TransformerMeta: object

Type declaration:

  • alias? : string[]

  • defaults? : any

  • description? : string

  • id: string

  • input? : string[]

  • output: string

Functions

createTransformer

createTransformer<T, U>(transform: function, meta: object, config?: any): Transformer‹T, U›

Creates a Transformer

template T,U

Type parameters:

T

U

Parameters:

transform: function

Transformer function

▸ (opts?: any): OperatorFunction‹T, U›

Parameters:

NameType
opts?any

meta: object

Transformer meta

NameType
alias?string[]
defaults?any
description?string
idstring
input?string[]
outputstring

Optional config: any

Returns: Transformer‹T, U›