Optional
$commentOptional
containsOptional
$comment?: stringOptional
default?: anyOptional
deprecated?: booleanOptional
description?: stringOptional
examples?: any[]Optional
readOptional
title?: stringOptional
writeOptional
defaultOptional
deprecatedOptional
descriptionOptional
examplesOptional
itemsOptional
maxOptional
maxOptional
minOptional
minOptional
prefixOptional
readOptional
titleReadonly
typeOptional
uniqueOptional
writeSerializes the parameter into a JSON object.
Optional
$comment?: stringOptional
contains?: JsonSchemaOptional
default?: anyOptional
deprecated?: booleanOptional
description?: stringOptional
examples?: any[]Optional
items?: boolean | JsonSchemaOptional
maxOptional
maxOptional
minOptional
minOptional
prefixOptional
readOptional
title?: stringOptional
uniqueOptional
writeProtected
toJSONBaseOptional
$comment?: stringOptional
default?: anyOptional
deprecated?: booleanOptional
description?: stringOptional
examples?: any[]Optional
readOptional
title?: stringOptional
writeStatic
fromJSONOptional
$comment?: stringOptional
contains?: JsonSchemaOptional
default?: anyOptional
deprecated?: booleanOptional
description?: stringOptional
examples?: any[]Optional
items?: boolean | JsonSchemaOptional
maxOptional
maxOptional
minOptional
minOptional
prefixOptional
readOptional
title?: stringOptional
uniqueOptional
writeStatic
isWhether the given JsonSchema
is a JsonSchemaArray
.
Note: This method does not check if the schema is valid, only if it has properties unique to array schemas.
Generated using TypeDoc
A UUID generated for this parameter by the library.