jsdk-offical

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>TestCase | JSDK 2.7.0 API</title> <meta name="description" content="Documentation for JSDK 2.7.0 API"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">JSDK 2.7.0 API</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/js.html">JS</a> </li> <li> <a href="../modules/js.unit.html">unit</a> </li> <li> <a href="js.unit.testcase.html">TestCase</a> </li> </ul> <h1>Class TestCase</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">TestCase</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="js.unit.testcase.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="js.unit.testcase.html#name" class="tsd-kind-icon">name</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.unit.testcase.html#addtestmethod" class="tsd-kind-icon">add<wbr>Test<wbr>Method</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.unit.testcase.html#counttests" class="tsd-kind-icon">count<wbr>Tests</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.unit.testcase.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.unit.testcase.html#gettestmethods" class="tsd-kind-icon">get<wbr>Test<wbr>Methods</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.unit.testcase.html#run" class="tsd-kind-icon">run</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="js.unit.testcase.html#runmethod" class="tsd-kind-icon">run<wbr>Method</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="js.unit.testcase.html#setup" class="tsd-kind-icon">set<wbr>Up</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="js.unit.testcase.html#teardown" class="tsd-kind-icon">tear<wbr>Down</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Test<wbr>Case<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="js.unit.testcase.html" class="tsd-signature-type">TestCase</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="js.unit.testcase.html" class="tsd-signature-type">TestCase</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a name="name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> name</h3> <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="addtestmethod" class="tsd-anchor"></a> <h3>add<wbr>Test<wbr>Method</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<wbr>Test<wbr>Method<span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><a href="js.sugar.method.html" class="tsd-signature-type">Method</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>method: <a href="js.sugar.method.html" class="tsd-signature-type">Method</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="counttests" class="tsd-anchor"></a> <h3>count<wbr>Tests</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">count<wbr>Tests<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Counts the number of test cases that will be run by this test.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getname" class="tsd-anchor"></a> <h3>get<wbr>Name</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="gettestmethods" class="tsd-anchor"></a> <h3>get<wbr>Test<wbr>Methods</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Test<wbr>Methods<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4> <ul class="tsd-parameters"> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="run" class="tsd-anchor"></a> <h3>run</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>result<span class="tsd-signature-symbol">?: </span><a href="js.unit.testresult.html" class="tsd-signature-type">TestResult</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="js.unit.testresult.html" class="tsd-signature-type">TestResult</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A convenience method to run this test, collecting the results with a TestResult object.</p> </div> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p>TestResult</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> result: <a href="js.unit.testresult.html" class="tsd-signature-type">TestResult</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="js.unit.testresult.html" class="tsd-signature-type">TestResult</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="runmethod" class="tsd-anchor"></a> <h3>run<wbr>Method</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">run<wbr>Method<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Runs its a method by name.</p> </div> <dl class="tsd-comment-tags"> <dt>throws</dt> <dd><p>Throwable if any exception is thrown</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="setup" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> set<wbr>Up</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">set<wbr>Up<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets up the fixture, for example, open a network connection. This method is called before a test is executed.</p> </div> <dl class="tsd-comment-tags"> <dt>throws</dt> <dd><p>{Exception} Throwable if any exception is thrown</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="teardown" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> tear<wbr>Down</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">tear<wbr>Down<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Tears down the fixture, for example, close a network connection. This method is called after a test is executed.</p> </div> <dl class="tsd-comment-tags"> <dt>throws</dt> <dd><p>{Exception} Throwable if any exception is thrown</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-namespace"> <a href="../modules/js.html">JS</a> <ul> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.an.html">an</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.app.html">app</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.core.html">core</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.d2.html">d2</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ds.html">ds</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.fx.html">fx</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.input.html">input</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ioc.html">ioc</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.lang.html">lang</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.math.html">math</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.media.html">media</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.model.html">model</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.net.html">net</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.store.html">store</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.sugar.html">sugar</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.ui.html">ui</a> </li> <li class="current tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.unit.html">unit</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.util.html">util</a> </li> <li class=" tsd-kind-namespace tsd-parent-kind-namespace"> <a href="../modules/js.view.html">view</a> </li> </ul> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-namespace"> <a href="js.unit.testcase.html" class="tsd-kind-icon">Test<wbr>Case</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="js.unit.testcase.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a href="js.unit.testcase.html#name" class="tsd-kind-icon">name</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.unit.testcase.html#addtestmethod" class="tsd-kind-icon">add<wbr>Test<wbr>Method</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.unit.testcase.html#counttests" class="tsd-kind-icon">count<wbr>Tests</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.unit.testcase.html#getname" class="tsd-kind-icon">get<wbr>Name</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.unit.testcase.html#gettestmethods" class="tsd-kind-icon">get<wbr>Test<wbr>Methods</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.unit.testcase.html#run" class="tsd-kind-icon">run</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="js.unit.testcase.html#runmethod" class="tsd-kind-icon">run<wbr>Method</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a href="js.unit.testcase.html#setup" class="tsd-kind-icon">set<wbr>Up</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a href="js.unit.testcase.html#teardown" class="tsd-kind-icon">tear<wbr>Down</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="js.unit.testfailure.html" class="tsd-kind-icon">Test<wbr>Failure</a> </li> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="js.unit.testresult.html" class="tsd-kind-icon">Test<wbr>Result</a> </li> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="js.unit.testrunner.html" class="tsd-kind-icon">Test<wbr>Runner</a> </li> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="js.unit.testsuite.html" class="tsd-kind-icon">Test<wbr>Suite</a> </li> <li class=" tsd-kind-class tsd-parent-kind-namespace"> <a href="js.unit.testui.html" class="tsd-kind-icon">TestUI</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-namespace"> <a href="../interfaces/js.unit.testlistener.html" class="tsd-kind-icon">Test<wbr>Listener</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-namespace"> <a href="../modules/js.unit.html#testclass" class="tsd-kind-icon">Test<wbr>Class</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-not-exported"> <a href="../modules/js.unit.html#y" class="tsd-kind-icon">Y</a> </li> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>