lukechilds
/
ow
mirror of https://github.com/lukechilds/ow.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Upgrade dependencies 

Fixes #49
iss58
Sindre Sorhus 7 years ago
parent
811238c49c
commit
9c14618060
23 changed files with 9531 additions and 118 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      docs/assets/js/search.js
  2. 111
      docs/classes/arraypredicate.html
  3. 101
      docs/classes/booleanpredicate.html
  4. 93
      docs/classes/datepredicate.html
  5. 111
      docs/classes/errorpredicate.html
  6. 1583
      docs/classes/mappredicate.html
  7. 111
      docs/classes/numberpredicate.html
  8. 1462
      docs/classes/objectpredicate.html
  9. 1472
      docs/classes/setpredicate.html
  10. 115
      docs/classes/stringpredicate.html
  11. 1253
      docs/classes/weakmappredicate.html
  12. 1253
      docs/classes/weaksetpredicate.html
  13. 28
      docs/index.html
  14. 1084
      docs/interfaces/collectionlike.html
  15. 823
      docs/interfaces/ow.html
  16. 11
      package.json
  17. 1
      source/lib/predicates/any.ts
  18. 1
      source/lib/predicates/predicate.ts
  19. 2
      source/lib/predicates/string.ts
  20. 2
      source/test/any.ts
  21. 5
      tsconfig.json
  22. 16
      tslint.json
  23. 7
      webpack.config.js

4
docs/assets/js/search.js
View File

File diff suppressed because one or more lines are too long

111
docs/classes/arraypredicate.html
View File

@ -936,6 +936,9 @@ img { max-width: 100%; }
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="arraypredicate.html#includesany" class="tsd-kind-icon">includes<wbr>Any</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="arraypredicate.html#is" class="tsd-kind-icon">is</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="arraypredicate.html#length" class="tsd-kind-icon">length</a>
</li>
@ -962,13 +965,31 @@ img { max-width: 100%; }
<li class=" tsd-kind-class">
<a href="errorpredicate.html" class="tsd-kind-icon">Error<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="mappredicate.html" class="tsd-kind-icon">Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="numberpredicate.html" class="tsd-kind-icon">Number<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="objectpredicate.html" class="tsd-kind-icon">Object<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="setpredicate.html" class="tsd-kind-icon">Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="stringpredicate.html" class="tsd-kind-icon">String<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface">
<li class=" tsd-kind-class">
<a href="weakmappredicate.html" class="tsd-kind-icon">Weak<wbr>Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="weaksetpredicate.html" class="tsd-kind-icon">Weak<wbr>Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/collectionlike.html" class="tsd-kind-icon">Collection<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/ow.html" class="tsd-kind-icon">Ow</a>
</li>
</ul>
@ -988,6 +1009,12 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">BasePredicate</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
@ -1013,6 +1040,7 @@ img { max-width: 100%; }
<li class="tsd-kind-method tsd-parent-kind-class"><a href="arraypredicate.html#endswith" class="tsd-kind-icon">ends<wbr>With</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="arraypredicate.html#includes" class="tsd-kind-icon">includes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="arraypredicate.html#includesany" class="tsd-kind-icon">includes<wbr>Any</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="arraypredicate.html#is" class="tsd-kind-icon">is</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="arraypredicate.html#length" class="tsd-kind-icon">length</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="arraypredicate.html#maxlength" class="tsd-kind-icon">max<wbr>Length</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="arraypredicate.html#minlength" class="tsd-kind-icon">min<wbr>Length</a></li>
@ -1036,7 +1064,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Overrides Predicate.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L5">lib/predicates/array.ts:5</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L5">lib/predicates/array.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -1058,7 +1086,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L97">lib/predicates/array.ts:97</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L97">lib/predicates/array.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1073,7 +1101,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">non<wbr>Empty<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L107">lib/predicates/array.ts:107</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L107">lib/predicates/array.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1089,7 +1117,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Inherited from Predicate.not</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/predicate.ts#L50">lib/predicates/predicate.ts:50</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L68">lib/predicates/predicate.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1111,7 +1139,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L119">lib/predicates/array.ts:119</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L119">lib/predicates/array.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1142,7 +1170,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L63">lib/predicates/array.ts:63</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L63">lib/predicates/array.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1173,7 +1201,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L75">lib/predicates/array.ts:75</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L75">lib/predicates/array.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1204,7 +1232,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L87">lib/predicates/array.ts:87</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L87">lib/predicates/array.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1225,6 +1253,61 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="is" class="tsd-anchor"></a>
<h3>is</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Predicate.is</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L79">lib/predicates/predicate.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Test if the value matches a custom validation function. The validation function should return <code>true</code> if the value
passes the function. If the function either returns <code>false</code> or a string, the function fails and the string will be
used as error message.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>Validation function.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">string</span>
</h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="length" class="tsd-anchor"></a>
<h3>length</h3>
@ -1235,7 +1318,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L15">lib/predicates/array.ts:15</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L15">lib/predicates/array.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1266,7 +1349,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L39">lib/predicates/array.ts:39</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L39">lib/predicates/array.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1297,7 +1380,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L27">lib/predicates/array.ts:27</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L27">lib/predicates/array.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1328,7 +1411,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L131">lib/predicates/array.ts:131</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L131">lib/predicates/array.ts:131</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1365,7 +1448,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/array.ts#L51">lib/predicates/array.ts:51</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/array.ts#L51">lib/predicates/array.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

