Class: SubCommandEntryMethod<ArgType, CommandType>

subcommands/src.SubCommandEntryMethod

SubCommandEntryMethods support method names as subcommand functions. All methods must be on the same class. For splitting sub-commands into different commands, see SubCommandEntryCommand

example

export class extends SubCommandPluginCommand {
    public constructor(context: PieceContext) {
            super(context, {
                name: 'conf',
                // by default, outputs default to inputs
                subCommands: ['set', { input: 'list', default: true }]
            })
        }

        public async set(message: Message, args: Args) {
            // !conf set is called here.
        }

        public async list(message: Message, args: Args) {
            // !conf list is called here.
            // !conf is also called here. (see SubCommandEntry.default)
        }
}

Type parameters

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

Hierarchy

• SubCommandEntry<ArgType, CommandType>

  ↳ SubCommandEntryMethod

Constructors

constructor

• new SubCommandEntryMethod<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>

Inherited from

SubCommandEntry.constructor

Defined in

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

Properties

input

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

Inherited from

SubCommandEntry.input

Defined in

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

---

output

• Readonly output: string

Inherited from

SubCommandEntry.output

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>

Inherited from

SubCommandEntry.match

Defined in

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

---

messageRun

▸ messageRun(context): unknown

Parameters

Name	Type
context	MessageRunContext<ArgType, CommandType>

Returns

unknown

Overrides

SubCommandEntry.messageRun

Defined in

projects/plugins/packages/subcommands/src/lib/SubCommandEntryMethod.ts:33