doc/jasmine/symbols/jasmine.Matchers.html in smparkes-jazrb-0.0.10 vs doc/jasmine/symbols/jasmine.Matchers.html in smparkes-jazrb-0.0.11

- old
+ new

@@ -266,236 +266,238 @@ </table> <!-- ============================== properties summary ===================== --> + +<!-- ============================== methods summary ======================== --> + - <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jasmine.Matchers."> - <caption>Field Summary</caption> + <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jasmine.Matchers."> + <caption>Method Summary</caption> <thead> <tr> - <th scope="col">Field Attributes</th> - <th scope="col">Field Name and Description</th> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> </tr> </thead> <tbody> <tr> + <td class="attributes">&lt;static&gt; &nbsp;</td> + <td class="nameDescription"> + <div class="fixedFont">jasmine.Matchers.<b><a href="../symbols/jasmine.Matchers.html#.Any">Any</a></b>(expectedClass) + </div> + <div class="description"></div> + </td> + </tr> + + <tr> + <td class="attributes">&lt;static&gt; &nbsp;</td> + <td class="nameDescription"> + <div class="fixedFont">jasmine.Matchers.<b><a href="../symbols/jasmine.Matchers.html#.matcherFn_">matcherFn_</a></b>(matcherName, matcherFunction) + </div> + <div class="description"></div> + </td> + </tr> + + <tr> <td class="attributes">&nbsp;</td> <td class="nameDescription"> - <div class="fixedFont"> - <b><a href="../symbols/jasmine.Matchers.html#toBe">toBe</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#message">message</a></b>(expected) </div> - <div class="description">toBe: compares the actual to the expected using ===</div> + <div class="description"></div> </td> </tr> <tr> + <td class="attributes">&lt;static&gt; &nbsp;</td> + <td class="nameDescription"> + <div class="fixedFont">jasmine.Matchers.<b><a href="../symbols/jasmine.Matchers.html#.pp">pp</a></b>(str) + </div> + <div class="description"></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 class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#report">report</a></b>(result, failing_message, details) </div> - <div class="description">Matcher that compares the acutal to undefined.</div> + <div class="description"></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 class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toBe">toBe</a></b>(expected) </div> - <div class="description">Matcher that boolean nots the actual.</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#toBeNull">toBeNull</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toBeDefined">toBeDefined</a></b>() </div> - <div class="description">Matcher that compares the actual to null.</div> + <div class="description">Matcher that compares the actual to undefined.</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 class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toBeFalsy">toBeFalsy</a></b>() </div> - <div class="description">Matcher that boolean not-nots the actual.</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#toBeUndefined">toBeUndefined</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toBeGreaterThan">toBeGreaterThan</a></b>(expected) </div> - <div class="description">Matcher that compares the acutal to undefined.</div> + <div class="description"></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 class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toBeLessThan">toBeLessThan</a></b>(expected) </div> - <div class="description">Matcher that checks that the expected item is an element in the actual Array.</div> + <div class="description"></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 class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toBeNull">toBeNull</a></b>() </div> - <div class="description">toEqual: compares the actual to the expected using common sense equality.</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#toMatch">toMatch</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toBeTruthy">toBeTruthy</a></b>() </div> - <div class="description">Matcher that compares the actual to the expected using a regular expression.</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#toNotBe">toNotBe</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toBeUndefined">toBeUndefined</a></b>() </div> - <div class="description">toNotBe: compares the actual to the expected using !==</div> + <div class="description">Matcher that compares the actual to undefined.</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 class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toContain">toContain</a></b>(item) </div> - <div class="description">Matcher that checks that the expected item is NOT an element in the actual Array.</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#toNotEqual">toNotEqual</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toEqual">toEqual</a></b>(expected) </div> - <div class="description">toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual</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#toNotMatch">toNotMatch</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toMatch">toMatch</a></b>(reg_exp) </div> - <div class="description">Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch</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#toThrow">toThrow</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toNotBe">toNotBe</a></b>(expected) </div> - <div class="description">Matcher that checks that the expected exception was thrown by the actual.</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#wasCalled">wasCalled</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toNotContain">toNotContain</a></b>(item) </div> - <div class="description">Matcher that checks to see if the acutal, a Jasmine spy, was called.</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#wasNotCalled">wasNotCalled</a></b> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toNotEqual">toNotEqual</a></b>(expected) </div> - <div class="description">Matcher that checks to see if the acutal, a Jasmine spy, was not called.</div> + <div class="description">toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual</div> </td> </tr> - </tbody> - </table> - - - - - -<!-- ============================== methods summary ======================== --> - - - - <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jasmine.Matchers."> - <caption>Method Summary</caption> - <thead> <tr> - <th scope="col">Method Attributes</th> - <th scope="col">Method Name and Description</th> + <td class="attributes">&nbsp;</td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toNotMatch">toNotMatch</a></b>(reg_exp) + </div> + <div class="description">Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch</div> + </td> </tr> - </thead> - <tbody> <tr> - <td class="attributes">&lt;static&gt; &nbsp;</td> + <td class="attributes">&nbsp;</td> <td class="nameDescription"> - <div class="fixedFont">jasmine.Matchers.<b><a href="../symbols/jasmine.Matchers.html#.Any">Any</a></b>(expectedClass) + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#toThrow">toThrow</a></b>(expectedException) </div> - <div class="description"></div> + <div class="description">Matcher that checks that the expected exception was thrown by the actual.</div> </td> </tr> <tr> - <td class="attributes">&lt;static&gt; &nbsp;</td> + <td class="attributes">&nbsp;</td> <td class="nameDescription"> - <div class="fixedFont">jasmine.Matchers.<b><a href="../symbols/jasmine.Matchers.html#.matcherFn_">matcherFn_</a></b>(matcherName, options) + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#wasCalled">wasCalled</a></b>() </div> - <div class="description"></div> + <div class="description">Matcher that checks to see if the actual, a Jasmine spy, was called.</div> </td> </tr> <tr> - <td class="attributes">&lt;static&gt; &nbsp;</td> + <td class="attributes">&nbsp;</td> <td class="nameDescription"> - <div class="fixedFont">jasmine.Matchers.<b><a href="../symbols/jasmine.Matchers.html#.pp">pp</a></b>(str) + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#wasCalledWith">wasCalledWith</a></b>() </div> - <div class="description"></div> + <div class="description">Matcher that checks to see if the actual, a Jasmine spy, was called with a set of parameters.</div> </td> </tr> <tr> <td class="attributes">&nbsp;</td> <td class="nameDescription"> - <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#report">report</a></b>(result, failing_message, details) + <div class="fixedFont"><b><a href="../symbols/jasmine.Matchers.html#wasNotCalled">wasNotCalled</a></b>() </div> - <div class="description"></div> + <div class="description">Matcher that checks to see if the actual, a Jasmine spy, was not called.</div> </td> </tr> </tbody> </table> @@ -559,396 +561,578 @@ </div> <!-- ============================== field details ========================== --> + +<!-- ============================== method details ========================= --> + <div class="sectionTitle"> - Field Detail + Method Detail </div> - <a name="toBe"> </a> - <div class="fixedFont"> + <a name=".Any"> </a> + <div class="fixedFont">&lt;static&gt; - <b>toBe</b> + <span class="light">jasmine.Matchers.</span><b>Any</b>(expectedClass) </div> <div class="description"> - toBe: compares the actual to the expected using === + </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>expectedClass</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="toBeDefined"> </a> - <div class="fixedFont"> + <a name=".matcherFn_"> </a> + <div class="fixedFont">&lt;static&gt; - <b>toBeDefined</b> + <span class="light">jasmine.Matchers.</span><b>matcherFn_</b>(matcherName, matcherFunction) </div> <div class="description"> - Matcher that compares the acutal to undefined. + </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>matcherName</b> + + </dt> + <dd></dd> + + <dt> + <b>matcherFunction</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="toBeFalsy"> </a> + <a name="message"> </a> <div class="fixedFont"> - <b>toBeFalsy</b> + <b>message</b>(expected) </div> <div class="description"> - Matcher that boolean nots the actual. + </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>expected</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="toBeNull"> </a> - <div class="fixedFont"> + <a name=".pp"> </a> + <div class="fixedFont">&lt;static&gt; - <b>toBeNull</b> + <span class="light">jasmine.Matchers.</span><b>pp</b>(str) </div> <div class="description"> - Matcher that compares the actual to null. + </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>str</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="toBeTruthy"> </a> + <a name="report"> </a> <div class="fixedFont"> - <b>toBeTruthy</b> + <b>report</b>(result, failing_message, details) </div> <div class="description"> - Matcher that boolean not-nots the actual. + </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>result</b> + + </dt> + <dd></dd> + + <dt> + <b>failing_message</b> + + </dt> + <dd></dd> + + <dt> + <b>details</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="toBeUndefined"> </a> + <a name="toBe"> </a> <div class="fixedFont"> - <b>toBeUndefined</b> + <b>toBe</b>(expected) </div> <div class="description"> - Matcher that compares the acutal to undefined. + toBe: compares the actual to the expected using === </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>expected</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="toContain"> </a> + <a name="toBeDefined"> </a> <div class="fixedFont"> - <b>toContain</b> + <b>toBeDefined</b>() </div> <div class="description"> - Matcher that checks that the expected item is an element in the actual Array. + Matcher that compares the actual to undefined. </div> - + + + + <hr /> - <a name="toEqual"> </a> + <a name="toBeFalsy"> </a> <div class="fixedFont"> - <b>toEqual</b> + <b>toBeFalsy</b>() </div> <div class="description"> - toEqual: compares the actual to the expected using common sense equality. Handles Objects, Arrays, etc. + Matcher that boolean nots the actual. </div> - + + + + <hr /> - <a name="toMatch"> </a> + <a name="toBeGreaterThan"> </a> <div class="fixedFont"> - <b>toMatch</b> + <b>toBeGreaterThan</b>(expected) </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> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>expected</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="toNotBe"> </a> + <a name="toBeLessThan"> </a> <div class="fixedFont"> - <b>toNotBe</b> + <b>toBeLessThan</b>(expected) </div> <div class="description"> - toNotBe: compares the actual to the expected using !== + </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>expected</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="toNotContain"> </a> + <a name="toBeNull"> </a> <div class="fixedFont"> - <b>toNotContain</b> + <b>toBeNull</b>() </div> <div class="description"> - Matcher that checks that the expected item is NOT an element in the actual Array. + Matcher that compares the actual to null. </div> - + + + + <hr /> - <a name="toNotEqual"> </a> + <a name="toBeTruthy"> </a> <div class="fixedFont"> - <b>toNotEqual</b> + <b>toBeTruthy</b>() </div> <div class="description"> - toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual + Matcher that boolean not-nots the actual. </div> - + + + + <hr /> - <a name="toNotMatch"> </a> + <a name="toBeUndefined"> </a> <div class="fixedFont"> - <b>toNotMatch</b> + <b>toBeUndefined</b>() </div> <div class="description"> - Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch + Matcher that compares the actual to undefined. </div> - + + + + <hr /> - <a name="toThrow"> </a> + <a name="toContain"> </a> <div class="fixedFont"> - <b>toThrow</b> + <b>toContain</b>(item) </div> <div class="description"> - Matcher that checks that the expected exception was thrown by the actual. + Matcher that checks that the expected item is an element in the actual Array. </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Object}</span> <b>item</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="wasCalled"> </a> + <a name="toEqual"> </a> <div class="fixedFont"> - <b>wasCalled</b> + <b>toEqual</b>(expected) </div> <div class="description"> - Matcher that checks to see if the acutal, a Jasmine spy, was called. + toEqual: compares the actual to the expected using common sense equality. Handles Objects, Arrays, etc. </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>expected</b> + + </dt> + <dd></dd> + + </dl> + + + + <hr /> - <a name="wasNotCalled"> </a> + <a name="toMatch"> </a> <div class="fixedFont"> - <b>wasNotCalled</b> + <b>toMatch</b>(reg_exp) </div> <div class="description"> - Matcher that checks to see if the acutal, a Jasmine spy, was not called. + Matcher that compares the actual to the expected using a regular expression. Constructs a RegExp, so takes +a pattern or a String. </div> - + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b>reg_exp</b> + + </dt> + <dd></dd> + + </dl> + + + + - + <hr /> - - -<!-- ============================== method details ========================= --> - - <div class="sectionTitle"> - Method Detail - </div> - - <a name=".Any"> </a> - <div class="fixedFont">&lt;static&gt; + <a name="toNotBe"> </a> + <div class="fixedFont"> - <span class="light">jasmine.Matchers.</span><b>Any</b>(expectedClass) + <b>toNotBe</b>(expected) </div> <div class="description"> + toNotBe: compares the actual to the expected using !== - </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> - <b>expectedClass</b> + <b>expected</b> </dt> <dd></dd> </dl> @@ -960,41 +1144,35 @@ <hr /> - <a name=".matcherFn_"> </a> - <div class="fixedFont">&lt;static&gt; + <a name="toNotContain"> </a> + <div class="fixedFont"> - <span class="light">jasmine.Matchers.</span><b>matcherFn_</b>(matcherName, options) + <b>toNotContain</b>(item) </div> <div class="description"> + Matcher that checks that the expected item is NOT an element in the actual Array. - </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> - <b>matcherName</b> + <span class="light fixedFont">{Object}</span> <b>item</b> </dt> <dd></dd> - <dt> - <b>options</b> - - </dt> - <dd></dd> - </dl> @@ -1002,31 +1180,31 @@ <hr /> - <a name=".pp"> </a> - <div class="fixedFont">&lt;static&gt; + <a name="toNotEqual"> </a> + <div class="fixedFont"> - <span class="light">jasmine.Matchers.</span><b>pp</b>(str) + <b>toNotEqual</b>(expected) </div> <div class="description"> + toNotEqual: compares the actual to the expected using the ! of jasmine.Matchers.toEqual - </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> - <b>str</b> + <b>expected</b> </dt> <dd></dd> </dl> @@ -1038,43 +1216,67 @@ <hr /> - <a name="report"> </a> + <a name="toNotMatch"> </a> <div class="fixedFont"> - <b>report</b>(result, failing_message, details) + <b>toNotMatch</b>(reg_exp) </div> <div class="description"> + Matcher that compares the actual to the expected using the boolean inverse of jasmine.Matchers.toMatch - </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> - <b>result</b> + <b>reg_exp</b> </dt> <dd></dd> - <dt> - <b>failing_message</b> - - </dt> - <dd></dd> + </dl> + + + + + + + + + <hr /> + + <a name="toThrow"> </a> + <div class="fixedFont"> + + + <b>toThrow</b>(expectedException) + + </div> + <div class="description"> + Matcher that checks that the expected exception was thrown by the actual. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> <dt> - <b>details</b> + <span class="light fixedFont">{String}</span> <b>expectedException</b> </dt> <dd></dd> </dl> @@ -1084,12 +1286,91 @@ + <hr /> + + <a name="wasCalled"> </a> + <div class="fixedFont"> + + <b>wasCalled</b>() + + </div> + <div class="description"> + Matcher that checks to see if the actual, a Jasmine spy, was called. + + + </div> + + + + + + + + + + + + <hr /> + <a name="wasCalledWith"> </a> + <div class="fixedFont"> + + + <b>wasCalledWith</b>() + + </div> + <div class="description"> + Matcher that checks to see if the actual, a Jasmine spy, was called with a set of parameters. + + + </div> + + + + <pre class="code"></pre> + + + + + + + + + + + + <hr /> + + <a name="wasNotCalled"> </a> + <div class="fixedFont"> + + + <b>wasNotCalled</b>() + + </div> + <div class="description"> + Matcher that checks to see if the actual, a Jasmine spy, was not called. + + + </div> + + + + + + + + + + + + + <!-- ============================== event details ========================= --> @@ -1098,9 +1379,9 @@ <!-- ============================== 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 Nov 18 2009 19:59:27 GMT-0800 (PST) + Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Wed Nov 25 2009 11:27:06 GMT-0800 (PST) </div> </body> </html>