101
docs/classes/booleanpredicate.html
View File

@ -927,6 +927,9 @@ img { max-width: 100%; }
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="booleanpredicate.html#true" class="tsd-kind-icon">true</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="booleanpredicate.html#is" class="tsd-kind-icon">is</a>
</li>
</ul>
</li>
<li class=" tsd-kind-class">
@ -935,13 +938,31 @@ img { max-width: 100%; }
<li class=" tsd-kind-class">
<a href="errorpredicate.html" class="tsd-kind-icon">Error<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="mappredicate.html" class="tsd-kind-icon">Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="numberpredicate.html" class="tsd-kind-icon">Number<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="objectpredicate.html" class="tsd-kind-icon">Object<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="setpredicate.html" class="tsd-kind-icon">Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="stringpredicate.html" class="tsd-kind-icon">String<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface">
<li class=" tsd-kind-class">
<a href="weakmappredicate.html" class="tsd-kind-icon">Weak<wbr>Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="weaksetpredicate.html" class="tsd-kind-icon">Weak<wbr>Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/collectionlike.html" class="tsd-kind-icon">Collection<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/ow.html" class="tsd-kind-icon">Ow</a>
</li>
</ul>
@ -961,6 +982,12 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">BasePredicate</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
@ -979,6 +1006,12 @@ img { max-width: 100%; }
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="booleanpredicate.html#true" class="tsd-kind-icon">true</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="booleanpredicate.html#is" class="tsd-kind-icon">is</a></li>
</ul>
</section>
</div>
</section>
</section>
@ -995,7 +1028,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Overrides Predicate.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/boolean.ts#L3">lib/predicates/boolean.ts:3</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/boolean.ts#L3">lib/predicates/boolean.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -1017,7 +1050,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">false<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/boolean.ts#L21">lib/predicates/boolean.ts:21</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/boolean.ts#L21">lib/predicates/boolean.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1033,7 +1066,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Inherited from Predicate.not</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/predicate.ts#L50">lib/predicates/predicate.ts:50</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L68">lib/predicates/predicate.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1048,7 +1081,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">true<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/boolean.ts#L11">lib/predicates/boolean.ts:11</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/boolean.ts#L11">lib/predicates/boolean.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1058,6 +1091,64 @@ img { max-width: 100%; }
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="is" class="tsd-anchor"></a>
<h3>is</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Predicate.is</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L79">lib/predicates/predicate.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Test if the value matches a custom validation function. The validation function should return <code>true</code> if the value
passes the function. If the function either returns <code>false</code> or a string, the function fails and the string will be
used as error message.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>Validation function.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">string</span>
</h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
</li>
</ul>
</section>
</section>
<footer>
<div class="container">
<h2>Legend</h2>

93
docs/classes/datepredicate.html
View File

