Interface ICli

Type declaration

• buildCommands: function

  • buildCommands(obj: IMap<ICommand> | ICommand[] | ICommandItem[], name?: string, tabs?: number): string

  • Builds simple string for help menu.

    Parameters

    • obj: IMap<ICommand> | ICommand[] | ICommandItem[]

      object of commands or array of options to build menu for.

    • Optional name: string

    • Optional tabs: number

      the number of tabs after key name.

    Returns string

• buildExamples: function

  • buildExamples(examples: string[], name?: string): string

  • Formats example menu items replacing {{name}} with provided value.

    Parameters

    • examples: string[]

      array of examples for help menu.

    • Optional name: string

      the name to replace {{name}} with.

    Returns string

• buildOptions: function

  • buildOptions(obj: IMap<ICommand> | ICommand[] | ICommandItem[], name?: string, tabs?: number): string

  • Builds simple string for help menu.

    Parameters

    • obj: IMap<ICommand> | ICommand[] | ICommandItem[]

      object of commands or array of options to build menu for.

    • Optional name: string

    • Optional tabs: number

      the number of tabs after key name.

    Returns string

• combineItems: function

  • combineItems<T>(obj: IMap<ICommand>, key: keyof ICommand, filter?: string[]): T[]

  • Combines a nested command key into single array.

    Type parameters

    • T

    Parameters

    • obj: IMap<ICommand>

      object containing commands.

    • key: keyof ICommand

      the nested array key to reduce.

    • Optional filter: string[]

      array of commands to filter.

    Returns T[]