github-migration
/
jasmine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
jasmine/doc/symbols/jasmine.Matchers.html

884 lines
18 KiB
HTML
Raw Normal View History

added tests for mockclock
2009-10-27 23:49:23 +00:00
<!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.Matchers</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.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.Matchers
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
Generate docs from source files, not lib.
2009-11-10 19:28:47 +00:00
<br /><i>Defined in: </i> <a href="../symbols/src/src_Matchers.js.html">Matchers.js</a>.
added tests for mockclock
2009-10-27 23:49:23 +00:00
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jasmine.Matchers.">
<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">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
Generate docs from source files, not lib.
2009-11-10 19:28:47 +00:00
<b><a href="../symbols/jasmine.Matchers.html">jasmine.Matchers</a></b>(env, actual, spec)
added tests for mockclock
2009-10-27 23:49:23 +00:00
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
Ruby runner changes. Users of previous versions with Rake tasks that make use of additional runner options (helpers, etc) may be broken.
2009-11-01 04:47:11 +00:00
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jasmine.Matchers.">
<caption>Field Summary</caption>
<thead>
<tr>
<th scope="col">Field Attributes</th>
<th scope="col">Field Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toBe">toBe</a></b>
</div>
<div class="description">toBe: compares the actual to the expected using ===</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toBeDefined">toBeDefined</a></b>
</div>
<div class="description">Matcher that compares the acutal to undefined.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toBeFalsy">toBeFalsy</a></b>
</div>
<div class="description">Matcher that boolean nots the actual.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toBeNull">toBeNull</a></b>
</div>
<div class="description">Matcher that compares the actual to null.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toBeTruthy">toBeTruthy</a></b>
</div>
<div class="description">Matcher that boolean not-nots the actual.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toBeUndefined">toBeUndefined</a></b>
</div>
<div class="description">Matcher that compares the acutal to undefined.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toContain">toContain</a></b>
</div>
<div class="description">Matcher that checks that the expected item is an element in the actual Array.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toEqual">toEqual</a></b>
</div>
<div class="description">toEqual: compares the actual to the expected using common sense equality.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toMatch">toMatch</a></b>
</div>
<div class="description">Matcher that compares the actual to the expected using a regular expression.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toNotBe">toNotBe</a></b>
</div>
<div class="description">toNotBe: compares the actual to the expected using !==</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toNotContain">toNotContain</a></b>
</div>
<div class="description">Matcher that checks that the expected item is NOT an element in the actual Array.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toNotEqual">toNotEqual</a></b>
</div>
<div class="description">toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toNotMatch">toNotMatch</a></b>
</div>
<div class="description">Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#toThrow">toThrow</a></b>
</div>
<div class="description">Matcher that checks that the expected exception was thrown by the actual.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#wasCalled">wasCalled</a></b>
</div>
<div class="description">Matcher that checks to see if the acutal, a Jasmine spy, was called.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/jasmine.Matchers.html#wasNotCalled">wasNotCalled</a></b>
</div>
<div class="description">Matcher that checks to see if the acutal, a Jasmine spy, was not called.</div>
</td>
</tr>
</tbody>
</table>
added tests for mockclock
2009-10-27 23:49:23 +00:00
<!-- ============================== methods summary ======================== -->
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont">
Generate docs from source files, not lib.
2009-11-10 19:28:47 +00:00
<b>jasmine.Matchers</b>(env, actual, spec)
added tests for mockclock
2009-10-27 23:49:23 +00:00
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/jasmine.Env.html">jasmine.Env</a>}</span> <b>env</b>
</dt>
<dd></dd>
<dt>
<b>actual</b>
</dt>
<dd></dd>
<dt>
Generate docs from source files, not lib.
2009-11-10 19:28:47 +00:00
<span class="light fixedFont">{<a href="../symbols/jasmine.Spec.html">jasmine.Spec</a>}</span> <b>spec</b>
added tests for mockclock
2009-10-27 23:49:23 +00:00
</dt>
<dd></dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
Ruby runner changes. Users of previous versions with Rake tasks that make use of additional runner options (helpers, etc) may be broken.
2009-11-01 04:47:11 +00:00
<div class="sectionTitle">
Field Detail
</div>
<a name="toBe"> </a>
<div class="fixedFont">
<b>toBe</b>
</div>
<div class="description">
toBe: compares the actual to the expected using ===
</div>
<hr />
<a name="toBeDefined"> </a>
<div class="fixedFont">
<b>toBeDefined</b>
</div>
<div class="description">
Matcher that compares the acutal to undefined.
</div>
<hr />
<a name="toBeFalsy"> </a>
<div class="fixedFont">
<b>toBeFalsy</b>
</div>
<div class="description">
Matcher that boolean nots the actual.
</div>
<hr />
<a name="toBeNull"> </a>
<div class="fixedFont">
<b>toBeNull</b>
</div>
<div class="description">
Matcher that compares the actual to null.
</div>
<hr />
<a name="toBeTruthy"> </a>
<div class="fixedFont">
<b>toBeTruthy</b>
</div>
<div class="description">
Matcher that boolean not-nots the actual.
</div>
<hr />
<a name="toBeUndefined"> </a>
<div class="fixedFont">
<b>toBeUndefined</b>
</div>
<div class="description">
Matcher that compares the acutal to undefined.
</div>
<hr />
<a name="toContain"> </a>
<div class="fixedFont">
<b>toContain</b>
</div>
<div class="description">
Matcher that checks that the expected item is an element in the actual Array.
</div>
<hr />
<a name="toEqual"> </a>
<div class="fixedFont">
<b>toEqual</b>
</div>
<div class="description">
toEqual: compares the actual to the expected using common sense equality. Handles Objects, Arrays, etc.
</div>
<hr />
<a name="toMatch"> </a>
<div class="fixedFont">
<b>toMatch</b>
</div>
<div class="description">
Matcher that compares the actual to the expected using a regular expression. Constructs a RegExp, so takes
a pattern or a String.
</div>
<hr />
<a name="toNotBe"> </a>
<div class="fixedFont">
<b>toNotBe</b>
</div>
<div class="description">
toNotBe: compares the actual to the expected using !==
</div>
<hr />
<a name="toNotContain"> </a>
<div class="fixedFont">
<b>toNotContain</b>
</div>
<div class="description">
Matcher that checks that the expected item is NOT an element in the actual Array.
</div>
<hr />
<a name="toNotEqual"> </a>
<div class="fixedFont">
<b>toNotEqual</b>
</div>
<div class="description">
toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual
</div>
<hr />
<a name="toNotMatch"> </a>
<div class="fixedFont">
<b>toNotMatch</b>
</div>
<div class="description">
Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch
</div>
<hr />
<a name="toThrow"> </a>
<div class="fixedFont">
<b>toThrow</b>
</div>
<div class="description">
Matcher that checks that the expected exception was thrown by the actual.
</div>
<hr />
<a name="wasCalled"> </a>
<div class="fixedFont">
<b>wasCalled</b>
</div>
<div class="description">
Matcher that checks to see if the acutal, a Jasmine spy, was called.
</div>
<hr />
<a name="wasNotCalled"> </a>
<div class="fixedFont">
<b>wasNotCalled</b>
</div>
<div class="description">
Matcher that checks to see if the acutal, a Jasmine spy, was not called.
</div>
added tests for mockclock
2009-10-27 23:49:23 +00:00
<!-- ============================== method details ========================= -->
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Generate docs from source files, not lib.
2009-11-10 19:28:47 +00:00
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Tue Nov 10 2009 14:27:06 GMT-0500 (EST)
added tests for mockclock
2009-10-27 23:49:23 +00:00
</div>
</body>
</html>