unexpected
Version:
Extensible BDD assertion toolkit
181 lines (153 loc) • 14.3 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" />
<link rel="shortcut icon" type="image/vnd.microsoft.icon" href="../../static/bug-icon-black.ico">
<title>withError</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">Assertions</a></li>
<li class="active"><a href="../addAssertion">API</a></li>
<li class=""><a href="../../plugins">Plugins</a></li>
</ul>
</nav>
<div class="search" style="visibility: hidden">
<input id="search" placeholder="Search..." value="">
<div id="searchDropDown" class="dropDown">
<ul id="searchResults"></ul>
</div>
</div>
</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="../async">async</a>
</li>
<li class="">
<a href="../clone">clone</a>
</li>
<li class="">
<a href="../expect">expect</a>
</li>
<li class="">
<a href="../fail">fail</a>
</li>
<li class="">
<a href="../promise">promise</a>
</li>
<li class="">
<a href="../promise-all">promise.all</a>
</li>
<li class="">
<a href="../promise-any">promise.any</a>
</li>
<li class="">
<a href="../promise-settle">promise.settle</a>
</li>
<li class="">
<a href="../toString">toString</a>
</li>
<li class="">
<a href="../UnexpectedError">UnexpectedError</a>
</li>
<li class="">
<a href="../use">use</a>
</li>
<li class="active">
<a href="">withError</a>
</li>
</ul>
</nav>
<div class="main" tabindex="-1">
<div class="content">
<h1 id="expect-witherror-function-function-err-">expect.withError(function () { ... }, function (err) {})</h1>
<p>In some situations you want to modify an error thrown from
unexpected. This method handles all the details for you.</p>
<p>Notice that this method is only available inside
<a href="/api/addAssertion">expect.addAssertion</a>.</p>
<p>The standard case is to attach a diff or change the error message of
an error being thrown.</p>
<div class="code lang-javascript">
<div><span style="color: #a71d5d">function</span> <span style="color: #000000">Person</span><span style="color: #000000">(</span>options<span style="color: #000000">)</span> <span style="color: #000000">{</span></div>
<div> <span style="color: #a71d5d">this</span><span style="color: #000000">.</span>name <span style="color: #a71d5d">=</span> options<span style="color: #000000">.</span>name<span style="color: #000000">;</span></div>
<div> <span style="color: #a71d5d">this</span><span style="color: #000000">.</span>gender <span style="color: #a71d5d">=</span> options<span style="color: #000000">.</span>gender<span style="color: #000000">;</span></div>
<div><span style="color: #000000">}</span></div>
<div> </div>
<div>Person<span style="color: #000000">.</span>prototype<span style="color: #000000">.</span>genderSign <span style="color: #a71d5d">=</span> <span style="color: #a71d5d">function</span> <span style="color: #000000">()</span> <span style="color: #000000">{</span></div>
<div> switch <span style="color: #000000">(</span><span style="color: #a71d5d">this</span><span style="color: #000000">.</span>gender<span style="color: #000000">)</span> <span style="color: #000000">{</span></div>
<div> case <span style="color: #df5000">'female'</span><span style="color: #000000">:</span> <span style="color: #a71d5d">return</span> <span style="color: #df5000">'♀'</span><span style="color: #000000">;</span></div>
<div> case <span style="color: #df5000">'male'</span><span style="color: #000000">:</span> <span style="color: #a71d5d">return</span> <span style="color: #df5000">'♂'</span><span style="color: #000000">;</span></div>
<div> default<span style="color: #000000">:</span> <span style="color: #a71d5d">return</span> <span style="color: #df5000">'⚧'</span><span style="color: #000000">;</span></div>
<div> <span style="color: #000000">}</span></div>
<div><span style="color: #000000">};</span></div>
<div> </div>
<div>expect<span style="color: #000000">.</span><span style="color: #000000">addAssertion</span><span style="color: #000000">(</span><span style="color: #df5000">'to have same gender as'</span><span style="color: #000000">,</span> <span style="color: #a71d5d">function</span> <span style="color: #000000">(</span>expect<span style="color: #000000">,</span> subject<span style="color: #000000">,</span> value<span style="color: #000000">)</span> <span style="color: #000000">{</span></div>
<div> expect<span style="color: #000000">.</span><span style="color: #000000">withError</span><span style="color: #000000">(</span><span style="color: #a71d5d">function</span> <span style="color: #000000">()</span> <span style="color: #000000">{</span></div>
<div> <span style="color: #000000">expect</span><span style="color: #000000">(</span>subject<span style="color: #000000">.</span>gender<span style="color: #000000">,</span> <span style="color: #df5000">'to be'</span><span style="color: #000000">,</span> value<span style="color: #000000">.</span>gender<span style="color: #000000">);</span></div>
<div> <span style="color: #000000">},</span> <span style="color: #a71d5d">function</span> <span style="color: #000000">(</span>e<span style="color: #000000">)</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></div>
<div> diff<span style="color: #000000">:</span> <span style="color: #a71d5d">function</span> <span style="color: #000000">(</span>output<span style="color: #000000">)</span> <span style="color: #000000">{</span></div>
<div> <span style="color: #a71d5d">return</span> <span style="color: #000000">{</span></div>
<div> inline<span style="color: #000000">:</span> <span style="color: #0086b3">false</span><span style="color: #000000">,</span></div>
<div> diff<span style="color: #000000">:</span> output<span style="color: #000000">.</span><span style="color: #000000">bold</span><span style="color: #000000">(</span>subject<span style="color: #000000">.</span><span style="color: #000000">genderSign</span><span style="color: #000000">()).</span><span style="color: #000000">text</span><span style="color: #000000">(</span><span style="color: #df5000">' ≠ '</span><span style="color: #000000">).</span><span style="color: #000000">bold</span><span style="color: #000000">(</span>value<span style="color: #000000">.</span><span style="color: #000000">genderSign</span><span style="color: #000000">())</span></div>
<div> <span style="color: #000000">};</span></div>
<div> <span style="color: #000000">}</span></div>
<div> <span style="color: #000000">});</span></div>
<div> <span style="color: #000000">});</span></div>
<div><span style="color: #000000">});</span></div>
<div> </div>
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #a71d5d">new</span> Person<span style="color: #000000">({</span> name<span style="color: #000000">:</span> <span style="color: #df5000">'John Doe'</span><span style="color: #000000">,</span> gender<span style="color: #000000">:</span> <span style="color: #df5000">'male'</span> <span style="color: #000000">}),</span></div>
<div> <span style="color: #df5000">'to have same gender as'</span><span style="color: #000000">,</span></div>
<div> <span style="color: #a71d5d">new</span> Person<span style="color: #000000">({</span> name<span style="color: #000000">:</span> <span style="color: #df5000">'Jane Doe'</span><span style="color: #000000">,</span> gender<span style="color: #000000">:</span> <span style="color: #df5000">'female'</span> <span style="color: #000000">}));</span></div>
</div><div class="output">
<div><span style="color: red; font-weight: bold">expected</span> Person({ <span style="color: #555">name</span>: <span style="color: #df5000">'John Doe'</span>, <span style="color: #555">gender</span>: <span style="color: #df5000">'male'</span> })</div>
<div><span style="color: red; font-weight: bold">to have same gender as</span> Person({ <span style="color: #555">name</span>: <span style="color: #df5000">'Jane Doe'</span>, <span style="color: #555">gender</span>: <span style="color: #df5000">'female'</span> })</div>
<div> </div>
<div><span style="font-weight: bold">♂</span> ≠ <span style="font-weight: bold">♀</span></div>
</div><p>The method also supports asynchronous assertion the following way:</p>
<div class="code lang-javascript">
<div>expect<span style="color: #000000">.</span><span style="color: #000000">addAssertion</span><span style="color: #000000">(</span><span style="color: #df5000">'delegating to an asynchronous assertion'</span><span style="color: #000000">,</span> <span style="color: #a71d5d">function</span> <span style="color: #000000">(</span>expect<span style="color: #000000">,</span> subject<span style="color: #000000">)</span> <span style="color: #000000">{</span></div>
<div> <span style="color: #a71d5d">return</span> expect<span style="color: #000000">.</span><span style="color: #000000">withError</span><span style="color: #000000">(</span><span style="color: #a71d5d">function</span> <span style="color: #000000">()</span> <span style="color: #000000">{</span></div>
<div> <span style="color: #a71d5d">return</span> <span style="color: #000000">expect</span><span style="color: #000000">(</span>subject<span style="color: #000000">,</span> <span style="color: #df5000">'asynchronous expectation'</span><span style="color: #000000">);</span></div>
<div> <span style="color: #000000">},</span> <span style="color: #a71d5d">function</span> <span style="color: #000000">(</span>e<span style="color: #000000">)</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></div>
<div> diff<span style="color: #000000">:</span> <span style="color: #a71d5d">function</span> <span style="color: #000000">(</span>output<span style="color: #000000">)</span> <span style="color: #000000">{</span></div>
<div> <span style="color: #a71d5d">return</span> <span style="color: #000000">{</span></div>
<div> inline<span style="color: #000000">:</span> <span style="color: #0086b3">true</span><span style="color: #000000">,</span></div>
<div> diff<span style="color: #000000">:</span> output<span style="color: #000000">.</span><span style="color: #000000">text</span><span style="color: #000000">(</span><span style="color: #df5000">'Cool a diff attached to an asynchronous failure!'</span><span style="color: #000000">)</span></div>
<div> <span style="color: #000000">};</span></div>
<div> <span style="color: #000000">}</span></div>
<div> <span style="color: #000000">});</span></div>
<div> <span style="color: #000000">});</span></div>
<div><span style="color: #000000">});</span></div>
</div>
</div>
</div>
</section>
<script type="text/javascript">
baseUrl = '../..';
</script>
<script type="text/javascript" src="../../static/toggleSidebar.js"></script>
<script type="text/javascript" src="../../static/rememberScrollPosition.js"></script>
<script type="text/javascript" src="../../static/focusMain.js"></script>
<script type="text/javascript" src="../../static/search.js"></script>
</body>
</html>