Interface ReplCodeCommand

Repl command that uses the FlowrAnalyzer

interface ReplCodeCommand {
    aliases: string[];
    argsParser: (
        remainingLine: string,
    ) => { input: undefined | string; remaining: string[] };
    description: string;
    fn: (info: ReplCodeCommandInformation) => void | Promise<void>;
    isCodeCommand: true;
    script: boolean;
    usageExample: string;
}

Hierarchy (View Summary)

Hierarchy-Diagram

UML class diagram of ReplCodeCommand

Properties

aliases argsParser description fn isCodeCommand script usageExample

Properties

aliases

aliases: string[]

Aliases of the command (without the leading colon), every alias must be unique (this is checked at runtime)

argsParser

argsParser: (
    remainingLine: string,
) => { input: undefined | string; remaining: string[] }

Argument parser function which handles the input given after the repl command

description

description: string

A human-readable description of what the command does

fn

fn: (info: ReplCodeCommandInformation) => void | Promise<void>

Function to execute when the command is invoked, it must not write to the command line but instead use the output handler. Furthermore, it has to obey the formatter defined in the ReplOutput.

isCodeCommand

isCodeCommand: true

script

script: boolean

Does the command invoke another script? this is mainly used to automatically generate two separate lists when asking for help

usageExample

usageExample: string

Example of how to use the command, for example :slicer --help

Settings

Member Visibility

On This Page

Properties