gunshi / default / ArgOptionSchema

Interface: ArgOptionSchema

An option schema for an argument. This schema is similar to the schema of the node:utils. difference is that:

• multiple property is not supported
• required property and description property are added
• default property type, not support multiple types

Properties

Property	Type	Description
default?	string | number | boolean	The default value of the argument.
description?	string	A description of the argument.
required?	true	Whether the argument is required or not.
short?	string	A single character alias for the option.
type	"string" | "number" | "boolean"	Type of argument.