Deploying to gh-pages from @ 950b8b7 🚀

functions/index.createStringSameness.html

@@ -42,7 +42,7 @@ <h5>valB: <span class="tsd-signature-type">string</span></h5></li>
 <h5>options: <a href="../interfaces/index.StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/index.StringSamenessResult.html" class="tsd-signature-type" data-tsd-kind="Interface">StringSamenessResult</a></h4></li></ul></li></ul><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/index.ts#L153">index.ts:153</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/index.ts#L153">index.ts:153</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/index.reorderStr.html

@@ -31,7 +31,7 @@ <h5>strB: <span class="tsd-signature-type">string</span></h5></li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/index.StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/index.ts#L82">index.ts:82</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/index.ts#L82">index.ts:82</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/index.stringSameness.html

@@ -31,7 +31,7 @@ <h5>valB: <span class="tsd-signature-type">string</span></h5></li>
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/index.StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/index.StringSamenessResult.html" class="tsd-signature-type" data-tsd-kind="Interface">StringSamenessResult</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/index.ts#L23">index.ts:23</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/index.ts#L23">index.ts:23</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/normalization.lowercase.html

@@ -27,7 +27,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/normalization.removeNonAlphanumeric.html

@@ -27,7 +27,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/normalization.removePunctuation.html

@@ -27,7 +27,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/normalization.removeWhitespace.html

@@ -27,7 +27,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/normalization.replaceMultiWhitespace.html

@@ -27,7 +27,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/normalization.replaceUnicode.html

@@ -27,7 +27,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/normalization.trim.html

@@ -27,7 +27,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L77">atomic.ts:77</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

interfaces/index.ComparisonStrategyResult.html

@@ -23,7 +23,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">ComparisonStrategyResult</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L48">atomic.ts:48</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L48">atomic.ts:48</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -43,15 +43,15 @@ <h3 class="tsd-anchor-link"><span>score</span><a href="#score" aria-label="Perma
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="matchingStrategies.ComparisonStrategyResultObject.html">ComparisonStrategyResultObject</a>.<a href="matchingStrategies.ComparisonStrategyResultObject.html#score">score</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L39">atomic.ts:39</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L39">atomic.ts:39</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="rawScore" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>raw<wbr/>Score</span><a href="#rawScore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">raw<wbr/>Score<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"><p>The raw value returned by the comparison (not normalized)</p>
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="matchingStrategies.ComparisonStrategyResultObject.html">ComparisonStrategyResultObject</a>.<a href="matchingStrategies.ComparisonStrategyResultObject.html#rawScore">rawScore</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L43">atomic.ts:43</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L43">atomic.ts:43</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

interfaces/index.StringComparisonOptions.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">StringComparisonOptions</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L1">atomic.ts:1</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L1">atomic.ts:1</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -42,22 +42,22 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <div class="tsd-comment tsd-typography"><p>An array of transformations to apply to each string before comparing similarity</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L5">atomic.ts:5</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L5">atomic.ts:5</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strategies" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>strategies</span><a href="#strategies" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">strategies<span class="tsd-signature-symbol">?:</span> <a href="matchingStrategies.ComparisonStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">ComparisonStrategy</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/matchingStrategies.ComparisonStrategyResultValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">ComparisonStrategyResultValue</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div>
 <div class="tsd-comment tsd-typography"><p>An array of strategies used to score similarity. All strategies scores are combined for an average high score.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L9">atomic.ts:9</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L9">atomic.ts:9</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reorder" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>reorder</span><a href="#reorder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">reorder<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
 <div class="tsd-comment tsd-typography"><p>Reorder second string so its token match order of first string as closely as possible</p>
 <p>Useful when only the differences in content are important, but not the order of the content</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L15">atomic.ts:15</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L15">atomic.ts:15</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="delimiter" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>delimiter</span><a href="#delimiter" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">delimiter<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></div>
@@ -67,7 +67,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <h3>Default</h3><p>&quot; &quot;</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5b0568c/src/atomic.ts#L24">atomic.ts:24</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/950b8b7/src/atomic.ts#L24">atomic.ts:24</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">