@eagleoutice/flowr - v2.10.2
    Preparing search index...

    Interface ReplCommand

    Content of a single command in the repl. The command may execute an external script or simply call flowR functions.

    interface ReplCommand {
        aliases: string[];
        description: string;
        fn: (info: ReplCommandInformation) => void | Promise<void>;
        isCodeCommand: false;
        script: boolean;
        usageExample: string;
    }

    Hierarchy (View Summary)

    Hierarchy-Diagram

    UML class diagram of ReplCommand
    Index

    Properties

    aliases description fn isCodeCommand script usageExample

    Properties

    aliases: string[]

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

    description: string

    A human-readable description of what the command does

    fn: (info: ReplCommandInformation) => 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: false
    script: boolean

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

    usageExample: string

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

    Settings

    Member Visibility

    On This Page

    Properties