Skip to content

API reference / @jsprismarine/brigadier / ParseResults

Class: ParseResults<S> ​

Defined in: ParseResults.ts:6

Type Parameters ​

S ​

S

Constructors ​

Constructor ​

new ParseResults<S>(context, reader?, exceptions?): ParseResults<S>

Defined in: ParseResults.ts:13

Parameters ​

context ​

CommandContextBuilder<S>

reader? ​

ImmutableStringReader

exceptions? ​

Map<CommandNode<S>, Error>

Returns ​

ParseResults<S>

Methods ​

copyFor() ​

copyFor(source): ParseResults<S>

Defined in: ParseResults.ts:45

Copies the parse for another source without running any argument parsers again.

Parameters ​

source ​

S

The source the resulting context tree should carry.

Returns ​

ParseResults<S>


getContext() ​

getContext(): CommandContextBuilder<S>

Defined in: ParseResults.ts:23

Returns ​

CommandContextBuilder<S>


getExceptions() ​

getExceptions(): Map<CommandNode<S>, Error>

Defined in: ParseResults.ts:36

Returns the error each child node raised while parsing, keyed by node. Brigadier's own parsers throw CommandSyntaxException; argument types supplied by callers may throw any Error.

Returns ​

Map<CommandNode<S>, Error>


getReader() ​

getReader(): ImmutableStringReader

Defined in: ParseResults.ts:27

Returns ​

ImmutableStringReader