OptionaldeprecatedWhether this type is deprecated.
When true, indicates the type should no longer be used and may be removed
in future versions. Set via the @deprecated JSDoc tag.
OptionaldescriptionDetailed description of the schema.
Full documentation for the type, explaining its purpose, constraints, and usage. Extracted from JSDoc comment body. Supports markdown formatting in many JSON Schema consumers.
OptionalexampleSingle example value for the schema.
A representative value that conforms to the schema, useful for
documentation and testing. Set via the @example JSDoc tag.
OptionalexamplesNamed example values for the schema.
Multiple examples as key-value pairs, where keys are example names and values are conforming data. Useful for showing different valid states or edge cases.
Schema for array elements.
All elements in the array must conform to this schema. For heterogeneous
arrays, use an anyOf schema.
OptionalmaxMaximum number of elements.
The array must contain at most this many items.
OptionalminMinimum number of elements.
The array must contain at least this many items.
OptionalreadWhether the property is read-only.
When true, the property should not be modified by clients and is
typically set by the server. Useful for generated IDs, timestamps, etc.
OptionaltitleShort title for the schema.
A brief, human-readable name for the type. Typically extracted from the
first line of a JSDoc comment or the @title tag.
OptionaluniqueWhether elements must be unique.
When true, no two elements may be equal. Maps to TypeScript Set<T>
semantics but represented as an array.
OptionalwriteWhether the property is write-only.
When true, the property is accepted on input but never returned in
responses. Common for sensitive data like passwords.
Array type schema.
Represents a JSON Schema array type with item type validation and size constraints. Maps to TypeScript
T[]orArray<T>types. Note: Tuple types are not supported by LLM schemas.