Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "node_modules/raml-definition-system/node_modules/raml-typesystem/dist/src/index.d"

Index

Type aliases

IHasExtra

IHasExtra: IHasExtra

IParsedType

IParsedType: IParsedType

IParsedTypeCollection

IParsedTypeCollection: IParsedTypeCollection

IStatus

IStatus: IStatus

ITypeFacet

ITypeFacet: ITypeFacet

ITypeRegistry

ITypeRegistry: ITypeRegistry

IValidationPath

IValidationPath: IValidationPath

Variables

DEFINED_IN_TYPES_EXTRA

DEFINED_IN_TYPES_EXTRA: string

SOURCE_EXTRA

SOURCE_EXTRA: string

TOP_LEVEL_EXTRA

TOP_LEVEL_EXTRA: string

USER_DEFINED_EXTRA

USER_DEFINED_EXTRA: string

Functions

builtInFacets

  • this function allow you to get a list of all built-in facets

    Returns IFacetPrototype[]

builtInTypes

  • returns type registry returning all built in types

    Returns ITypeRegistry

checkACStatus

  • checks if the given type is suitable for automatic classification

    Parameters

    Returns IStatus

derive

  • creates a new type by deriving it from a list of super types

    Parameters

    Returns IParsedType

dump

getSchemaUtils

  • getSchemaUtils(): any
  • Returns any

isParsedType

  • isParsedType(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

loadType

  • loads type from JSON type definition

    Parameters

    Returns IParsedType

loadTypeCollection

  • loads type collection from JSON type definition

    Parameters

    Returns IParsedTypeCollection

    returns a new instance of type collection with a parsed types

parse

parseFromAST

  • parses type collection definition from a JSON structure

    Parameters

    Returns IParsedTypeCollection

parseType

  • parses a type from a JSON structure, uses second argument to resolve types

    Parameters

    Returns IParsedType

parseTypeFromAST

  • parses type collection definition from a JSON structure

    Parameters

    • name: string
    • data: IParseNode
    • collection: IParsedTypeCollection
    • Optional defaultsToAny: boolean
    • Optional annotation: boolean
    • Optional global: boolean
    • Optional ignoreTypeAttr: boolean

    Returns IParsedType

performAC

  • performs automatic classification of instance against a given type

    Parameters

    Returns IParsedType

setPropertyConstructor

  • setPropertyConstructor(c: any): void
  • Parameters

    • c: any

    Returns void

toNominal

unify

  • creates a new type by unifying it from a list of possible options

    Parameters

    Returns IParsedType

validate

  • validates intance against the type definition

    Parameters

    • i: any

      instance to validate

    • t: IParsedType

      type definition

    • Optional autoClose: boolean

    Returns IStatus

validateTypeDefinition

  • validates type definition

    Parameters

    Returns IStatus

Generated using TypeDoc