Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DictionaryMapper

Package version

Hierarchy

Index

Properties

Optional constraints

constraints: MapperConstraints

Constraints to test the current value against

Optional defaultValue

defaultValue: any

Default value when one is not explicitly provided

Optional headerCollectionPrefix

headerCollectionPrefix: undefined | string

Optional isConstant

isConstant: undefined | false | true

Whether or not the current property is a constant

Optional nullable

nullable: undefined | false | true

Whether or not the current property allows mull as a value

Optional readOnly

readOnly: undefined | false | true

Whether or not the current property is readonly

Optional required

required: undefined | false | true

Whether or not the current property is required

Optional serializedName

serializedName: undefined | string

The name to use when serializing

type

Optional xmlElementName

xmlElementName: undefined | string

Name for the xml elements when serializing an array

Optional xmlIsAttribute

xmlIsAttribute: undefined | false | true

Determines if the current property should be serialized as an attribute of the parent xml element

Optional xmlIsWrapped

xmlIsWrapped: undefined | false | true

Whether or not the current property should have a wrapping XML element

Optional xmlName

xmlName: undefined | string

Name for the xml element

Optional xmlNamespace

xmlNamespace: undefined | string

Xml element namespace

Optional xmlNamespacePrefix

xmlNamespacePrefix: undefined | string

Xml element namespace prefix

Generated using TypeDoc