Interface IObjectType

Object type definition.

interface IObjectType {
    description?: string;
    index: number;
    jsDocTags: IJsDocTagInfo[];
    name: string;
    nullables: boolean[];
    properties: IMetadataSchema.IProperty[];
    recursive: boolean;
}

Index

Properties

description? index jsDocTags name nullables properties recursive

Properties

`Optional`description

description?: string

JSDoc description.

index

index: number

Index in components (for deduplication).

jsDocTags

jsDocTags: IJsDocTagInfo[]

JSDoc tags.

name

name: string

Object type name.

nullables

nullables: boolean[]

Nullability per reference site.

properties

properties: IMetadataSchema.IProperty[]

Object properties.

recursive

recursive: boolean

Whether the object type is recursive.