Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserDefinedClass

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

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

_properties

_properties: IProperty[]

_requirements

_requirements: ValueRequirement[]

_subTypes

_subTypes: ITypeDefinition[]

_superTypes

_superTypes: ITypeDefinition[]

_universe

_universe: IUniverse

_validator

_validator: function

Type declaration

_value

_value: boolean

buildIn

buildIn: boolean

uc

uc: boolean

Methods

addAdapter

  • addAdapter(q: any): void

  • Parameters

    • q: any

    Returns void

addAnnotation

addFacet

  • Parameters

    Returns void

addProperty

addRequirement

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

  • Parameters

    • name: string
    • value: string

    Returns void

addSuperType

  • Parameters

    Returns void

allCustomProperties

allFacets

  • Parameters

    Returns IProperty[]

allFixedFacets

  • allFixedFacets(): object

allProperties

allPropertyIndex

  • allPropertyIndex(name: string): number

  • Parameters

    • name: string

    Returns number

allSubTypes

allSuperTypes

annotationType

annotations

  • annotations(): any[]

array

arrayInHierarchy

Protected contributeFacets

  • contributeFacets(x: object): void

  • Parameters

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

    Returns void

customProperties

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

facets

fixFacet

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

  • Parameters

    • name: string
    • v: any

    Returns void

genuineUserDefinedType

  • 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

genuineUserDefinedTypeInHierarchy

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

getFixedFacets

  • getFixedFacets(): object

getNameAtRuntime

  • getNameAtRuntime(): string

  • Returns string

getPath

  • getPath(): string

  • Returns string

hasArrayInHierarchy

  • hasArrayInHierarchy(): 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

hasUnionInHierarchy

  • hasUnionInHierarchy(): boolean

hasValueTypeInHierarchy

  • hasValueTypeInHierarchy(): boolean

isAnnotationType

  • isAnnotationType(): boolean

isArray

  • isArray(): boolean

isAssignableFrom

  • isAssignableFrom(typeName: string): boolean

isBuiltIn

  • isBuiltIn(): boolean

isCustom

  • isCustom(): boolean

  • Returns boolean

isExternal

  • isExternal(): 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

isTopLevel

  • isTopLevel(): boolean

  • Returns boolean

isUnion

  • isUnion(): boolean

isUserDefined

  • isUserDefined(): boolean

isValueType

  • isValueType(): boolean

key

  • key(): any

kind

  • kind(): string[]

  • Returns string[]

nameId

  • nameId(): string

  • Returns string

printDetails

properties

property

propertyIndex

  • propertyIndex(name: string): number

  • Parameters

    • name: string

    Returns number

putExtra

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

  • Parameters

    • extraName: string
    • value: any

    Returns void

registerCustomProperty

registerProperty

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

unionInHierarchy

universe

validate

valueRequirements

withDescription

  • Parameters

    • d: string

    Returns Described

Generated using TypeDoc