Class DataMapperBuilder

Index

Constructors

Properties

definition extractSequence formulaSequence items

Methods

build extractObject formula includeNullInputs inputType item list map outputType property extract transform

Constructors

constructor

new DataMapperBuilder(
type: string,
options?: DataMapperBuilderOptions,
): DataMapperBuilder
Parameters
- type: string
- options: DataMapperBuilderOptions = {}
Returns DataMapperBuilder
- Defined in packages/vlocity/src/datamapper/builder.ts:56

Properties

`Private` `Readonly`definition

definition: DataMapperDefinition

`Private`extractSequence

extractSequence: number = 0

`Private`formulaSequence

formulaSequence: number = 0

`Private` `Readonly`items

items: DataMapperItem[]

Methods

build

build(): DataMapperDefinition
Returns DataMapperDefinition
- Defined in packages/vlocity/src/datamapper/builder.ts:133

extractObject

extractObject(
    objectName: string,
    outputPath: string,
    options?: DataMapperExtractObjectOptions,
): DataMapperExtractObjectBuilder
Parameters
- objectName: string
- outputPath: string
- options: DataMapperExtractObjectOptions = {}
Returns DataMapperExtractObjectBuilder
- Defined in packages/vlocity/src/datamapper/builder.ts:93

formula

formula(
    expression: string,
    resultPath: string,
    options?: DataMapperFormulaOptions,
): this
Parameters
- expression: string
- resultPath: string
- options: DataMapperFormulaOptions = {}
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:121

includeNullInputs

includeNullInputs(include?: boolean): this
Parameters
- include: boolean = true
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:78

inputType

inputType(inputType: string): this
Parameters
- inputType: string
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:68

item

item(item: DataMapperItem): this
Parameters
- item: DataMapperItem
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:88

list

list(
outputPath: string,
options?: Omit<DataMapperMapOptions, "outputFieldFormat">,
): this
Parameters
- outputPath: string
- options: Omit<DataMapperMapOptions, "outputFieldFormat"> = {}
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:114

map

map(
    inputPath: string | undefined,
    outputPath: string,
    options?: DataMapperMapOptions,
): this
Parameters
- inputPath: string | undefined
- outputPath: string
- options: DataMapperMapOptions = {}
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:100

outputType

outputType(outputType: string): this
Parameters
- outputType: string
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:73

property

property(name: string, value: unknown): this
Parameters
- name: string
- value: unknown
Returns this
- Defined in packages/vlocity/src/datamapper/builder.ts:83

`Static`extract

extract(options?: DataMapperBuilderOptions): DataMapperBuilder
Parameters
- Optionaloptions: DataMapperBuilderOptions
Returns DataMapperBuilder
- Defined in packages/vlocity/src/datamapper/builder.ts:48

`Static`transform

transform(options?: DataMapperBuilderOptions): DataMapperBuilder
Parameters
- Optionaloptions: DataMapperBuilderOptions
Returns DataMapperBuilder
- Defined in packages/vlocity/src/datamapper/builder.ts:52