Interface Parser

Parser contract. A parser is a stateless transform from (text, context) → ParseResult. Implementations live under mud/lib/command/parsers/<name>.ts and default-export a Parser value. Custom parsers can live anywhere; reference them by absolute path (/path/to/file) from the shell.parser setting.

interface Parser {
    name: string;
    parse(
        text: string,
        context: ParserContext,
    ): ParseResult | Promise<ParseResult>;
}

Index

Properties

Methods

Properties

name

name: string

Display name. Bare-name spec resolves to lib/command/parsers/<name>.

Methods

parse

parse(text: string, context: ParserContext): ParseResult | Promise<ParseResult>
Parse the raw input. May be sync or async.
Parameters
- text: string
- context: ParserContext
Returns ParseResult | Promise<ParseResult>
- Defined in packages/server/src/mud/api/command.ts:299