gunshi / default / SubCommandable

Interface: SubCommandable

Sub-command entry type for use in subCommands.

This type uses a loose structural match to bypass TypeScript's contravariance issues with function parameters, allowing any Command or LazyCommand to be used as a sub-command.

Since

v0.27.1

Indexable

[key: string]: any

Index signature to allow additional properties

Properties

Property	Type	Description
args?	Args | Record<string, any>	see Command.args
commandName?	string	see LazyCommand.commandName
description?	string	see Command.description
entry?	boolean	see Command.entry
examples?	string | (...args) => any	see Command.examples
internal?	boolean	see Command.internal
name?	string	see Command.name
rendering?	any	see Command.rendering
run?	(...args) => any	see Command.run
toKebab?	boolean	see Command.toKebab