Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

  • Parameters

    • _name: string
    • Optional _universe: IUniverse
    • Optional _path: string

    Returns AbstractType

Properties

Protected _af

_af: object

Type declaration

  • [name: string]: any

Protected _allFacets

_allFacets: IProperty[]

_allSupers

_allSupers: ITypeDefinition[]

_customProperties

_customProperties: IProperty[]

Protected _facets

_facets: IProperty[]

_isCustom

_isCustom: boolean

_key

_key: NamedId

Private _nameAtRuntime

_nameAtRuntime: any

Private _path

_path: any

Private _props

_props: any

_requirements

_requirements: ValueRequirement[]

_subTypes

_subTypes: ITypeDefinition[]

_superTypes

_superTypes: ITypeDefinition[]

_universe

_universe: IUniverse

_validator

_validator: function

Type declaration

buildIn

buildIn: boolean

Private fixedFacets

fixedFacets: any

uc

uc: boolean

Methods

addAdapter

  • addAdapter(q: any): void
  • Parameters

    • q: any

    Returns void

addAnnotation

addFacet

  • Parameters

    Returns void

addRequirement

  • addRequirement(name: string, value: string): void
  • Parameters

    • name: string
    • value: string

    Returns void

addSuperType

  • Parameters

    Returns void

allCustomProperties

  • Returns IProperty[]

allFacets

  • Parameters

    Returns IProperty[]

allFixedFacets

  • allFixedFacets(): object
  • Returns object

    • [name: string]: any

allProperties

  • Parameters

    Returns IProperty[]

allSubTypes

allSuperTypes

Private allSuperTypesRecurrent

  • allSuperTypesRecurrent(t: any, m: any, result: any): any
  • Parameters

    • t: any
    • m: any
    • result: any

    Returns any

annotationType

annotations

  • annotations(): any[]

array

  • Returns IArrayType

arrayInHierarchy

Protected contributeFacets

  • contributeFacets(x: object): void
  • Parameters

    • x: object
      • [name: string]: any

    Returns void

customProperties

  • Returns IProperty[]

description

  • description(): string

examples

  • Returns example for this type. Returned example should be tested for being empty and being expandable.

    Returns IExpandableExample[]

external

externalInHierarchy

facet

  • Parameters

    • name: string

    Returns IProperty

facets

  • Returns IProperty[]

fixFacet

  • fixFacet(name: string, v: any): void
  • Parameters

    • name: string
    • v: any

    Returns void

genuineUserDefinedTypeInHierarchy

  • Returns nearest genuine user-define type in the hierarchy. Genuine user defined type is a type user intentionally defined and filled with properties or facets, or having user-defined name as opposed to a synthetic user-defined type.

    Returns ITypeDefinition

getAdapter

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

    • T

    Parameters

    • adapterType: object
      • constructor: function
        • Parameters

          • Optional p: any

          Returns __type

    Returns T

getAdapters

  • getAdapters(): any[]

getExtra

  • getExtra(name: string): any
  • Parameters

    • name: string

    Returns any

Private getExtraAdapter

  • getExtraAdapter(): any
  • Returns any

getFixedFacets

  • getFixedFacets(): object
  • Returns object

    • [name: string]: any

getNameAtRuntime

  • getNameAtRuntime(): string
  • Returns string

getPath

  • getPath(): string
  • Returns string

Private getTypeClassName

  • getTypeClassName(): any
  • Returns any

hasArrayInHierarchy

  • hasArrayInHierarchy(): boolean
  • Returns boolean

hasExternalInHierarchy

  • hasExternalInHierarchy(): boolean

hasGenuineUserDefinedTypeInHierarchy

  • hasGenuineUserDefinedTypeInHierarchy(): boolean
  • Returns whether this type contain genuine user defined type in its hierarchy. Genuine user defined type is a type user intentionally defined and filled with properties or facets, or having user-defined name as opposed to a synthetic user-defined type.

    Returns boolean

hasStructure

  • hasStructure(): boolean
  • Returns boolean

hasUnionInHierarchy

  • hasUnionInHierarchy(): boolean
  • Returns boolean

hasValueTypeInHierarchy

  • hasValueTypeInHierarchy(): boolean

isAnnotationType

  • isAnnotationType(): boolean
  • Returns boolean

isArray

  • isArray(): boolean
  • Returns boolean

isAssignableFrom

  • isAssignableFrom(typeName: string): boolean
  • Parameters

    • typeName: string

    Returns boolean

isBuiltIn

  • isBuiltIn(): boolean
  • Returns boolean

isCustom

  • isCustom(): boolean
  • Returns boolean

isExternal

  • isExternal(): boolean
  • Returns boolean

isGenuineUserDefinedType

  • isGenuineUserDefinedType(): boolean
  • Returns whether this type contain genuine user defined type in its hierarchy. Genuine user defined type is a type user intentionally defined and filled with properties or facets, or having user-defined name as opposed to a synthetic user-defined type.

    Returns boolean

isObject

  • isObject(): boolean
  • Returns boolean

Private isStandardSuperclass

  • isStandardSuperclass(nameId: any, className: any): any
  • Parameters

    • nameId: any
    • className: any

    Returns any

isTopLevel

  • isTopLevel(): boolean
  • Returns boolean

isUnion

  • isUnion(): boolean
  • Returns boolean

isUserDefined

  • isUserDefined(): boolean
  • Returns boolean

isValueType

  • isValueType(): boolean
  • Returns boolean

key

  • Returns NamedId

kind

  • kind(): string[]
  • Returns string[]

nameId

  • nameId(): string
  • Returns string

printDetails

  • Parameters

    Returns string

properties

  • Returns IProperty[]

property

  • Parameters

    • propName: string

    Returns IProperty

putExtra

  • putExtra(extraName: string, value: any): void
  • Parameters

    • extraName: string
    • value: any

    Returns void

registerCustomProperty

  • Parameters

    Returns void

removeAnnotation

requiredProperties

setBuiltIn

  • setBuiltIn(builtIn: boolean): void
  • Parameters

    • builtIn: boolean

    Returns void

setCustom

  • setCustom(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setName

  • setName(name: string): void
  • Parameters

    • name: string

    Returns void

setNameAtRuntime

  • setNameAtRuntime(name: string): void
  • Parameters

    • name: string

    Returns void

subTypes

superTypes

tags

  • tags(): string[]
  • Returns string[]

typeId

  • typeId(): string
  • Returns string

union

  • Returns IUnionType

unionInHierarchy

universe

  • Returns IUniverse

validate

  • Parameters

    • x: any

    Returns Status[]

valueRequirements

withDescription

  • Parameters

    • d: string

    Returns Described

Generated using TypeDoc