Class CommandDispatcher<S>

Type Parameters

S

Index

Constructors

Methods

execute findAmbiguities findNode getAllUsage getCompletionSuggestions getPath getRoot getSmartUsage parse register setConsumer

Constructors

constructor

new CommandDispatcher<S>(root?: null | RootCommandNode<S>): CommandDispatcher<S>
Type Parameters
- S
Parameters
- root: null | RootCommandNode<S> = null
Returns CommandDispatcher<S>
- Defined in packages/brigadier/src/CommandDispatcher.ts:30

Methods

execute

execute(input: string | StringReader | ParseResults<S>, source?: null | S): any
Parameters
- input: string | StringReader | ParseResults<S>
- source: null | S = null
Returns any
- Defined in packages/brigadier/src/CommandDispatcher.ts:44

findAmbiguities

findAmbiguities(consumer: AmbiguityConsumer<S>, context: any): void
Parameters
- consumer: AmbiguityConsumer<S>
- context: any
Returns void
- Defined in packages/brigadier/src/CommandDispatcher.ts:389

findNode

findNode(path: string[]): null | CommandNode<S>
Parameters
- path: string[]
Returns null | CommandNode<S>
- Defined in packages/brigadier/src/CommandDispatcher.ts:380

getAllUsage

getAllUsage(node: CommandNode<S>, source: S, restricted: boolean): string[]
Parameters
- node: CommandNode<S>
- source: S
- restricted: boolean
Returns string[]
- Defined in packages/brigadier/src/CommandDispatcher.ts:223

getCompletionSuggestions

getCompletionSuggestions(
parse: ParseResults<S>,
cursor?: number,
): Promise<Suggestions>
Parameters
- parse: ParseResults<S>
- cursor: number = ...
Returns Promise<Suggestions>
- Defined in packages/brigadier/src/CommandDispatcher.ts:334

getPath

getPath(target: CommandNode<S>): string[]
Parameters
- target: CommandNode<S>
Returns string[]
- Defined in packages/brigadier/src/CommandDispatcher.ts:363

getRoot

getRoot(): RootCommandNode<S>
Returns RootCommandNode<S>
- Defined in packages/brigadier/src/CommandDispatcher.ts:359

getSmartUsage

getSmartUsage(node: CommandNode<S>, source: S): Map<CommandNode<S>, string>
Parameters
- node: CommandNode<S>
- source: S
Returns Map<CommandNode<S>, string>
- Defined in packages/brigadier/src/CommandDispatcher.ts:258

parse

parse(command: string | StringReader, source: S): ParseResults<S>
Parameters
- command: string | StringReader
- source: S
Returns ParseResults<S>
- Defined in packages/brigadier/src/CommandDispatcher.ts:132

register

register(command: LiteralArgumentBuilder<S>): LiteralCommandNode<S>
Parameters
- command: LiteralArgumentBuilder<S>
Returns LiteralCommandNode<S>
- Defined in packages/brigadier/src/CommandDispatcher.ts:34

setConsumer

setConsumer(consumer: ResultConsumer<S>): void
Parameters
- consumer: ResultConsumer<S>
Returns void
- Defined in packages/brigadier/src/CommandDispatcher.ts:40