Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IType

this interface describes basic layout of JSON type representation, sub interfaces contains documentation about important facets which can be specified for the types extended from related built-in types

Hierarchy

Indexable

[name: string]: any

this index signature is here to specify that IType can contain unknown user defined facets and annotations

Index

Properties

Properties

Optional default

default: any

default value for the type

Optional description

description: string

human readable description of the type (GitHub Markdown)

Optional displayName

displayName: string

human readable short name of the type

Optional enum

enum: any[]

enumeration of possible valid instances for the type

Optional example

example: any

example for the type

Optional facets

facets: object

map of custom facets declarations

Type declaration

Optional type

type: string | string[]

type expression describing super types or in case of multiple inheritance array of type expressions

Generated using TypeDoc