| <!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 ArgResults class from the args library, for the Dart programming language."> |
| <title>ArgResults 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 class="self-crumb">ArgResults class</li> |
| </ol> |
| <div class="self-name">ArgResults</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>args library</h5> |
| <ol> |
| <li class="section-title"><a href="package-args_args/package-args_args-library.html#classes">Classes</a></li> |
| <li><a href="package-args_args/ArgParser-class.html">ArgParser</a></li> |
| <li><a href="package-args_args/ArgResults-class.html">ArgResults</a></li> |
| <li><a href="package-args_args/Option-class.html">Option</a></li> |
| <li><a href="package-args_args/OptionType-class.html">OptionType</a></li> |
| |
| |
| |
| |
| |
| |
| <li class="section-title"><a href="package-args_args/package-args_args-library.html#exceptions">Exceptions</a></li> |
| <li><a href="package-args_args/ArgParserException-class.html">ArgParserException</a></li> |
| </ol> |
| </div> |
| |
| <div class="col-xs-12 col-sm-9 col-md-8 main-content"> |
| <h1>ArgResults class </h1> |
| |
| <section class="desc markdown"> |
| <p>The results of parsing a series of command line arguments using |
| <a href="package-args_args/ArgParser/parse.html">ArgParser.parse()</a>.</p> |
| <p>Includes the parsed options and any remaining unparsed command line |
| arguments.</p> |
| </section> |
| |
| |
| |
| <section class="summary offset-anchor" id="instance-properties"> |
| <h2>Properties</h2> |
| |
| <dl class="properties"> |
| <dt id="arguments" class="property"> |
| <span class="name"><a href="package-args_args/ArgResults/arguments.html">arguments</a></span> |
| <span class="signature">→ List<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> |
| </dt> |
| <dd> |
| The original list of arguments that were parsed. |
| <div class="features">final</div> |
| </dd> |
| <dt id="command" class="property"> |
| <span class="name"><a href="package-args_args/ArgResults/command.html">command</a></span> |
| <span class="signature">→ <a href="package-args_args/ArgResults-class.html">ArgResults</a></span> |
| </dt> |
| <dd> |
| The command that was selected, or <code>null</code> if none was. <a href="package-args_args/ArgResults/command.html">[...]</a> |
| <div class="features">final</div> |
| </dd> |
| <dt id="name" class="property"> |
| <span class="name"><a href="package-args_args/ArgResults/name.html">name</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| If these are the results for parsing a command's options, this will be the |
| name of the command. For top-level results, this returns <code>null</code>. |
| <div class="features">final</div> |
| </dd> |
| <dt id="options" class="property"> |
| <span class="name"><a href="package-args_args/ArgResults/options.html">options</a></span> |
| <span class="signature">→ Iterable<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> |
| </dt> |
| <dd> |
| Get the names of the available options as an <code>Iterable</code>. <a href="package-args_args/ArgResults/options.html">[...]</a> |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="rest" class="property"> |
| <span class="name"><a href="package-args_args/ArgResults/rest.html">rest</a></span> |
| <span class="signature">→ List<span class="signature"><<wbr><span class="type-parameter">String</span>></span></span> |
| </dt> |
| <dd> |
| The remaining command-line arguments that were not parsed as options or |
| flags. <a href="package-args_args/ArgResults/rest.html">[...]</a> |
| <div class="features">final</div> |
| </dd> |
| <dt id="hashCode" class="property inherited"> |
| <span class="name"><a href="package-args_args/ArgResults/hashCode.html">hashCode</a></span> |
| <span class="signature">→ int</span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">read-only, inherited</div> |
| </dd> |
| <dt id="runtimeType" class="property inherited"> |
| <span class="name"><a href="package-args_args/ArgResults/runtimeType.html">runtimeType</a></span> |
| <span class="signature">→ Type</span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">read-only, inherited</div> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="instance-methods"> |
| <h2>Methods</h2> |
| <dl class="callables"> |
| <dt id="wasParsed" class="callable"> |
| <span class="name"><a href="package-args_args/ArgResults/wasParsed.html">wasParsed</a></span><span class="signature">(<wbr><span class="parameter" id="wasParsed-param-name"><span class="type-annotation">String</span> <span class="parameter-name">name</span></span>) |
| <span class="returntype parameter">→ bool</span> |
| </span> |
| </dt> |
| <dd> |
| Returns <code>true</code> if the option with <code>name</code> was parsed from an actual |
| argument. <a href="package-args_args/ArgResults/wasParsed.html">[...]</a> |
| |
| </dd> |
| <dt id="noSuchMethod" class="callable inherited"> |
| <span class="name"><a href="package-args_args/ArgResults/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation">Invocation</span> <span class="parameter-name">invocation</span></span>) |
| <span class="returntype parameter">→ dynamic</span> |
| </span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">inherited</div> |
| </dd> |
| <dt id="toString" class="callable inherited"> |
| <span class="name"><a href="package-args_args/ArgResults/toString.html">toString</a></span><span class="signature">(<wbr>) |
| <span class="returntype parameter">→ String</span> |
| </span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">inherited</div> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="operators"> |
| <h2>Operators</h2> |
| <dl class="callables"> |
| <dt id="operator []" class="callable"> |
| <span class="name"><a href="package-args_args/ArgResults/operator_get.html">operator []</a></span><span class="signature">(<wbr><span class="parameter" id="[]-param-name"><span class="type-annotation">String</span> <span class="parameter-name">name</span></span>) |
| <span class="returntype parameter">→ dynamic</span> |
| </span> |
| </dt> |
| <dd> |
| Gets the parsed command-line option named <code>name</code>. |
| |
| </dd> |
| <dt id="operator ==" class="callable inherited"> |
| <span class="name"><a href="package-args_args/ArgResults/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation">dynamic</span> <span class="parameter-name">other</span></span>) |
| <span class="returntype parameter">→ bool</span> |
| </span> |
| </dt> |
| <dd class="inherited"> |
| |
| <div class="features">inherited</div> |
| </dd> |
| </dl> |
| </section> |
| |
| |
| |
| |
| </div> <!-- /.main-content --> |
| |
| <div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right"> |
| <ol> |
| |
| <li class="section-title"> |
| <a href="package-args_args/ArgResults-class.html#instance-properties">Properties</a> |
| </li> |
| <li><a href="package-args_args/ArgResults/arguments.html">arguments</a></li> |
| <li><a href="package-args_args/ArgResults/command.html">command</a></li> |
| <li><a href="package-args_args/ArgResults/name.html">name</a></li> |
| <li><a href="package-args_args/ArgResults/options.html">options</a></li> |
| <li><a href="package-args_args/ArgResults/rest.html">rest</a></li> |
| <li class="inherited"><a href="package-args_args/ArgResults/hashCode.html">hashCode</a></li> |
| <li class="inherited"><a href="package-args_args/ArgResults/runtimeType.html">runtimeType</a></li> |
| |
| <li class="section-title"><a href="package-args_args/ArgResults-class.html#instance-methods">Methods</a></li> |
| <li><a href="package-args_args/ArgResults/wasParsed.html">wasParsed</a></li> |
| <li class="inherited"><a href="package-args_args/ArgResults/noSuchMethod.html">noSuchMethod</a></li> |
| <li class="inherited"><a href="package-args_args/ArgResults/toString.html">toString</a></li> |
| |
| <li class="section-title"><a href="package-args_args/ArgResults-class.html#operators">Operators</a></li> |
| <li><a href="package-args_args/ArgResults/operator_get.html">operator []</a></li> |
| <li class="inherited"><a href="package-args_args/ArgResults/operator_equals.html">operator ==</a></li> |
| |
| |
| |
| </ol> |
| </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> |
