Class: SubCommandEntry<ArgType, CommandType>

subcommands/src.SubCommandEntry

since 1.0.0 SubCommandEntry represents a basic subcommand entry. Methods and command names are supported in core.

see SubCommandEntryCommand

see SubCommandEntryMethod

Type parameters

Name	Type
ArgType	extends Args = Args
CommandType	extends Command<ArgType> = Command<ArgType>

Hierarchy

• SubCommandEntry

  ↳ SubCommandEntryCommand

  ↳ SubCommandEntryMethod

Constructors

constructor

• new SubCommandEntry<ArgType, CommandType>(options)

Type parameters

Name	Type
ArgType	extends Args<ArgType> = Args
CommandType	extends Command<ArgType, CommandOptions, CommandType> = Command<ArgType, CommandOptions>

Parameters

Name	Type
options	Options<ArgType, CommandType>

Defined in

projects/plugins/packages/subcommands/src/lib/SubCommandEntry.ts:15

Properties

input

• Readonly input: string | (context: MessageRunContext<ArgType, CommandType>) => Awaitable<string>

Defined in

projects/plugins/packages/subcommands/src/lib/SubCommandEntry.ts:12

---

output

• Readonly output: string

Defined in

projects/plugins/packages/subcommands/src/lib/SubCommandEntry.ts:13

Methods

match

▸ match(value, context): Promise<boolean>

Parameters

Name	Type
value	string
context	MessageRunContext<ArgType, CommandType>

Returns

Promise<boolean>

Defined in

projects/plugins/packages/subcommands/src/lib/SubCommandEntry.ts:21

---

messageRun

▸ Abstract messageRun(context): unknown

Parameters

Name	Type
context	MessageRunContext<ArgType, CommandType>

Returns

unknown

Defined in

projects/plugins/packages/subcommands/src/lib/SubCommandEntry.ts:27