@ -930,18 +930,39 @@ img { max-width: 100%; }
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="datepredicate.html#before" class="tsd-kind-icon">before</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="datepredicate.html#is" class="tsd-kind-icon">is</a>
</li>
</ul>
</li>
<li class=" tsd-kind-class">
<a href="errorpredicate.html" class="tsd-kind-icon">Error<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="mappredicate.html" class="tsd-kind-icon">Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="numberpredicate.html" class="tsd-kind-icon">Number<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="objectpredicate.html" class="tsd-kind-icon">Object<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="setpredicate.html" class="tsd-kind-icon">Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="stringpredicate.html" class="tsd-kind-icon">String<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface">
<li class=" tsd-kind-class">
<a href="weakmappredicate.html" class="tsd-kind-icon">Weak<wbr>Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="weaksetpredicate.html" class="tsd-kind-icon">Weak<wbr>Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/collectionlike.html" class="tsd-kind-icon">Collection<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/ow.html" class="tsd-kind-icon">Ow</a>
</li>
</ul>
@ -961,6 +982,12 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">BasePredicate</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
@ -982,6 +1009,7 @@ img { max-width: 100%; }
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="datepredicate.html#after" class="tsd-kind-icon">after</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="datepredicate.html#before" class="tsd-kind-icon">before</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="datepredicate.html#is" class="tsd-kind-icon">is</a></li>
</ul>
</section>
</div>
@ -1000,7 +1028,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Overrides Predicate.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/date.ts#L3">lib/predicates/date.ts:3</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/date.ts#L3">lib/predicates/date.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -1023,7 +1051,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Inherited from Predicate.not</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/predicate.ts#L50">lib/predicates/predicate.ts:50</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L68">lib/predicates/predicate.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1045,7 +1073,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/date.ts#L25">lib/predicates/date.ts:25</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/date.ts#L25">lib/predicates/date.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1076,7 +1104,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/date.ts#L13">lib/predicates/date.ts:13</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/date.ts#L13">lib/predicates/date.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1097,6 +1125,61 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="is" class="tsd-anchor"></a>
<h3>is</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Predicate.is</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L79">lib/predicates/predicate.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Test if the value matches a custom validation function. The validation function should return <code>true</code> if the value
passes the function. If the function either returns <code>false</code> or a string, the function fails and the string will be
used as error message.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>Validation function.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">Date</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">string</span>
</h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
</li>
</ul>
</section>
</section>
<footer>
<div class="container">

111
docs/classes/errorpredicate.html
View File

@ -951,6 +951,9 @@ img { max-width: 100%; }
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="errorpredicate.html#instanceof" class="tsd-kind-icon">instance<wbr>Of</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="errorpredicate.html#is" class="tsd-kind-icon">is</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="errorpredicate.html#message" class="tsd-kind-icon">message</a>
</li>
@ -962,13 +965,31 @@ img { max-width: 100%; }
</li>
</ul>
</li>
<li class=" tsd-kind-class">
<a href="mappredicate.html" class="tsd-kind-icon">Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="numberpredicate.html" class="tsd-kind-icon">Number<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="objectpredicate.html" class="tsd-kind-icon">Object<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="setpredicate.html" class="tsd-kind-icon">Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="stringpredicate.html" class="tsd-kind-icon">String<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface">
<li class=" tsd-kind-class">
<a href="weakmappredicate.html" class="tsd-kind-icon">Weak<wbr>Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="weaksetpredicate.html" class="tsd-kind-icon">Weak<wbr>Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/collectionlike.html" class="tsd-kind-icon">Collection<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/ow.html" class="tsd-kind-icon">Ow</a>
</li>
</ul>
@ -988,6 +1009,12 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">BasePredicate</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
@ -1015,6 +1042,7 @@ img { max-width: 100%; }
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="errorpredicate.html#haskeys" class="tsd-kind-icon">has<wbr>Keys</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="errorpredicate.html#instanceof" class="tsd-kind-icon">instance<wbr>Of</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="errorpredicate.html#is" class="tsd-kind-icon">is</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="errorpredicate.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="errorpredicate.html#messageincludes" class="tsd-kind-icon">message<wbr>Includes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="errorpredicate.html#name" class="tsd-kind-icon">name</a></li>
@ -1036,7 +1064,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Overrides Predicate.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L3">lib/predicates/error.ts:3</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L3">lib/predicates/error.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -1058,7 +1086,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">eval<wbr>Error<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L78">lib/predicates/error.ts:78</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L78">lib/predicates/error.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1074,7 +1102,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Inherited from Predicate.not</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/predicate.ts#L50">lib/predicates/predicate.ts:50</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L68">lib/predicates/predicate.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1089,7 +1117,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">range<wbr>Error<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L85">lib/predicates/error.ts:85</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L85">lib/predicates/error.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1104,7 +1132,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">reference<wbr>Error<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L92">lib/predicates/error.ts:92</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L92">lib/predicates/error.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1119,7 +1147,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">syntax<wbr>Error<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L99">lib/predicates/error.ts:99</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L99">lib/predicates/error.ts:99</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1134,7 +1162,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">type<wbr>Error<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L71">lib/predicates/error.ts:71</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L71">lib/predicates/error.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1149,7 +1177,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">uri<wbr>Error<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L106">lib/predicates/error.ts:106</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L106">lib/predicates/error.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1171,7 +1199,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L49">lib/predicates/error.ts:49</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L49">lib/predicates/error.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1202,7 +1230,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L61">lib/predicates/error.ts:61</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L61">lib/predicates/error.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1223,6 +1251,61 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="is" class="tsd-anchor"></a>
<h3>is</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Predicate.is</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L79">lib/predicates/predicate.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Test if the value matches a custom validation function. The validation function should return <code>true</code> if the value
passes the function. If the function either returns <code>false</code> or a string, the function fails and the string will be
used as error message.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>Validation function.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">Error</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">string</span>
</h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="message" class="tsd-anchor"></a>
<h3>message</h3>
@ -1233,7 +1316,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L25">lib/predicates/error.ts:25</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L25">lib/predicates/error.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1264,7 +1347,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L37">lib/predicates/error.ts:37</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L37">lib/predicates/error.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1295,7 +1378,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/error.ts#L13">lib/predicates/error.ts:13</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/error.ts#L13">lib/predicates/error.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

