jasmine/jsdoc/symbols/_global_.html

1132 lines
23 KiB
HTML

<!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 - _global_</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>
<li><a href="../symbols/jasmine.WaitsForBlock.html">jasmine.WaitsForBlock</a></li>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Built-In Namespace _global_
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
</p>
<!-- ============================== constructor summary ==================== -->
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class _global_.">
<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">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#afterEach">afterEach</a></b>(afterEachFunction)
</div>
<div class="description">A function that is called after each spec in a suite.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#beforeEach">beforeEach</a></b>(beforeEachFunction)
</div>
<div class="description">A function that is called before each spec in a suite.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#clearInterval">clearInterval</a></b>(timeoutKey)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#clearTimeout">clearTimeout</a></b>(timeoutKey)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#describe">describe</a></b>(description, specDefinitions)
</div>
<div class="description">Defines a suite of specifications.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#expect">expect</a></b>(actual)
</div>
<div class="description">Starts a chain for a Jasmine expectation.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#it">it</a></b>(desc, func)
</div>
<div class="description">Creates a Jasmine spec that will be added to the current suite.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#runs">runs</a></b>(func)
</div>
<div class="description">Defines part of a jasmine spec.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#setInterval">setInterval</a></b>(funcToCall, millis)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#setTimeout">setTimeout</a></b>(funcToCall, millis)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#spyOn">spyOn</a></b>(obj, methodName)
</div>
<div class="description">Function that installs a spy on an existing object's method name.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#waits">waits</a></b>(timeout)
</div>
<div class="description">Waits a fixed time period before moving to the next block.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#waitsFor">waitsFor</a></b>(latchFunction, optional_timeoutMessage, optional_timeout)
</div>
<div class="description">Waits for the latchFunction to return true before proceeding to the next block.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#xdescribe">xdescribe</a></b>(description, specDefinitions)
</div>
<div class="description">Disables a suite of specifications.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/_global_.html#xit">xit</a></b>(desc, func)
</div>
<div class="description">Creates a <em>disabled</em> Jasmine spec.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="afterEach"> </a>
<div class="fixedFont">
<b>afterEach</b>(afterEachFunction)
</div>
<div class="description">
A function that is called after each spec in a suite.
Used for restoring any state that is hijacked during spec execution.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Function}</span> <b>afterEachFunction</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="beforeEach"> </a>
<div class="fixedFont">
<b>beforeEach</b>(beforeEachFunction)
</div>
<div class="description">
A function that is called before each spec in a suite.
Used for spec setup, including validating assumptions.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Function}</span> <b>beforeEachFunction</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="clearInterval"> </a>
<div class="fixedFont">
<b>clearInterval</b>(timeoutKey)
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_mock-timeout.js.html">mock-timeout.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>timeoutKey</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="clearTimeout"> </a>
<div class="fixedFont">
<b>clearTimeout</b>(timeoutKey)
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_mock-timeout.js.html">mock-timeout.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>timeoutKey</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="describe"> </a>
<div class="fixedFont">
<b>describe</b>(description, specDefinitions)
</div>
<div class="description">
Defines a suite of specifications.
Stores the description and all defined specs in the Jasmine environment as one suite of specs. Variables declared
are accessible by calls to beforeEach, it, and afterEach. Describe blocks can be nested, allowing for specialization
of setup in some tests.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<pre class="code">// TODO: a simple suite
// TODO: a simple suite with a nested describe block</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>description</b>
</dt>
<dd>A string, usually the class under test.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>specDefinitions</b>
</dt>
<dd>function that defines several specs.</dd>
</dl>
<hr />
<a name="expect"> </a>
<div class="fixedFont">
<b>expect</b>(actual)
</div>
<div class="description">
Starts a chain for a Jasmine expectation.
It is passed an Object that is the actual value and should chain to one of the many
jasmine.Matchers functions.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>actual</b>
</dt>
<dd>Actual value to test against and expected value</dd>
</dl>
<hr />
<a name="it"> </a>
<div class="fixedFont">
<b>it</b>(desc, func)
</div>
<div class="description">
Creates a Jasmine spec that will be added to the current suite.
// TODO: pending tests
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<pre class="code">it('should be true', function() {
expect(true).toEqual(true);
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>desc</b>
</dt>
<dd>description of this specification</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>func</b>
</dt>
<dd>defines the preconditions and expectations of the spec</dd>
</dl>
<hr />
<a name="runs"> </a>
<div class="fixedFont">
<b>runs</b>(func)
</div>
<div class="description">
Defines part of a jasmine spec. Used in cominbination with waits or waitsFor in asynchrnous specs.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Function}</span> <b>func</b>
</dt>
<dd>Function that defines part of a jasmine spec.</dd>
</dl>
<hr />
<a name="setInterval"> </a>
<div class="fixedFont">
<b>setInterval</b>(funcToCall, millis)
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_mock-timeout.js.html">mock-timeout.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>funcToCall</b>
</dt>
<dd></dd>
<dt>
<b>millis</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="setTimeout"> </a>
<div class="fixedFont">
<b>setTimeout</b>(funcToCall, millis)
</div>
<div class="description">
<br />
<i>Defined in: </i> <a href="../symbols/src/src_mock-timeout.js.html">mock-timeout.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>funcToCall</b>
</dt>
<dd></dd>
<dt>
<b>millis</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="spyOn"> </a>
<div class="fixedFont">
<b>spyOn</b>(obj, methodName)
</div>
<div class="description">
Function that installs a spy on an existing object's method name. Used within a Spec to create a spy.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<pre class="code">// spy example
var foo = {
not: function(bool) { return !bool; }
}
spyOn(foo, 'not'); // actual foo.not will not be called, execution stops</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>obj</b>
</dt>
<dd></dd>
<dt>
<b>methodName</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd>a Jasmine spy that can be chained with all spy methods</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/jasmine.html#.createSpy">jasmine.createSpy</a></dd>
</dl>
<hr />
<a name="waits"> </a>
<div class="fixedFont">
<b>waits</b>(timeout)
</div>
<div class="description">
Waits a fixed time period before moving to the next block.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>timeout</b>
</dt>
<dd>milliseconds to wait</dd>
</dl>
<dl class="detailList">
<dt class="heading">Deprecated:</dt>
<dt>
Use waitsFor() instead
</dt>
</dl>
<hr />
<a name="waitsFor"> </a>
<div class="fixedFont">
<b>waitsFor</b>(latchFunction, optional_timeoutMessage, optional_timeout)
</div>
<div class="description">
Waits for the latchFunction to return true before proceeding to the next block.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Function}</span> <b>latchFunction</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{String}</span> <b>optional_timeoutMessage</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>optional_timeout</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="xdescribe"> </a>
<div class="fixedFont">
<b>xdescribe</b>(description, specDefinitions)
</div>
<div class="description">
Disables a suite of specifications. Used to disable some suites in a file, or files, temporarily during development.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>description</b>
</dt>
<dd>A string, usually the class under test.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>specDefinitions</b>
</dt>
<dd>function that defines several specs.</dd>
</dl>
<hr />
<a name="xit"> </a>
<div class="fixedFont">
<b>xit</b>(desc, func)
</div>
<div class="description">
Creates a <em>disabled</em> Jasmine spec.
A convenience method that allows existing specs to be disabled temporarily during development.
<br />
<i>Defined in: </i> <a href="../symbols/src/src_base.js.html">base.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>desc</b>
</dt>
<dd>description of this specification</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>func</b>
</dt>
<dd>defines the preconditions and expectations of the spec</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 Tue Sep 14 2010 12:54:37 GMT-0700 (PDT)
</div>
</body>
</html>