Namespace src/Args

Summary:
Documentation for src/Args directory
Created on:
Last updated:

src/Args

Overview

Directory src/Args

file source src/Args/defaultHelp.sh

Args::defaultHelp

display help and exits if one of args is -h|–help

Options

  • -h

    short help option

  • –help

    long help option

Arguments
  • $1 (helpArg:String|Function): the help string to display or the function to call to display the help
  • … (args:String[]): list of options
Exit codes
  • 0: displays help and exit with code 0 if -h or –help option is in the args list
Output on stdout
  • displays help if -h or –help option is in the args list

src/Args/defaultHelpNoExit.sh

file source src/Args/defaultHelpNoExit.sh

Args::defaultHelpNoExit

display help if one of args is -h|–help

Options

  • -h

    short help option

  • –help

    long help option

Arguments
  • $1 (helpArg:String|Function): the help string to display or the function to call to display the help
  • … (args:String[]): list of options
Exit codes
  • 1: displays help and returns with code 1 if -h or –help option is in the args list
Output on stdout
  • displays help if -h or –help option is in the args list

src/Args/showHelp.sh

file source src/Args/showHelp.sh

Args::showHelp

display help

Arguments
  • $1 (helpArg:String): the help string to show
Output on stdout
  • display help arg
Or, if you want, you can alternatively use the GitHub discussion Q&A for feedback and questions.