exframe-etl-transformer v1.2.15
exframe etl transformer
A library for handling transforming data structures
installation
npm install exframe-etl-transformer(simple) usage
const { Transformer } = require('exframe-etl-transformer');
const transformer = Transformer.CreateFromConfiguration({
name: 'transformation',
transformation: [
{ key: 'info', value: '${it.data.name}'}
]
});
const result = transformer.execute({name: 'test'});
console.log(result); // { info: 'name' }Documentation
Enumerations
Classes
Interfaces
Class: TransformationStage
Constructors
• new TransformationStage(name, handler, transformation)
Parameters
| Name | Type |
|---|---|
name | string |
handler | HandlerType |
transformation | TransformationPair[] | <T>(data: any, options?: any) => T |
Properties
• handler: HandlerType
• name: string
• transformation: TransformationPair[] | <T>(data: any, options?: any) => T
Methods
▸ execute<Input, Output>(data, output, options?): void
Parameters
| Name | Type |
|---|---|
data | Input |
output | Partial<Output> |
options? | TransformationExecutionOptions |
Class: Transformer
Constructors
• new Transformer(name)
Parameters
| Name | Type |
|---|---|
name | string |
Properties
• name: string
Accessors
• get stages(): Record<StageType, Map<string, TransformationStage>>
Methods
▸ addStage(type, stage): Transformer
Parameters
| Name | Type |
|---|---|
type | StageType |
stage | TransformationStage |
▸ createStage(stage): Transformer
Parameters
| Name | Type |
|---|---|
stage | TransformationStageData |
▸ execute<Input, Output, ScaffoldData>(data, options?): Output
Parameters
| Name | Type |
|---|---|
data | Input |
options? | TransformationExecutionOptions |
▸ registerTransformations(transformations): Transformer
Parameters
| Name | Type |
|---|---|
transformations | (TransformationStageData | TransformationStage)[] |
▸ Static CreateFromConfiguration(__namedParameters): Transformer
Parameters
| Name | Type |
|---|---|
__namedParameters | TransformationConfiguration |
Enumeration: ErrorCodes
Enumeration members
• InvalidConfiguration = "INVALID_ETL_CONFIGURATION"
• InvalidHandler = "INVALID_ETL_HANDLER"
• InvalidStage = "INVALID_ETL_STAGE"
Enumeration: HandlerType
Enumeration members
• Function = "Function"
• JsonTranpose = "JsonTranpose"
Enumeration: StageType
Enumeration members
• Primary = "Primary"
• Scaffold = "Scaffold"
Interface: TransformationConfiguration
Properties
• name: string
• Optional transformation: TransformationPair[]
• Optional transformations: TransformationStageData[]
Interface: TransformationExecutionOptions
Properties
• Optional context: any
• Optional jsonTranspose: any
Interface: TransformationPair
Properties
• key: string
• value: string
Interface: TransformationStageData
Properties
• handler: HandlerType
• Optional name: string
• transformation: TransformationPair[] | (data: any, options?: any) => any
• type: StageType