CompositeMapperType interface

Helps build a mapper that describes how to map a set of properties of an object based on other mappers.

Only one of the following properties should be present: className, modelProperties and additionalProperties.

Properties

additionalProperties

Used when a model has additionalProperties: true. Allows the generic processing of unnamed model properties on the response object.

className

Use className to reference another type definition.

modelProperties

Use modelProperties when the reference to the other type has been resolved.

name

Name of the composite mapper type.

polymorphicDiscriminator

A polymorphic discriminator.

uberParent

The name of the top-most parent scheme, the one that has no parents.

Property Details

additionalProperties

Used when a model has additionalProperties: true. Allows the generic processing of unnamed model properties on the response object.

additionalProperties?: Mapper

Property Value

className

Use className to reference another type definition.

className?: string

Property Value

string

modelProperties

Use modelProperties when the reference to the other type has been resolved.

modelProperties?: {[propertyName: string]: Mapper}

Property Value

{[propertyName: string]: Mapper}

name

Name of the composite mapper type.

name: "Composite"

Property Value

"Composite"

polymorphicDiscriminator

A polymorphic discriminator.

polymorphicDiscriminator?: PolymorphicDiscriminator

Property Value

uberParent

The name of the top-most parent scheme, the one that has no parents.

uberParent?: string

Property Value

string