Interface DataTransformer

A unit is a container of elements, it can not contain other units.

interface DataTransformer {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "DataTransformers$DataTransformer";
    $UnitID?: string;
    documentation: string;
    elements: StructureElement[];
    excluded: boolean;
    exportLevel: ExportLevel;
    name: string;
    rootElement: null | string;
    source: null | Source;
    steps: Step[];
    addStep(): Promise<Step>;
    addStructureAttribute(): Promise<StructureAttribute>;
    addStructureObject(): Promise<StructureObject>;
    addStructureValue(): Promise<StructureValue>;
    getStructureAttribute(name: string): undefined | StructureAttribute;
}

Hierarchy (View Summary)

Document
- DataTransformer

Index

Properties

$CreationOptions? $ID $Type $UnitID? documentation elements excluded exportLevel name rootElement source steps

Methods

addStep addStructureAttribute addStructureObject addStructureValue getStructureAttribute

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "DataTransformers$DataTransformer"

The type of the element.

`Optional`$UnitID

$UnitID?: string

documentation

documentation: string

elements

elements: StructureElement[]

excluded

excluded: boolean

exportLevel

exportLevel: ExportLevel

name

name: string

rootElement

rootElement: null | string

source

source: null | Source

steps

steps: Step[]

Methods

addStep

addStep(): Promise<Step>
Returns Promise<Step>

addStructureAttribute

addStructureAttribute(): Promise<StructureAttribute>
Returns Promise<StructureAttribute>

addStructureObject

addStructureObject(): Promise<StructureObject>
Returns Promise<StructureObject>

addStructureValue

addStructureValue(): Promise<StructureValue>
Returns Promise<StructureValue>

getStructureAttribute

getStructureAttribute(name: string): undefined | StructureAttribute
Parameters
- name: string
Returns undefined | StructureAttribute