1583
docs/classes/mappredicate.html
View File

File diff suppressed because one or more lines are too long

111
docs/classes/numberpredicate.html
View File

@ -921,6 +921,9 @@ img { max-width: 100%; }
<li class=" tsd-kind-class">
<a href="errorpredicate.html" class="tsd-kind-icon">Error<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="mappredicate.html" class="tsd-kind-icon">Map<wbr>Predicate</a>
</li>
<li class="current tsd-kind-class">
<a href="numberpredicate.html" class="tsd-kind-icon">Number<wbr>Predicate</a>
<ul>
@ -957,6 +960,9 @@ img { max-width: 100%; }
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="numberpredicate.html#inrange" class="tsd-kind-icon">in<wbr>Range</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="numberpredicate.html#is" class="tsd-kind-icon">is</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="numberpredicate.html#lessthan" class="tsd-kind-icon">less<wbr>Than</a>
</li>
@ -965,10 +971,25 @@ img { max-width: 100%; }
</li>
</ul>
</li>
<li class=" tsd-kind-class">
<a href="objectpredicate.html" class="tsd-kind-icon">Object<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="setpredicate.html" class="tsd-kind-icon">Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="stringpredicate.html" class="tsd-kind-icon">String<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface">
<li class=" tsd-kind-class">
<a href="weakmappredicate.html" class="tsd-kind-icon">Weak<wbr>Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="weaksetpredicate.html" class="tsd-kind-icon">Weak<wbr>Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/collectionlike.html" class="tsd-kind-icon">Collection<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/ow.html" class="tsd-kind-icon">Ow</a>
</li>
</ul>
@ -988,6 +1009,12 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">BasePredicate</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
@ -1016,6 +1043,7 @@ img { max-width: 100%; }
<li class="tsd-kind-method tsd-parent-kind-class"><a href="numberpredicate.html#greaterthan" class="tsd-kind-icon">greater<wbr>Than</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="numberpredicate.html#greaterthanorequal" class="tsd-kind-icon">greater<wbr>Than<wbr>OrEqual</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="numberpredicate.html#inrange" class="tsd-kind-icon">in<wbr>Range</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="numberpredicate.html#is" class="tsd-kind-icon">is</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="numberpredicate.html#lessthan" class="tsd-kind-icon">less<wbr>Than</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="numberpredicate.html#lessthanorequal" class="tsd-kind-icon">less<wbr>Than<wbr>OrEqual</a></li>
</ul>
@ -1036,7 +1064,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Overrides Predicate.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L4">lib/predicates/number.ts:4</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L4">lib/predicates/number.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -1058,7 +1086,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">finite<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L95">lib/predicates/number.ts:95</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L95">lib/predicates/number.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1073,7 +1101,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">infinite<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L105">lib/predicates/number.ts:105</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L105">lib/predicates/number.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1088,7 +1116,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">integer<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L85">lib/predicates/number.ts:85</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L85">lib/predicates/number.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1103,7 +1131,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">negative<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L125">lib/predicates/number.ts:125</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L125">lib/predicates/number.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1119,7 +1147,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Inherited from Predicate.not</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/predicate.ts#L50">lib/predicates/predicate.ts:50</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L68">lib/predicates/predicate.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1134,7 +1162,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">positive<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L115">lib/predicates/number.ts:115</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L115">lib/predicates/number.ts:115</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1156,7 +1184,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L75">lib/predicates/number.ts:75</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L75">lib/predicates/number.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1187,7 +1215,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L27">lib/predicates/number.ts:27</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L27">lib/predicates/number.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1218,7 +1246,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L39">lib/predicates/number.ts:39</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L39">lib/predicates/number.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1249,7 +1277,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L15">lib/predicates/number.ts:15</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L15">lib/predicates/number.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1276,6 +1304,61 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="is" class="tsd-anchor"></a>
<h3>is</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Predicate.is</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L79">lib/predicates/predicate.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Test if the value matches a custom validation function. The validation function should return <code>true</code> if the value
passes the function. If the function either returns <code>false</code> or a string, the function fails and the string will be
used as error message.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>Validation function.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">string</span>
</h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="lessthan" class="tsd-anchor"></a>
<h3>less<wbr>Than</h3>
@ -1286,7 +1369,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L51">lib/predicates/number.ts:51</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L51">lib/predicates/number.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1317,7 +1400,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/number.ts#L63">lib/predicates/number.ts:63</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/number.ts#L63">lib/predicates/number.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

