| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="API docs for the addOption method from the ArgParser class, for the Dart programming language."> |
| <title>addOption method - ArgParser class - args library - Dart API</title> |
| <!-- required because all the links are pseudo-absolute --> |
| <base href="../.."> |
| |
| <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500,400i,400,300|Source+Sans+Pro:400,300,700" rel="stylesheet"> |
| <link rel="stylesheet" href="static-assets/github.css"> |
| <link rel="stylesheet" href="static-assets/styles.css"> |
| <link rel="icon" href="static-assets/favicon.png"> |
| |
| </head> |
| |
| <body> |
| |
| <div id="overlay-under-drawer"></div> |
| |
| <header id="title"> |
| <button id="sidenav-left-toggle" type="button"> </button> |
| <ol class="breadcrumbs gt-separated dark hidden-xs"> |
| <li><a href="index.html">test_package</a></li> |
| <li><a href="package-args_args/package-args_args-library.html">args</a></li> |
| <li><a href="package-args_args/ArgParser-class.html">ArgParser</a></li> |
| <li class="self-crumb">addOption method</li> |
| </ol> |
| <div class="self-name">addOption</div> |
| <form class="search navbar-right" role="search"> |
| <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search..."> |
| </form> |
| </header> |
| |
| <main> |
| |
| <div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left"> |
| <h5>ArgParser class</h5> |
| <ol> |
| <li class="section-title"><a href="package-args_args/ArgParser-class.html#constructors">Constructors</a></li> |
| <li><a href="package-args_args/ArgParser/ArgParser.html">ArgParser</a></li> |
| <li><a href="package-args_args/ArgParser/ArgParser.allowAnything.html">allowAnything</a></li> |
| |
| <li class="section-title"> |
| <a href="package-args_args/ArgParser-class.html#instance-properties">Properties</a> |
| </li> |
| <li><a href="package-args_args/ArgParser/allowsAnything.html">allowsAnything</a></li> |
| <li><a href="package-args_args/ArgParser/allowTrailingOptions.html">allowTrailingOptions</a></li> |
| <li><a href="package-args_args/ArgParser/commands.html">commands</a></li> |
| <li><a href="package-args_args/ArgParser/options.html">options</a></li> |
| <li><a href="package-args_args/ArgParser/usage.html">usage</a></li> |
| <li><a href="package-args_args/ArgParser/usageLineLength.html">usageLineLength</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/hashCode.html">hashCode</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/runtimeType.html">runtimeType</a></li> |
| |
| <li class="section-title"><a href="package-args_args/ArgParser-class.html#instance-methods">Methods</a></li> |
| <li><a href="package-args_args/ArgParser/addCommand.html">addCommand</a></li> |
| <li><a href="package-args_args/ArgParser/addFlag.html">addFlag</a></li> |
| <li><a href="package-args_args/ArgParser/addMultiOption.html">addMultiOption</a></li> |
| <li><a href="package-args_args/ArgParser/addOption.html">addOption</a></li> |
| <li><a href="package-args_args/ArgParser/addSeparator.html">addSeparator</a></li> |
| <li><a href="package-args_args/ArgParser/findByAbbreviation.html">findByAbbreviation</a></li> |
| <li><a href="package-args_args/ArgParser/getDefault.html">getDefault</a></li> |
| <li><a class="deprecated" href="package-args_args/ArgParser/getUsage.html">getUsage</a></li> |
| <li><a href="package-args_args/ArgParser/parse.html">parse</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/noSuchMethod.html">noSuchMethod</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/toString.html">toString</a></li> |
| |
| <li class="section-title inherited"><a href="package-args_args/ArgParser-class.html#operators">Operators</a></li> |
| <li class="inherited"><a href="package-args_args/ArgParser/operator_equals.html">operator ==</a></li> |
| |
| |
| |
| </ol> |
| </div><!--/.sidebar-offcanvas--> |
| |
| <div class="col-xs-12 col-sm-9 col-md-8 main-content"> |
| <h1>addOption method</h1> |
| |
| <section class="multi-line-signature"> |
| <span class="returntype">void</span> |
| <span class="name ">addOption</span> |
| (<wbr><span class="parameter" id="addOption-param-name"><span class="type-annotation">String</span> <span class="parameter-name">name</span>, {</span> <span class="parameter" id="addOption-param-abbr"><span class="type-annotation">String</span> <span class="parameter-name">abbr</span>, </span> <span class="parameter" id="addOption-param-help"><span class="type-annotation">String</span> <span class="parameter-name">help</span>, </span> <span class="parameter" id="addOption-param-valueHelp"><span class="type-annotation">String</span> <span class="parameter-name">valueHelp</span>, </span> <span class="parameter" id="addOption-param-allowed"><span class="type-annotation">Iterable<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> <span class="parameter-name">allowed</span>, </span> <span class="parameter" id="addOption-param-allowedHelp"><span class="type-annotation">Map<span class="signature"><<wbr><span class="type-parameter">String</span>, <span class="type-parameter">String</span>></span></span> <span class="parameter-name">allowedHelp</span>, </span> <span class="parameter" id="addOption-param-defaultsTo"><span class="type-annotation">String</span> <span class="parameter-name">defaultsTo</span>, </span> <span class="parameter" id="addOption-param-callback"><span class="type-annotation">Function</span> <span class="parameter-name">callback</span>, </span> <span class="parameter" id="addOption-param-allowMultiple"><span>@<a href="ex/Deprecated-class.html">Deprecated</a>("Use addMultiOption() instead.")</span> <span class="type-annotation">bool</span> <span class="parameter-name">allowMultiple</span>: <span class="default-value">false</span>, </span> <span class="parameter" id="addOption-param-splitCommas"><span>@<a href="ex/Deprecated-class.html">Deprecated</a>("Use addMultiOption() instead.")</span> <span class="type-annotation">bool</span> <span class="parameter-name">splitCommas</span>, </span> <span class="parameter" id="addOption-param-hide"><span class="type-annotation">bool</span> <span class="parameter-name">hide</span>: <span class="default-value">false</span></span> }) |
| </section> |
| <section class="desc markdown"> |
| <p>Defines an option that takes a value.</p> |
| <p>This adds an <a href="package-args_args/Option-class.html">Option</a> with the given properties to <a href="package-args_args/ArgParser/options.html">options</a>.</p> |
| <p>The <code>abbr</code> argument is a single-character string that can be used as a |
| shorthand for this option. For example, <code>abbr: "a"</code> will allow the user to |
| pass <code>-a value</code> or <code>-avalue</code>.</p> |
| <p>The <code>help</code> argument is used by <a href="package-args_args/ArgParser/usage.html">usage</a> to describe this option.</p> |
| <p>The <code>valueHelp</code> argument is used by <a href="package-args_args/ArgParser/usage.html">usage</a> as a name for the value this |
| option takes. For example, <code>valueHelp: "FOO"</code> will include |
| <code>--option=<FOO></code> rather than just <code>--option</code> in the usage string.</p> |
| <p>The <code>allowed</code> argument is a list of valid values for this option. If |
| it's non-<code>null</code> and the user passes a value that's not included in the |
| list, <a href="package-args_args/ArgParser/parse.html">parse</a> will throw a <code>FormatException</code>. The allowed values will also |
| be included in <a href="package-args_args/ArgParser/usage.html">usage</a>.</p> |
| <p>The <code>allowedHelp</code> argument is a map from values in <code>allowed</code> to |
| documentation for those values that will be included in <a href="package-args_args/ArgParser/usage.html">usage</a>.</p> |
| <p>The <code>defaultsTo</code> argument indicates the value this option will have if the |
| user doesn't explicitly pass it in (or <code>null</code> by default).</p> |
| <p>The <code>callback</code> argument is invoked with the option's value when the option |
| is parsed. Note that this makes argument parsing order-dependent in ways |
| that are often surprising, and its use is discouraged in favor of reading |
| values from the <code>ArgResult</code>.</p> |
| <p>The <code>allowMultiple</code> and <code>splitCommas</code> options are deprecated; the |
| <a href="package-args_args/ArgParser/addMultiOption.html">addMultiOption</a> method should be used instead.</p> |
| <p>If <code>hide</code> is <code>true</code>, this option won't be included in <a href="package-args_args/ArgParser/usage.html">usage</a>.</p> |
| <p>Throws an <code>ArgumentError</code> if:</p><ul><li>There is already an option with name <code>name</code>.</li><li>There is already an option using abbreviation <code>abbr</code>.</li><li><code>splitCommas</code> is passed but <code>allowMultiple</code> is <code>false</code>.</li></ul> |
| </section> |
| |
| |
| |
| </div> <!-- /.main-content --> |
| |
| <div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right"> |
| </div><!--/.sidebar-offcanvas--> |
| |
| </main> |
| |
| <footer> |
| <span class="no-break"> |
| test_package 0.0.1 |
| </span> |
| |
| </footer> |
| |
| <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script> |
| <script src="static-assets/typeahead.bundle.min.js"></script> |
| <script src="static-assets/highlight.pack.js"></script> |
| <script src="static-assets/URI.js"></script> |
| <script src="static-assets/script.js"></script> |
| |
| |
| </body> |
| |
| </html> |
