Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

addAnnotation

  • Parameters

    Returns void

annotations

  • Returns IAnnotation[]

defaultValue

  • defaultValue(): any
  • returns a default value for this property

    Returns any

description

  • description(): string
  • Returns string

domain

  • domain of the property (basically declaring type)

    Returns ITypeDefinition

enumOptions

  • enumOptions(): string[]
  • if this property range is constrained to a fixed set of values it will return the values

    Returns string[]

getAdapter

  • getAdapter<T>(adapterType: object): T
  • Type parameters

    • T

    Parameters

    • adapterType: object
      • constructor: function
        • new __type(arg?: any): __type
        • Parameters

          • Optional arg: any

          Returns __type

    Returns T

getAdapters

  • getAdapters(): any[]
  • Returns any[]

getKeyRegexp

  • getKeyRegexp(): string
  • return a pattern for a property name - used for a pattern properties

    Returns string

isDescriminator

  • isDescriminator(): boolean
  • true if this property is a discriminator

    Returns boolean

isMultiValue

  • isMultiValue(): boolean
  • true if this property can have multiple values

    Returns boolean

isPrimitive

  • isPrimitive(): boolean
  • true if this property range is one of built in value types

    Returns boolean

isRequired

  • isRequired(): boolean
  • true if this property is required to fill

    Returns boolean

isValueProperty

  • isValueProperty(): boolean
  • true if this property range is a value type

    Returns boolean

keyPrefix

  • keyPrefix(): string
  • return a prefix for a property name - used for additional properties

    Returns string

matchKey

  • matchKey(k: string): boolean
  • returns true if this property matches the a given property name (it is important for additional and pattern properties)

    Parameters

    • k: string

    Returns boolean

nameId

  • nameId(): string
  • name of the property

    Returns string

range

  • range of the property (basically it is type)

    Returns ITypeDefinition

removeAnnotation

  • Parameters

    Returns void

Generated using TypeDoc