Skip to main content

@versionzero/schema / types / ISchemaMetadataCommon

Interface: ISchemaMetadataCommon

Defined in: src/types.js:20

Properties

PropertyTypeDescription
description?stringhelp text description of the property; used by CommandLineSource
valueName?stringhelp text type name of the property value; used by CommandLineSource
valueDescription?stringhelp text description of the property value; used by CommandLineSource
flagHint?stringrequest a specific flag character; used by CommandLineSource
advanced?booleanfilter from basic help text; used by CommandLineSource
hidden?booleanhide from help; used by CommandLineSource
general?booleanmark this field for CommandLineSource to be used without a flag or option
parserTypeHint?stringset to base/primitive types to help source parsers interpret values
omitFromSerialize?booleanset to true to omit this schema's value when serializing