Options
All
  • Public
  • Public/Protected
  • All
Menu

parsed representation of the type you should not create instances of this interfaces manually

Hierarchy

Index

Methods

ac

  • Parameters

    • i: any

    Returns IParsedType

allFacets

  • returns all meta information and restrictions associated with the type all inheritable facets from super types are included

    Returns ITypeFacet[]

allSubTypes

  • returns full list of known types which inherit from this type. Note: built-in types does not list their not built in sub types

    Returns IParsedType[]

allSuperTypes

  • returns full list of ancestor types

    Returns IParsedType[]

canDoAc

  • Parameters

    • i: any

    Returns IStatus

customFacets

  • returns array of custom facets directly declared on this type

    Returns ITypeFacet[]

declaredFacets

  • returns meta information and restrictions associated with the type only declared facets are included

    Returns ITypeFacet[]

exampleObject

  • exampleObject(): any
  • Returns any

getExtra

  • getExtra(name: string): any
  • Parameters

    • name: string

    Returns any

isArray

  • isArray(): boolean
  • returns true if this type inherits from array type

    Returns boolean

isBoolean

  • isBoolean(): boolean
  • returns true if this type inherits from boolean type

    Returns boolean

isDateOnly

  • isDateOnly(): boolean
  • returns true if this type inherits from one of date related types

    Returns boolean

isDateTime

  • isDateTime(): boolean
  • returns true if this type inherits from one of date related types

    Returns boolean

isDateTimeOnly

  • isDateTimeOnly(): boolean
  • returns true if this type inherits from one of date related types

    Returns boolean

isFile

  • isFile(): boolean
  • return true if this type inherits from a file type

    Returns boolean

isInteger

  • isInteger(): boolean
  • returns true if this type inherits from integer type

    Returns boolean

isNumber

  • isNumber(): boolean
  • returns true if this type inherits from number type

    Returns boolean

isObject

  • isObject(): boolean
  • returns true if this type inherits from object type

    Returns boolean

isRecurrent

  • isRecurrent(): boolean
  • returns true if this type has recurrent definition;

    Returns boolean

isScalar

  • isScalar(): boolean
  • returns true if this type inherits from scalar type

    Returns boolean

isString

  • isString(): boolean
  • returns true if this type inherits from string type

    Returns boolean

isTimeOnly

  • isTimeOnly(): boolean
  • returns true if this type inherits from one of date related types

    Returns boolean

isUnion

  • isUnion(): boolean
  • returns true if this type is a union type

    Returns boolean

isUnknown

  • isUnknown(): boolean
  • returns true if this type inhetits from an unknown type

    Returns boolean

name

  • name(): string
  • name of the type

    Returns string

putExtra

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

    • name: string
    • value: any

    Returns void

restrictions

  • returns array of custom facets directly declared on this type

    Returns ITypeFacet[]

subTypes

  • returns list of directly declared sub types of this type

    Returns IParsedType[]

superTypes

  • returns list of directly declared super types of this type

    Returns IParsedType[]

validate

  • validate(i: any, autoClose?: boolean): IStatus
  • validates a potential instance of type and returns a status describing the results of validation

    Parameters

    • i: any
    • Optional autoClose: boolean

    Returns IStatus

validateType

  • Parameters

    Returns IStatus

Generated using TypeDoc