Interface describing the syntax and behavior definition of a command or group of commands
Aliases - any number of single or more character aliases can be specified.
Build this command from multiple handlers chained together, remapping the response to arguments for future handlers in the command.
Limitations of chained handlers include:
The Children for this command - used when the type is provider or group. Use the children to build complex nested syntaxes - however bright modules must follow the prescribed command syntax structure for Brightside.
The command handlers are passed the definition document for the command. You can place any additional "custom" definition information here.
If this property exists, the command is deprecated. The property value is a string that identifies the replacement command. It is used in a deprecation message similar to the following: This command is deprecated. Recommended replacement: value_of_deprecatedReplacement_goes_here
The description - keep group descriptions "small" and include lengthier descriptions for "commands".
If true, stdin will automatically be read before the handler of this command is invoked.
The set of examples displayed in the help for this command.
Is this command experimental? If you set this to true, the command will be marked with help text indicating that it is experimental. If this command is of type "group" all descendant commands will be marked experimental as well.
The handler for this command - this is a string literal that is used on the "require" statement to load the command handler - The handler itself must implement ICommandHandler. A string is used over an actual instance because we do not want the handler (and its required dependencies) to be loaded before it is issued.
Must specify one indicates that you must specify one of the options listed.
The command or group name
Only one of the listed options can be specified
The options to be exposed on the command.
Enable output format options (e.g. "--response-format-type"). The output format options are applied to data that is presented to the handler response format APIs (see IHandlerResponseApi, "format" property). The intent of of the output format options:
Simplify the code in a command handler. A "common" use-case for handler output is printing tables (or lists) of JSON objects/data OR a single JSON response object.
Passing the data described in (1) to the handler response format API and enabling the format options gives the user full control over the output format. They can choose to output an array of JSON objects as a table OR a list of prettified objects. The use can also choose to include table headers and filter fields. The user can also reduce the output of a table to a single column (or a JSON object to a single property) eliminating the need to manually code options such as "--only-print-this-one-field"
See the "ICommandOutputFormat" JSDoc for details on the format types.
The options enabled:
Allows the user to control the output format of the data. See the "ICommandOutputFormat" interface for details.
--response-format-filter [array of fields]
Allows the user to include only the fields specified in the filter array.
Allows the user to optionally include the header with a table.
Pass on attributes of the current definition node to children
The positional arguments to be exposed on the command.
Auto-loading of profile specifications - see the interface definition for more details.
The description for the stdin option - used if enableStdin is true
A shorter (~one line) description of your command
This documents segment type - either "group" or "command". See the type definition for more detail.
Generated using TypeDoc