unexpected
Version:
Extensible BDD assertion toolkit
104 lines (92 loc) • 7.17 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=0">
<link rel="stylesheet" href="../../static/normalize.css" type="text/css" media="screen" />
<link rel="stylesheet" href="../../static/main.css" type="text/css" media="screen" />
<title>fail</title>
</head>
<body class="sidebar-hidden has-sidebar">
<header>
<div class="logo-icon"></div>
<nav>
<ul>
<li class="menu-toggle-item">
<button class="menu-toggle" onclick="toggleSidebar()"></button>
</li>
<li class=""><a href="../..">Unexpected</a></li>
<li class=""><a href="../../assertions/any/to-be-a">Assertions</a></li>
<li class="active"><a href="../addAssertion">API</a></li>
</ul>
</nav>
</header>
<section id="api">
<nav id="api-menu" class="sidebar js-remember-scroll-position">
<ul>
<li class="">
<a href="../addAssertion">addAssertion</a>
</li>
<li class="">
<a href="../addType">addType</a>
</li>
<li class="">
<a href="../clone">clone</a>
</li>
<li class="active">
<a href="">fail</a>
</li>
<li class="">
<a href="../installPlugin">installPlugin</a>
</li>
<li class="">
<a href="../toString">toString</a>
</li>
</ul>
</nav>
<div class="main">
<div class="content">
<h2 id="expect-fail-">expect.fail(...)</h2>
<p>Explicitly forces failure.</p>
<div class="code lang-javascript">
<div>expect<span style="color: #000000">.</span><span style="color: #000000">fail</span><span style="color: #000000">()</span></div>
</div><div class="output">
<div><span style="color: red; font-weight: bold">Explicit failure</span></div>
</div><div class="code lang-javascript">
<div>expect<span style="color: #000000">.</span><span style="color: #000000">fail</span><span style="color: #000000">(</span><span style="color: #df5000">'Custom failure message'</span><span style="color: #000000">)</span></div>
</div><div class="output">
<div><span style="color: red; font-weight: bold">Custom failure message</span></div>
</div><div class="code lang-javascript">
<div>expect<span style="color: #000000">.</span><span style="color: #000000">fail</span><span style="color: #000000">(</span><span style="color: #df5000">'{0} was expected to be {1}'</span><span style="color: #000000">,</span> <span style="color: #0086b3">0</span><span style="color: #000000">,</span> <span style="color: #df5000">'zero'</span><span style="color: #000000">);</span></div>
</div><div class="output">
<div><span style="color: #0086b3">0</span><span style="color: red; font-weight: bold"> was expected to be </span><span style="color: #df5000">'zero'</span></div>
</div><p>I case you want to rethrow an error, you should always use
<code>expect.fail</code>, as it ensures that the error message will be correct
for the different error modes.</p>
<div class="code lang-javascript">
<div><span style="color: #0086b3">var</span> error <span style="color: #a71d5d">=</span> <span style="color: #0086b3">new</span> Error<span style="color: #000000">(</span><span style="color: #df5000">'throw me'</span><span style="color: #000000">);</span></div>
<div>expect<span style="color: #000000">.</span><span style="color: #000000">fail</span><span style="color: #000000">(</span><span style="color: #0086b3">new</span> Error<span style="color: #000000">(</span>error<span style="color: #000000">));</span></div>
</div><div class="output">
<div><span style="color: red; font-weight: bold">Error: throw me</span></div>
</div><p>When you want to build a completely custom output, you can call
<code>expect.fail</code> with a callback and receive a
<a href="https://github.com/sunesimonsen/magicpen">magicpen</a> instance that the
output can be written to.</p>
<div class="code lang-javascript">
<div>expect<span style="color: #000000">.</span><span style="color: #000000">fail</span><span style="color: #000000">(</span><span style="color: #0086b3">function</span> <span style="color: #000000">(</span>output<span style="color: #000000">)</span> <span style="color: #000000">{</span></div>
<div> <span style="color: #df5000">'You have been a very bad boy!'</span><span style="color: #000000">.</span><span style="color: #000000">split</span><span style="color: #000000">(</span><span style="color: #df5000">/ /</span><span style="color: #000000">).</span><span style="color: #000000">forEach</span><span style="color: #000000">(</span><span style="color: #0086b3">function</span> <span style="color: #000000">(</span>word<span style="color: #000000">,</span> index<span style="color: #000000">)</span> <span style="color: #000000">{</span></div>
<div> <span style="color: #0086b3">if</span> <span style="color: #000000">(</span>index <span style="color: #a71d5d">></span> <span style="color: #0086b3">0</span><span style="color: #000000">)</span> <span style="color: #000000">{</span> output<span style="color: #000000">.</span><span style="color: #000000">sp</span><span style="color: #000000">();</span> <span style="color: #000000">}</span></div>
<div> <span style="color: #0086b3">var</span> style <span style="color: #a71d5d">=</span> index <span style="color: #a71d5d">%</span> <span style="color: #0086b3">2</span> <span style="color: #a71d5d">===</span> <span style="color: #0086b3">0</span> <span style="color: #a71d5d">?</span> <span style="color: #df5000">'jsPrimitive'</span> <span style="color: #000000">:</span> <span style="color: #df5000">'jsString'</span><span style="color: #000000">;</span></div>
<div> output<span style="color: #000000">[</span>style<span style="color: #000000">](</span>word<span style="color: #000000">);</span></div>
<div> <span style="color: #000000">});</span></div>
<div><span style="color: #000000">});</span></div>
</div><div class="output">
<div><span style="color: #0086b3">You</span> <span style="color: #df5000">have</span> <span style="color: #0086b3">been</span> <span style="color: #df5000">a</span> <span style="color: #0086b3">very</span> <span style="color: #df5000">bad</span> <span style="color: #0086b3">boy!</span></div>
</div>
</div>
</div>
</section>
<script type="text/javascript" src="../../static/toggleSidebar.js"></script>
<script type="text/javascript" src="../../static/rememberScrollPosition.js"></script>
</body>
</html>