Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PropertyCompilerSchema

Contains all resolved information from PropertySchema necessary to feat compiler functions.

Internal note: It's on purpose aligned with PropertySchema.

Hierarchy

Index

Constructors

constructor

  • Parameters

    • name: string
    • Optional classType: ClassType<any>

    Returns PropertyCompilerSchema

Properties

allowLabelsAsValue

allowLabelsAsValue: boolean = false

Protected Optional cacheKey

cacheKey: undefined | string

Protected Optional classType

classType: ClassType<any>

hasDefaultValue

hasDefaultValue: boolean = false

isArray

isArray: boolean = false

isMap

isMap: boolean = false

isOptional

isOptional: boolean = false

isParentReference

isParentReference: boolean = false

isPartial

isPartial: boolean = false

Whether given classType can be populated partially (for example in patch mechanisms).

isReference

isReference: boolean = false

Whether its a owning reference.

name

name: string

type

type: Types = "any"

validators

validators: ClassType<PropertyValidator>[] = []

Accessors

resolveClassType

  • get resolveClassType(): ClassType<any> | undefined
  • Returns ClassType<any> | undefined

Methods

isActualOptional

  • isActualOptional(): boolean
  • Returns boolean

Static createFromPropertySchema

  • createFromPropertySchema(propertySchema: PropertySchema, isArray?: undefined | false | true, isMap?: undefined | false | true, isPartial?: undefined | false | true): PropertyCompilerSchema
  • Parameters

    • propertySchema: PropertySchema
    • Optional isArray: undefined | false | true
    • Optional isMap: undefined | false | true
    • Optional isPartial: undefined | false | true

    Returns PropertyCompilerSchema

Generated using TypeDoc