Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PropertySchema

Hierarchy

  • PropertySchema

Index

Constructors

constructor

  • Parameters

    • name: string

    Returns PropertySchema

Properties

allowLabelsAsValue

allowLabelsAsValue: boolean = false

For enums.

Optional classType

classType: ClassType<any>

Optional classTypeForwardRef

classTypeForwardRef: ForwardedRef<any>

Optional classTypeResolved

classTypeResolved: ClassType<any>

Optional exclude

exclude: "all" | "mongo" | "plain"

isArray

isArray: boolean = false

isDecorated

isDecorated: boolean = false

Whether this property is decorated.

isId

isId: boolean = false

isMap

isMap: boolean = false

isOptional

isOptional: boolean = false

isParentReference

isParentReference: boolean = false

name

name: string

type

type: Types = "any"

validators

validators: ClassType<PropertyValidator>[] = []

Methods

getForeignClassDecorator

  • Returns PropertySchema | undefined

getResolvedClassType

  • getResolvedClassType(): ClassType<any>
  • Returns ClassType<any>

getResolvedClassTypeForValidType

  • getResolvedClassTypeForValidType(): ClassType<any> | undefined
  • Returns ClassType<any> | undefined

getValidators

isResolvedClassTypeIsDecorated

  • isResolvedClassTypeIsDecorated(): boolean
  • Returns boolean

Generated using TypeDoc