1462
docs/classes/objectpredicate.html
View File

File diff suppressed because one or more lines are too long

1472
docs/classes/setpredicate.html
View File

File diff suppressed because one or more lines are too long

115
docs/classes/stringpredicate.html
View File

@ -921,9 +921,18 @@ img { max-width: 100%; }
<li class=" tsd-kind-class">
<a href="errorpredicate.html" class="tsd-kind-icon">Error<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="mappredicate.html" class="tsd-kind-icon">Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="numberpredicate.html" class="tsd-kind-icon">Number<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="objectpredicate.html" class="tsd-kind-icon">Object<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="setpredicate.html" class="tsd-kind-icon">Set<wbr>Predicate</a>
</li>
<li class="current tsd-kind-class">
<a href="stringpredicate.html" class="tsd-kind-icon">String<wbr>Predicate</a>
<ul>
@ -957,6 +966,9 @@ img { max-width: 100%; }
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stringpredicate.html#includes" class="tsd-kind-icon">includes</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="stringpredicate.html#is" class="tsd-kind-icon">is</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="stringpredicate.html#length" class="tsd-kind-icon">length</a>
</li>
@ -974,7 +986,16 @@ img { max-width: 100%; }
</li>
</ul>
</li>
<li class=" tsd-kind-interface">
<li class=" tsd-kind-class">
<a href="weakmappredicate.html" class="tsd-kind-icon">Weak<wbr>Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="weaksetpredicate.html" class="tsd-kind-icon">Weak<wbr>Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/collectionlike.html" class="tsd-kind-icon">Collection<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/ow.html" class="tsd-kind-icon">Ow</a>
</li>
</ul>
@ -994,6 +1015,12 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">BasePredicate</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
@ -1021,6 +1048,7 @@ img { max-width: 100%; }
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stringpredicate.html#endswith" class="tsd-kind-icon">ends<wbr>With</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stringpredicate.html#equals" class="tsd-kind-icon">equals</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stringpredicate.html#includes" class="tsd-kind-icon">includes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="stringpredicate.html#is" class="tsd-kind-icon">is</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stringpredicate.html#length" class="tsd-kind-icon">length</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stringpredicate.html#matches" class="tsd-kind-icon">matches</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="stringpredicate.html#maxlength" class="tsd-kind-icon">max<wbr>Length</a></li>
@ -1044,7 +1072,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Overrides Predicate.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L4">lib/predicates/string.ts:4</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L4">lib/predicates/string.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -1066,7 +1094,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">alphanumeric<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L128">lib/predicates/string.ts:128</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L128">lib/predicates/string.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1081,7 +1109,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">date<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L148">lib/predicates/string.ts:148</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L148">lib/predicates/string.ts:148</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1096,7 +1124,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L96">lib/predicates/string.ts:96</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L96">lib/predicates/string.ts:96</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1111,7 +1139,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">non<wbr>Empty<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L106">lib/predicates/string.ts:106</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L106">lib/predicates/string.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1127,7 +1155,7 @@ img { max-width: 100%; }
<aside class="tsd-sources">
<p>Inherited from Predicate.not</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/predicate.ts#L50">lib/predicates/predicate.ts:50</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L68">lib/predicates/predicate.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1142,7 +1170,7 @@ img { max-width: 100%; }
<div class="tsd-signature tsd-kind-icon">numeric<span class="tsd-signature-symbol">:</span> </div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L138">lib/predicates/string.ts:138</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L138">lib/predicates/string.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1164,7 +1192,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L74">lib/predicates/string.ts:74</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L74">lib/predicates/string.ts:74</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1195,7 +1223,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L118">lib/predicates/string.ts:118</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L118">lib/predicates/string.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1226,7 +1254,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L86">lib/predicates/string.ts:86</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L86">lib/predicates/string.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1247,6 +1275,61 @@ img { max-width: 100%; }
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="is" class="tsd-anchor"></a>
<h3>is</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from Predicate.is</p>
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/predicate.ts#L79">lib/predicates/predicate.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Test if the value matches a custom validation function. The validation function should return <code>true</code> if the value
passes the function. If the function either returns <code>false</code> or a string, the function fails and the string will be
used as error message.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fn: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>Validation function.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">string</span>
</h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="length" class="tsd-anchor"></a>
<h3>length</h3>
@ -1257,7 +1340,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L14">lib/predicates/string.ts:14</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L14">lib/predicates/string.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1288,7 +1371,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L50">lib/predicates/string.ts:50</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L50">lib/predicates/string.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1316,7 +1399,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L38">lib/predicates/string.ts:38</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L38">lib/predicates/string.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1347,7 +1430,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L26">lib/predicates/string.ts:26</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L26">lib/predicates/string.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -1378,7 +1461,7 @@ img { max-width: 100%; }
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/45aa3cf/source/lib/predicates/string.ts#L62">lib/predicates/string.ts:62</a></li>
<li>Defined in <a href="https://github.com/sindresorhus/ow/blob/766281c/source/lib/predicates/string.ts#L62">lib/predicates/string.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">

