Optional
additionalAdditional items.
The additionalItems
means the type schema info of the additional items
after the prefixItems. In the TypeScript, if there's a type
[T1, T2, ...TO[]]
, the ...TO[]
is represented by the additionalItems
.
By the way, if you configure the additionalItems
as true
, it means
the additional items are not restricted. They can be any type, so that
it is equivalent to the TypeScript type [T1, T2, ...any[]]
.
Otherwise configure the additionalItems
as the IJsonSchema,
it means the additional items must follow the type schema info.
Therefore, it is equivalent to the TypeScript type [T1, T2, ...TO[]]
.
Optional
deprecatedWhether the type is deprecated or not.
Optional
descriptionDetailed description of the schema.
Optional
exampleExample value.
Optional
examplesList of example values as key-value pairs.
Optional
maxMaximum items restriction.
Restriction of maximum number of items in the tuple.
Optional
minMinimum items restriction.
Restriction of minimum number of items in the tuple.
Prefix items.
The prefixItems
means the type schema info of the prefix items in the
tuple type. In the TypeScript, it is expressed as [T1, T2]
.
If you want to express [T1, T2, ...TO[]]
type, you can configure the
...TO[]
through the additionalItems property.
Optional
titleTitle of the schema.
Discriminator value of the type.
Optional
uniqueUnique items restriction.
If this property value is true
, target tuple must have unique items.
Tuple type info.