Skip to main content

@versionzero/schema / types / ISchemaMetadataAttributesCommon

Interface: ISchemaMetadataAttributesCommon

Defined in: src/types.js:70

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