1253
docs/classes/weakmappredicate.html
View File

File diff suppressed because one or more lines are too long

1253
docs/classes/weaksetpredicate.html
View File

File diff suppressed because one or more lines are too long

28
docs/index.html
View File

@ -921,13 +921,31 @@ img { max-width: 100%; }
<li class=" tsd-kind-class">
<a href="classes/errorpredicate.html" class="tsd-kind-icon">Error<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/mappredicate.html" class="tsd-kind-icon">Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/numberpredicate.html" class="tsd-kind-icon">Number<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/objectpredicate.html" class="tsd-kind-icon">Object<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/setpredicate.html" class="tsd-kind-icon">Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/stringpredicate.html" class="tsd-kind-icon">String<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface">
<li class=" tsd-kind-class">
<a href="classes/weakmappredicate.html" class="tsd-kind-icon">Weak<wbr>Map<wbr>Predicate</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/weaksetpredicate.html" class="tsd-kind-icon">Weak<wbr>Set<wbr>Predicate</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/collectionlike.html" class="tsd-kind-icon">Collection<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/ow.html" class="tsd-kind-icon">Ow</a>
</li>
</ul>
@ -945,14 +963,20 @@ img { max-width: 100%; }
<li class="tsd-kind-class"><a href="classes/booleanpredicate.html" class="tsd-kind-icon">Boolean<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/datepredicate.html" class="tsd-kind-icon">Date<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/errorpredicate.html" class="tsd-kind-icon">Error<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/mappredicate.html" class="tsd-kind-icon">Map<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/numberpredicate.html" class="tsd-kind-icon">Number<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/objectpredicate.html" class="tsd-kind-icon">Object<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/setpredicate.html" class="tsd-kind-icon">Set<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/stringpredicate.html" class="tsd-kind-icon">String<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/weakmappredicate.html" class="tsd-kind-icon">Weak<wbr>Map<wbr>Predicate</a></li>
<li class="tsd-kind-class"><a href="classes/weaksetpredicate.html" class="tsd-kind-icon">Weak<wbr>Set<wbr>Predicate</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/ow.html" class="tsd-kind-icon">Ow</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/collectionlike.html" class="tsd-kind-icon">Collection<wbr>Like</a></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ow.html" class="tsd-kind-icon">Ow</a></li>
</ul>
</section>
</div>

