<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta name="generator" content="JsDoc Toolkit" /> <title>JsDoc Reference - jasmine.Env</title> <style type="text/css"> /* default.css */ body { font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; width: 800px; } .header { clear: both; background-color: #ccc; padding: 8px; } h1 { font-size: 150%; font-weight: bold; padding: 0; margin: 1em 0 0 .3em; } hr { border: none 0; border-top: 1px solid #7F8FB1; height: 1px; } pre.code { display: block; padding: 8px; border: 1px dashed #ccc; } #index { margin-top: 24px; float: left; width: 160px; position: absolute; left: 8px; background-color: #F3F3F3; padding: 8px; } #content { margin-left: 190px; width: 600px; } .classList { list-style-type: none; padding: 0; margin: 0 0 0 8px; font-family: arial, sans-serif; font-size: 1em; overflow: auto; } .classList li { padding: 0; margin: 0 0 8px 0; } .summaryTable { width: 100%; } h1.classTitle { font-size:170%; line-height:130%; } h2 { font-size: 110%; } caption, div.sectionTitle { background-color: #7F8FB1; color: #fff; font-size:130%; text-align: left; padding: 2px 6px 2px 6px; border: 1px #7F8FB1 solid; } div.sectionTitle { margin-bottom: 8px; } .summaryTable thead { display: none; } .summaryTable td { vertical-align: top; padding: 4px; border-bottom: 1px #7F8FB1 solid; border-right: 1px #7F8FB1 solid; } /*col#summaryAttributes {}*/ .summaryTable td.attributes { border-left: 1px #7F8FB1 solid; width: 140px; text-align: right; } td.attributes, .fixedFont { line-height: 15px; color: #002EBE; font-family: "Courier New",Courier,monospace; font-size: 13px; } .summaryTable td.nameDescription { text-align: left; font-size: 13px; line-height: 15px; } .summaryTable td.nameDescription, .description { line-height: 15px; padding: 4px; padding-left: 4px; } .summaryTable { margin-bottom: 8px; } ul.inheritsList { list-style: square; margin-left: 20px; padding-left: 0; } .detailList { margin-left: 20px; line-height: 15px; } .detailList dt { margin-left: 20px; } .detailList .heading { font-weight: bold; padding-bottom: 6px; margin-left: 0; } .light, td.attributes, .light a:link, .light a:visited { color: #777; font-style: italic; } .fineprint { text-align: right; font-size: 10px; } </style> </head> <body> <!-- ============================== header ================================= --> <!-- begin static/header.html --> <div id="header"> </div> <!-- end static/header.html --> <!-- ============================== classes index ============================ --> <div id="index"> <!-- begin publish.classesIndex --> <div align="center"><a href="../index.html">Class Index</a> | <a href="../files.html">File Index</a></div> <hr /> <h2>Classes</h2> <ul class="classList"> <li><i><a href="../symbols/_global_.html">_global_</a></i></li> <li><a href="../symbols/jasmine.html">jasmine</a></li> <li><a href="../symbols/jasmine.Block.html">jasmine.Block</a></li> <li><a href="../symbols/jasmine.Clock.html">jasmine.Clock</a></li> <li><a href="../symbols/jasmine.Env.html">jasmine.Env</a></li> <li><a href="../symbols/jasmine.JsApiReporter.html">jasmine.JsApiReporter</a></li> <li><a href="../symbols/jasmine.Matchers.html">jasmine.Matchers</a></li> <li><a href="../symbols/jasmine.MultiReporter.html">jasmine.MultiReporter</a></li> <li><a href="../symbols/jasmine.NestedResults.html">jasmine.NestedResults</a></li> <li><a href="../symbols/jasmine.Reporter.html">jasmine.Reporter</a></li> <li><a href="../symbols/jasmine.Runner.html">jasmine.Runner</a></li> <li><a href="../symbols/jasmine.Spec.html">jasmine.Spec</a></li> <li><a href="../symbols/jasmine.Spy.html">jasmine.Spy</a></li> <li><a href="../symbols/jasmine.Suite.html">jasmine.Suite</a></li> <li><a href="../symbols/jasmine.util.html">jasmine.util</a></li> </ul> <hr /> <!-- end publish.classesIndex --> </div> <div id="content"> <!-- ============================== class title ============================ --> <h1 class="classTitle"> Class jasmine.Env </h1> <!-- ============================== class summary ========================== --> <p class="description"> <br /><i>Defined in: </i> <a href="../symbols/src/src_Env.js.html">Env.js</a>. </p> <!-- ============================== constructor summary ==================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jasmine.Env."> <caption>Class Summary</caption> <thead> <tr> <th scope="col">Constructor Attributes</th> <th scope="col">Constructor Name and Description</th> </tr> </thead> <tbody> <tr> <td class="attributes"> </td> <td class="nameDescription" > <div class="fixedFont"> <b><a href="../symbols/jasmine.Env.html">jasmine.Env</a></b>() </div> <div class="description">Environment for Jasmine</div> </td> </tr> </tbody> </table> <!-- ============================== properties summary ===================== --> <!-- ============================== methods summary ======================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jasmine.Env."> <caption>Method Summary</caption> <thead> <tr> <th scope="col">Method Attributes</th> <th scope="col">Method Name and Description</th> </tr> </thead> <tbody> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#addEqualityTester">addEqualityTester</a></b>(equalityTester) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#addReporter">addReporter</a></b>(reporter) </div> <div class="description">Register a reporter to receive status updates from Jasmine.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#afterEach">afterEach</a></b>(afterEachFunction) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#beforeEach">beforeEach</a></b>(beforeEachFunction) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#compareObjects_">compareObjects_</a></b>(a, b, mismatchKeys, mismatchValues) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#contains_">contains_</a></b>(haystack, needle) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#currentRunner">currentRunner</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#describe">describe</a></b>(description, specDefinitions) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#equals_">equals_</a></b>(a, b, mismatchKeys, mismatchValues) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#execute">execute</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#it">it</a></b>(description, func) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#matchersClass">matchersClass</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#nextSpecId">nextSpecId</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#nextSuiteId">nextSuiteId</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#specFilter">specFilter</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#version">version</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#versionString">versionString</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#xdescribe">xdescribe</a></b>(desc, specDefinitions) </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.Env.html#xit">xit</a></b>(desc, func) </div> <div class="description"></div> </td> </tr> </tbody> </table> <!-- ============================== events summary ======================== --> <!-- ============================== constructor details ==================== --> <div class="details"><a name="constructor"> </a> <div class="sectionTitle"> Class Detail </div> <div class="fixedFont"> <b>jasmine.Env</b>() </div> <div class="description"> Environment for Jasmine </div> </div> <!-- ============================== field details ========================== --> <!-- ============================== method details ========================= --> <div class="sectionTitle"> Method Detail </div> <a name="addEqualityTester"> </a> <div class="fixedFont"> <b>addEqualityTester</b>(equalityTester) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>equalityTester</b> </dt> <dd></dd> </dl> <hr /> <a name="addReporter"> </a> <div class="fixedFont"> <b>addReporter</b>(reporter) </div> <div class="description"> Register a reporter to receive status updates from Jasmine. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{<a href="../symbols/jasmine.Reporter.html">jasmine.Reporter</a>}</span> <b>reporter</b> </dt> <dd>An object which will receive status updates.</dd> </dl> <hr /> <a name="afterEach"> </a> <div class="fixedFont"> <b>afterEach</b>(afterEachFunction) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>afterEachFunction</b> </dt> <dd></dd> </dl> <hr /> <a name="beforeEach"> </a> <div class="fixedFont"> <b>beforeEach</b>(beforeEachFunction) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>beforeEachFunction</b> </dt> <dd></dd> </dl> <hr /> <a name="compareObjects_"> </a> <div class="fixedFont"> <b>compareObjects_</b>(a, b, mismatchKeys, mismatchValues) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>a</b> </dt> <dd></dd> <dt> <b>b</b> </dt> <dd></dd> <dt> <b>mismatchKeys</b> </dt> <dd></dd> <dt> <b>mismatchValues</b> </dt> <dd></dd> </dl> <hr /> <a name="contains_"> </a> <div class="fixedFont"> <b>contains_</b>(haystack, needle) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>haystack</b> </dt> <dd></dd> <dt> <b>needle</b> </dt> <dd></dd> </dl> <hr /> <a name="currentRunner"> </a> <div class="fixedFont"> <b>currentRunner</b>() </div> <div class="description"> </div> <hr /> <a name="describe"> </a> <div class="fixedFont"> <b>describe</b>(description, specDefinitions) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>description</b> </dt> <dd></dd> <dt> <b>specDefinitions</b> </dt> <dd></dd> </dl> <hr /> <a name="equals_"> </a> <div class="fixedFont"> <b>equals_</b>(a, b, mismatchKeys, mismatchValues) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>a</b> </dt> <dd></dd> <dt> <b>b</b> </dt> <dd></dd> <dt> <b>mismatchKeys</b> </dt> <dd></dd> <dt> <b>mismatchValues</b> </dt> <dd></dd> </dl> <hr /> <a name="execute"> </a> <div class="fixedFont"> <b>execute</b>() </div> <div class="description"> </div> <hr /> <a name="it"> </a> <div class="fixedFont"> <b>it</b>(description, func) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>description</b> </dt> <dd></dd> <dt> <b>func</b> </dt> <dd></dd> </dl> <hr /> <a name="matchersClass"> </a> <div class="fixedFont"> <b>matchersClass</b>() </div> <div class="description"> </div> <hr /> <a name="nextSpecId"> </a> <div class="fixedFont"> <b>nextSpecId</b>() </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Returns:</dt> <dd>a sequential integer starting at 0</dd> </dl> <hr /> <a name="nextSuiteId"> </a> <div class="fixedFont"> <b>nextSuiteId</b>() </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Returns:</dt> <dd>a sequential integer starting at 0</dd> </dl> <hr /> <a name="specFilter"> </a> <div class="fixedFont"> <b>specFilter</b>() </div> <div class="description"> </div> <hr /> <a name="version"> </a> <div class="fixedFont"> <b>version</b>() </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Returns:</dt> <dd>an object containing jasmine version build info, if set.</dd> </dl> <hr /> <a name="versionString"> </a> <div class="fixedFont"> <b>versionString</b>() </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Returns:</dt> <dd>string containing jasmine version build info, if set.</dd> </dl> <hr /> <a name="xdescribe"> </a> <div class="fixedFont"> <b>xdescribe</b>(desc, specDefinitions) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>desc</b> </dt> <dd></dd> <dt> <b>specDefinitions</b> </dt> <dd></dd> </dl> <hr /> <a name="xit"> </a> <div class="fixedFont"> <b>xit</b>(desc, func) </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>desc</b> </dt> <dd></dd> <dt> <b>func</b> </dt> <dd></dd> </dl> <!-- ============================== event details ========================= --> <hr /> </div> <!-- ============================== footer ================================= --> <div class="fineprint" style="clear:both"> Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Wed Jun 23 2010 11:30:43 GMT-0700 (PDT) </div> </body> </html>