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

    Interface ReplBaseCommand

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

    interface ReplBaseCommand {
        aliases: string[];
        description: string;
        localOnly?: boolean;
        script: boolean;
        usageExample: string;
    }

    Hierarchy (View Summary)

    Index
    aliases description localOnly? script usageExample
    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

    localOnly?: boolean

    Commands that may act beyond analyzing code, e.g., spawn processes, write files, or change the user's global state, are only available to the local user and refused for remote clients of the server (see replProcessAnswer).

    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