Options
All
  • Public
  • Public/Protected
  • All
Menu

this interface constains additional properties specific to object 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

Optional additionalProperties

additionalProperties: IType

allows to set constraints on the type of additional properties

Optional closed

closed: boolean

if set to true type is threaten as closed type

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 maxProperties

maxProperties: number

maximum amount of properties which instances of the type should have

Optional minProperties

minProperties: number

minimum amount of properties which instances of the type should have

Optional properties

properties: object

map of property signatures to the property 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