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

    Interface HelperScriptInformation

    interface HelperScriptInformation {
        description: string;
        masterScripts: string[];
        options: OptionDefinition[];
        target: string;
        toolName: string;
        type: "helper script";
        usageExample: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

    Hierarchy-Diagram

    UML class diagram of HelperScriptInformation
    Index

    Properties

    description masterScripts options target toolName type usageExample

    Properties

    description: string

    description of the tool for the user

    masterScripts: string[]
    options: OptionDefinition[]

    command line options that are available

    target: string

    internal module name to fork/execute, make sure to use the correct path to it with the help of __dirname

    toolName: string

    name of the tool to present to the user

    type: "helper script"
    usageExample: string

    example usage

    Settings

    Member Visibility

    On This Page

    Properties