1084
docs/interfaces/collectionlike.html
View File

File diff suppressed because one or more lines are too long

823
docs/interfaces/ow.html
View File

File diff suppressed because it is too large

11
package.json
View File

@ -55,7 +55,7 @@
"@types/vali-date": "^1.0.0",
"add-module-exports-webpack-plugin": "^0.1.0",
"ava": "*",
"awesome-typescript-loader": "^3.2.3",
"awesome-typescript-loader": "^4.0.1",
"codecov": "^3.0.0",
"del-cli": "^1.1.0",
"dot-prop": "^4.2.0",
@ -63,11 +63,12 @@
"lodash.isequal": "^4.5.0",
"nyc": "^11.2.1",
"tslint": "^5.9.1",
"tslint-xo": "^0.6.0",
"typedoc": "^0.9.0",
"typescript": "^2.7.0",
"tslint-xo": "^0.7.0",
"typedoc": "^0.11.1",
"typescript": "^2.8.1",
"vali-date": "^1.0.0",
"webpack": "^3.8.1"
"webpack": "^4.3.0",
"webpack-cli": "^2.0.13"
},
"typings": "dist/index.d.ts",
"nyc": {

1
source/lib/predicates/any.ts
View File

@ -11,6 +11,7 @@ export class AnyPredicate<T> implements BasePredicate<T> {
private readonly predicates: Predicate[]
) {}
// tslint:disable completed-docs
[testSymbol](value: T, main: Ow) {
const errors = [
'Any predicate failed with the following errors:'

1
source/lib/predicates/predicate.ts
View File

@ -43,6 +43,7 @@ export class Predicate<T = any> implements BasePredicate<T> {
/**
* @hidden
*/
// tslint:disable completed-docs
[testSymbol](value: T, main: Ow) {
for (const {validator, message} of this.context.validators) {
const result = validator(value);

2
source/lib/predicates/string.ts
View File

@ -1,4 +1,4 @@
import * as valiDate from 'vali-date';
import valiDate from 'vali-date';
import {Predicate, Context} from './predicate';
export class StringPredicate extends Predicate<string> {

2
source/test/any.ts
View File

@ -6,7 +6,7 @@ const createError = (...errors: string[]) => {
'Any predicate failed with the following errors:',
...errors.map(error => `- ${error}`)
].join('\n');
}
};
test('any', t => {
t.notThrows(() => m(1, m.any(m.number)));

5
tsconfig.json
View File

@ -20,7 +20,8 @@
"strictNullChecks": true,
"strictFunctionTypes": true,
"strictPropertyInitialization": true,
"alwaysStrict": true
"alwaysStrict": true,
"esModuleInterop": true
},
"exclude": [
"node_modules",
@ -31,7 +32,7 @@
// Links to `ArrayPredicate` and others doesn't work when this is specified...
// "entryPoint": "Ow",
"mode": "file",
"target": "ES5",
"target": "ES6",
"module": "commonjs",
"moduleResolution": "node",
"exclude": "source/test",

16
tslint.json
View File

@ -1,6 +1,20 @@
{
"extends": "tslint-xo",
"rules": {
"completed-docs": [true, "methods"]
"completed-docs": [
true,
{
"methods": {
"privacies": [
"public"
]
},
"functions": {
"visibilities": [
"exported"
]
}
}
]
}
}

7
webpack.config.js
View File

@ -4,6 +4,7 @@ const license = require('license-webpack-plugin');
const AddModuleExportsPlugin = require('add-module-exports-webpack-plugin');
module.exports = {
mode: 'production',
entry: './source/index.ts',
target: 'node',
node: false,
@ -13,10 +14,12 @@ module.exports = {
libraryTarget: 'commonjs2'
},
resolve: {
extensions: ['.ts', '.js']
extensions: [
'.ts',
'.js'
]
},
plugins: [
new webpack.optimize.ModuleConcatenationPlugin(),
new AddModuleExportsPlugin(),
new license.LicenseWebpackPlugin({
pattern: /.*/,

Write Preview
Loading…
Cancel
Save