Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Methods

addAnnotation

  • Parameters

    Returns void

allFacets

  • Facets declared by the type and its supertypes

    Parameters

    • Optional visited: any

    Returns IProperty[]

allFixedFacets

  • allFixedFacets(): object
  • Returns object

    map of fixed facet names to fixed facet values;

    • [name: string]: any

allProperties

  • List off all properties (declared in this type and super types), did not includes properties fixed to fixed facet use facet for them

    Parameters

    • Optional visited: any

    Returns IProperty[]

allSubTypes

  • list of all subtypes not including this type

    Returns ITypeDefinition[]

allSuperTypes

  • List of all super types not including this type

    Returns ITypeDefinition[]

annotationType

  • Returns IAnnotationType

annotations

  • Returns IAnnotation[]

array

  • Casts this type to an array. Does not perform a search in super types.

    Returns IArrayType

arrayInHierarchy

  • casting to nearest array type in hierarchy

    Returns IArrayType

description

  • description(): string
  • Returns string

examples

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

    Returns IExpandableExample[]

external

  • Casts this type to an external type. Does not perform a search in super types.

    Returns IExternalType

externalInHierarchy

  • Casting to nearest external type in hierarchy

    Returns IExternalType

facet

  • Parameters

    • n: string

    Returns IProperty

facets

  • Facets declared by the type

    Returns IProperty[]

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
        • new __type(arg?: any): __type
        • Parameters

          • Optional arg: any

          Returns __type

    Returns T

getAdapters

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

getExtra

  • getExtra(name: string): any
  • Parameters

    • name: string

    Returns any

getFixedFacets

  • getFixedFacets(): object
  • Returns object

    map of fixed facet names to fixed facet values;

    • [name: string]: any

hasArrayInHierarchy

  • hasArrayInHierarchy(): boolean
  • true if this type is array or one of its super types is array.

    Returns boolean

hasExternalInHierarchy

  • hasExternalInHierarchy(): boolean
  • true if this type is external type, or one if its super types is an external type.

    Returns 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
  • true if this type values have internal structure

    Returns boolean

hasUnionInHierarchy

  • hasUnionInHierarchy(): boolean
  • true if this type is union or one of its super types is union.

    Returns boolean

hasValueTypeInHierarchy

  • hasValueTypeInHierarchy(): boolean
  • true if this type is value type or one of its super types is value type.

    Returns boolean

isAnnotationType

  • isAnnotationType(): boolean
  • Returns boolean

isArray

  • isArray(): boolean
  • Whether this type is an array. Does not perform a search in super types.

    Returns boolean

isAssignableFrom

  • isAssignableFrom(typeName: string): boolean
  • return true if this type is assignable to a given type

    Parameters

    • typeName: string

    Returns boolean

isBuiltIn

  • isBuiltIn(): boolean
  • Whether the class is built-in.

    Returns boolean

isExternal

  • isExternal(): boolean
  • true if this type is external. Does not perform a search in super types.

    Returns boolean

isGenuineUserDefinedType

  • isGenuineUserDefinedType(): boolean
  • Returns whether this type is genuine user defined type. 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
  • Whether this type is object. Performs a search in super types.

    Returns boolean

isUnion

  • isUnion(): boolean
  • Whether this type is a union. Does not perform a search in super types.

    Returns boolean

isUserDefined

  • isUserDefined(): boolean
  • Returns whether this type was defined by a user.

    Returns boolean

isValueType

  • isValueType(): boolean
  • Whether this type is value type. Does not perform a search in super types.

    Returns boolean

key

  • Returns NamedId

kind

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

nameId

  • nameId(): string
  • Returns string

printDetails

  • Print details of this type. Used mostly for debug and demosntration purposes.

    Parameters

    Returns string

properties

  • Propertis decared in this type

    Returns IProperty[]

property

  • return property by it name looks in super classes but will not return anything if property is a fixed with facet

    Parameters

    • name: string

    Returns IProperty

putExtra

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

    • name: string
    • value: any

    Returns void

removeAnnotation

  • Parameters

    Returns void

requiredProperties

  • helper method to get required properties only

    Returns IProperty[]

subTypes

  • list of sub types

    Returns ITypeDefinition[]

superTypes

  • list os super types

    Returns ITypeDefinition[]

union

  • Casts this type to a union type. Does not perform a search in super types.

    Returns IUnionType

unionInHierarchy

  • Casting to nearest union type in hierarchy

    Returns IUnionType

universe

  • parent universe

    Returns IUniverse

validate

  • Parameters

    • x: any

    Returns Status[]

valueRequirements

  • List of value requirements for this type, used to discriminate a type from a list of subtype

    Returns ValueRequirement[]

Generated using TypeDoc