Interface IProperty

A minimal subset of the formal JSON Schema that describes a property.

interface IProperty {
    default?: PartialJSONValue;
    description?: string;
    properties?: { [property: string]: IProperty };
    title?: string;
    type?: Primitive | Primitive[];
    [key: string]: undefined | PartialJSONValue;
}

Hierarchy (View Summary)

PartialJSONObject
- IProperty
  - ISchema

Indexable

[key: string]: undefined | PartialJSONValue

Index

Properties

default? description? properties? title? type?

Properties

`Optional`default

default?: PartialJSONValue

The default value, if any.

`Optional`description

description?: string

The schema description.

`Optional`properties

properties?: { [property: string]: IProperty }

The schema's child properties.

`Optional`title

title?: string

The title of a property.

`Optional`type

type?: Primitive | Primitive[]

The type or types of the data.