unexpected
Version:
Extensible BDD assertion toolkit
297 lines (231 loc) • 13.5 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>string - to be within</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="active"><a href="../../any/to-be-a">Assertions</a></li>
<li class=""><a href="../../../api/addAssertion">API</a></li>
</ul>
</nav>
</header>
<section id="assertions">
<nav id="assertion-menu" class="sidebar js-remember-scroll-position">
<ul>
<li>
<h3>any</h3>
<ul>
<li class="">
<a href="../../any/to-be-a">to be a</a>
</li>
<li class="">
<a href="../../any/to-be-falsy">to be falsy</a>
</li>
<li class="">
<a href="../../any/to-be-null">to be null</a>
</li>
<li class="">
<a href="../../any/to-be-truthy">to be truthy</a>
</li>
<li class="">
<a href="../../any/to-be-ok">to be ok</a>
</li>
<li class="">
<a href="../../any/to-be-undefined">to be undefined</a>
</li>
<li class="">
<a href="../../any/to-be">to be</a>
</li>
<li class="">
<a href="../../any/to-equal">to equal</a>
</li>
<li class="">
<a href="../../any/to-satisfy">to satisfy</a>
</li>
<li class="">
<a href="../../any/to-be-defined">to be defined</a>
</li>
</ul>
</li>
<li>
<h3>array</h3>
<ul>
<li class="">
<a href="../../array/to-be-an-array-whose-items-satisfy">to be an array whose items satisfy</a>
</li>
<li class="">
<a href="../../array/to-be-empty">to be empty</a>
</li>
<li class="">
<a href="../../array/to-contain">to contain</a>
</li>
<li class="">
<a href="../../array/to-have-length">to have length</a>
</li>
</ul>
</li>
<li>
<h3>boolean</h3>
<ul>
<li class="">
<a href="../../boolean/to-be-true">to be true</a>
</li>
<li class="">
<a href="../../boolean/to-be-false">to be false</a>
</li>
</ul>
</li>
<li>
<h3>function</h3>
<ul>
<li class="">
<a href="../../function/to-have-arity">to have arity</a>
</li>
<li class="">
<a href="../../function/to-throw">to throw</a>
</li>
</ul>
</li>
<li>
<h3>number</h3>
<ul>
<li class="">
<a href="../../number/to-be-infinite">to be infinite</a>
</li>
<li class="">
<a href="../../number/to-be-NaN">to be NaN</a>
</li>
<li class="">
<a href="../../number/to-be-finite">to be finite</a>
</li>
<li class="">
<a href="../../number/to-be-greater-than-or-equal-to">to be greater than or equal to</a>
</li>
<li class="">
<a href="../../number/to-be-greater-than">to be greater than</a>
</li>
<li class="">
<a href="../../number/to-be-close-to">to be close to</a>
</li>
<li class="">
<a href="../../number/to-be-less-than-or-equal-to">to be less than or equal to</a>
</li>
<li class="">
<a href="../../number/to-be-less-than">to be less than</a>
</li>
<li class="">
<a href="../../number/to-be-negative">to be negative</a>
</li>
<li class="">
<a href="../../number/to-be-positive">to be positive</a>
</li>
<li class="">
<a href="../../number/to-be-within">to be within</a>
</li>
</ul>
</li>
<li>
<h3>object</h3>
<ul>
<li class="">
<a href="../../object/to-have-properties">to have properties</a>
</li>
<li class="">
<a href="../../object/to-be-a-map-whose-keys-satisfy">to be a map whose keys satisfy</a>
</li>
<li class="">
<a href="../../object/to-be-a-map-whose-values-satisfy">to be a map whose values satisfy</a>
</li>
<li class="">
<a href="../../object/to-be-canonical">to be canonical</a>
</li>
<li class="">
<a href="../../object/to-have-key">to have key</a>
</li>
<li class="">
<a href="../../object/to-have-keys">to have keys</a>
</li>
<li class="">
<a href="../../object/to-have-property">to have property</a>
</li>
</ul>
</li>
<li>
<h3>string</h3>
<ul>
<li class="">
<a href="../to-be-empty">to be empty</a>
</li>
<li class="">
<a href="../to-be-greater-than-or-equal-to">to be greater than or equal to</a>
</li>
<li class="">
<a href="../to-be-greater-than">to be greater than</a>
</li>
<li class="">
<a href="../to-be-less-than-or-equal-to">to be less than or equal to</a>
</li>
<li class="">
<a href="../to-be-less-than">to be less than</a>
</li>
<li class="active">
<a href="">to be within</a>
</li>
<li class="">
<a href="../to-be">to be</a>
</li>
<li class="">
<a href="../to-contain">to contain</a>
</li>
<li class="">
<a href="../to-have-length">to have length</a>
</li>
<li class="">
<a href="../to-match">to match</a>
</li>
</ul>
</li>
</ul>
</nav>
<div class="main">
<div class="content">
<p>Asserts that a string is within a range of strings.</p>
<div class="code lang-javascript">
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #df5000">'a'</span><span style="color: #000000">,</span> <span style="color: #df5000">'to be within'</span><span style="color: #000000">,</span> <span style="color: #df5000">'a'</span><span style="color: #000000">,</span> <span style="color: #df5000">'d'</span><span style="color: #000000">);</span></div>
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #df5000">'b'</span><span style="color: #000000">,</span> <span style="color: #df5000">'to be within'</span><span style="color: #000000">,</span> <span style="color: #df5000">'a'</span><span style="color: #000000">,</span> <span style="color: #df5000">'d'</span><span style="color: #000000">);</span></div>
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #df5000">'aabbcc'</span><span style="color: #000000">,</span> <span style="color: #df5000">'to be within'</span><span style="color: #000000">,</span> <span style="color: #df5000">'aaa'</span><span style="color: #000000">,</span> <span style="color: #df5000">'aaz'</span><span style="color: #000000">);</span></div>
</div><p>In case of a failing expectation you get the following output:</p>
<div class="code lang-javascript">
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #df5000">'abbbcc'</span><span style="color: #000000">,</span> <span style="color: #df5000">'to be within'</span><span style="color: #000000">,</span> <span style="color: #df5000">'aaa'</span><span style="color: #000000">,</span> <span style="color: #df5000">'aaz'</span><span style="color: #000000">);</span></div>
</div><div class="output">
<div><span style="color: red; font-weight: bold">expected</span> <span style="color: #df5000">'abbbcc'</span> <span style="color: red; font-weight: bold">to be within</span> <span style="color: #df5000">'aaa'</span>..<span style="color: #df5000">'aaz'</span></div>
</div><p>This assertion can be negated using the <code>not</code> flag:</p>
<div class="code lang-javascript">
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #df5000">'bar'</span><span style="color: #000000">,</span> <span style="color: #df5000">'not to be within'</span><span style="color: #000000">,</span> <span style="color: #df5000">'foo'</span><span style="color: #000000">,</span> <span style="color: #df5000">'baz'</span><span style="color: #000000">);</span></div>
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #df5000">'e'</span><span style="color: #000000">,</span> <span style="color: #df5000">'not to be within'</span><span style="color: #000000">,</span> <span style="color: #df5000">'a'</span><span style="color: #000000">,</span> <span style="color: #df5000">'d'</span><span style="color: #000000">);</span></div>
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #df5000">'abbbcc'</span><span style="color: #000000">,</span> <span style="color: #df5000">'not to be within'</span><span style="color: #000000">,</span> <span style="color: #df5000">'aaa'</span><span style="color: #000000">,</span> <span style="color: #df5000">'aaz'</span><span style="color: #000000">);</span></div>
</div><p>In case of a failing expectation you get the following output:</p>
<div class="code lang-javascript">
<div><span style="color: #000000">expect</span><span style="color: #000000">(</span><span style="color: #df5000">'c'</span><span style="color: #000000">,</span> <span style="color: #df5000">'not to be within'</span><span style="color: #000000">,</span> <span style="color: #df5000">'a'</span><span style="color: #000000">,</span> <span style="color: #df5000">'d'</span><span style="color: #000000">);</span></div>
</div><div class="output">
<div><span style="color: red; font-weight: bold">expected</span> <span style="color: #df5000">'c'</span> <span style="color: red; font-weight: bold">not to be within</span> <span style="color: #df5000">'a'</span>..<span style="color: #df5000">'d'</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>