[READ-ONLY] Mirror of https://github.com/FoxxMD/string-sameness. Compare the sameness of two strings
foxxmd.github.io/string-sameness/
compare
cosine-similarity
dice-coefficient
levenshtein-distance
sameness
string
text
typescript
Deploying to gh-pages from @ FoxxMD/string-sameness@d78cc6b40c66eee42e29f0961f6a3119072d5162 🚀
+12
-12
+1
-1
functions/createStringSameness.html
+1
-1
functions/createStringSameness.html
···
41
41
<h5>options: <a href="../interfaces/StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
42
42
<h4 class="tsd-returns-title">Returns <a href="../interfaces/StringSamenessResult.html" class="tsd-signature-type" data-tsd-kind="Interface">StringSamenessResult</a></h4></li></ul></li></ul><aside class="tsd-sources">
43
43
<ul>
44
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/index.ts#L80">index.ts:80</a></li></ul></aside></li></ul></section></div>
44
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/index.ts#L80">index.ts:80</a></li></ul></aside></li></ul></section></div>
45
45
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
46
46
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav>
47
47
<div class="tsd-navigation settings">
+1
-1
functions/stringSameness.html
+1
-1
functions/stringSameness.html
···
30
30
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a></h5></li></ul></div>
31
31
<h4 class="tsd-returns-title">Returns <a href="../interfaces/StringSamenessResult.html" class="tsd-signature-type" data-tsd-kind="Interface">StringSamenessResult</a></h4><aside class="tsd-sources">
32
32
<ul>
33
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/index.ts#L32">index.ts:32</a></li></ul></aside></li></ul></section></div>
33
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/index.ts#L32">index.ts:32</a></li></ul></aside></li></ul></section></div>
34
34
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
35
35
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav>
36
36
<div class="tsd-navigation settings">
+1
-1
index.html
+1
-1
index.html
···
29
29
</a>
30
30
<pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span><span class="hl-1"> @</span><span class="hl-0">foxxmd</span><span class="hl-1">/</span><span class="hl-0">string</span><span class="hl-1">-</span><span class="hl-0">sameness</span>
31
31
</code></pre>
32
-
<pre><code class="language-js"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">stringSameness</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@foxxmd/string-sameness'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">result</span><span class="hl-1"> = </span><span class="hl-6">stringSameness</span><span class="hl-1">(</span><span class="hl-3">'This is one sentence'</span><span class="hl-1">, </span><span class="hl-3">'This is another sentence'</span><span class="hl-1">);</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">result</span><span class="hl-1">);</span><br/><span class="hl-7">//{</span><br/><span class="hl-7">// "strategies": {</span><br/><span class="hl-7">// "dice": {</span><br/><span class="hl-7">// "score": 66.66666666666666</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// "leven": {</span><br/><span class="hl-7">// "distance": 5,</span><br/><span class="hl-7">// "score": 79.16666666666666</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// "cosine": {</span><br/><span class="hl-7">// "score": 75</span><br/><span class="hl-7">// }</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// "highScore": 73.6111111111111,</span><br/><span class="hl-7">// "highScoreWeighted": 83.58977247888106</span><br/><span class="hl-7">//}</span>
32
+
<pre><code class="language-js"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">stringSameness</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'@foxxmd/string-sameness'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">result</span><span class="hl-1"> = </span><span class="hl-6">stringSameness</span><span class="hl-1">(</span><span class="hl-3">'This is one sentence'</span><span class="hl-1">, </span><span class="hl-3">'This is another sentence'</span><span class="hl-1">);</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">result</span><span class="hl-1">);</span><br/><span class="hl-7">// {</span><br/><span class="hl-7">// "strategies": {</span><br/><span class="hl-7">// "dice": {</span><br/><span class="hl-7">// "rawScore": 0.6666,</span><br/><span class="hl-7">// "score": 66.66</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// "leven": {</span><br/><span class="hl-7">// "rawScore": 5,</span><br/><span class="hl-7">// "distance": 5,</span><br/><span class="hl-7">// "score": 79.16</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// "cosine": {</span><br/><span class="hl-7">// "rawScore": 0.75,</span><br/><span class="hl-7">// "score": 75</span><br/><span class="hl-7">// }</span><br/><span class="hl-7">// },</span><br/><span class="hl-7">// "highScore": 73.61,</span><br/><span class="hl-7">// "highScoreWeighted": 83.58</span><br/><span class="hl-7">// }</span>
33
33
</code></pre>
34
34
35
35
<a href="#options" id="options" style="color: inherit; text-decoration: none;">
+3
-3
interfaces/StringComparisonOptions.html
+3
-3
interfaces/StringComparisonOptions.html
···
20
20
<ul class="tsd-hierarchy">
21
21
<li><span class="target">StringComparisonOptions</span></li></ul></section><aside class="tsd-sources">
22
22
<ul>
23
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/atomic.ts#L1">atomic.ts:1</a></li></ul></aside>
23
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/atomic.ts#L1">atomic.ts:1</a></li></ul></aside>
24
24
<section class="tsd-panel-group tsd-index-group">
25
25
<section class="tsd-panel tsd-index-panel">
26
26
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
···
37
37
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transforms</span><a href="#transforms" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
38
38
<div class="tsd-signature">transforms<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>str<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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
39
39
<ul>
40
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/atomic.ts#L2">atomic.ts:2</a></li></ul></aside></section>
40
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/atomic.ts#L2">atomic.ts:2</a></li></ul></aside></section>
41
41
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strategies" class="tsd-anchor"></a>
42
42
<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>
43
43
<div class="tsd-signature">strategies<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
44
44
<ul>
45
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/atomic.ts#L3">atomic.ts:3</a></li></ul></aside></section></section></div>
45
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/atomic.ts#L3">atomic.ts:3</a></li></ul></aside></section></section></div>
46
46
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
47
47
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav>
48
48
<div class="tsd-navigation settings">
+4
-4
interfaces/StringSamenessResult.html
+4
-4
interfaces/StringSamenessResult.html
···
20
20
<ul class="tsd-hierarchy">
21
21
<li><span class="target">StringSamenessResult</span></li></ul></section><aside class="tsd-sources">
22
22
<ul>
23
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/atomic.ts#L6">atomic.ts:6</a></li></ul></aside>
23
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/atomic.ts#L6">atomic.ts:6</a></li></ul></aside>
24
24
<section class="tsd-panel-group tsd-index-group">
25
25
<section class="tsd-panel tsd-index-panel">
26
26
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
···
43
43
<li class="tsd-parameter-index-signature">
44
44
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">ComparisonStrategyResult</span></h5></li></ul></div><aside class="tsd-sources">
45
45
<ul>
46
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/atomic.ts#L7">atomic.ts:7</a></li></ul></aside></section>
46
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/atomic.ts#L7">atomic.ts:7</a></li></ul></aside></section>
47
47
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="highScore" class="tsd-anchor"></a>
48
48
<h3 class="tsd-anchor-link"><span>high<wbr/>Score</span><a href="#highScore" 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>
49
49
<div class="tsd-signature">high<wbr/>Score<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
50
50
<ul>
51
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/atomic.ts#L10">atomic.ts:10</a></li></ul></aside></section>
51
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/atomic.ts#L10">atomic.ts:10</a></li></ul></aside></section>
52
52
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="highScoreWeighted" class="tsd-anchor"></a>
53
53
<h3 class="tsd-anchor-link"><span>high<wbr/>Score<wbr/>Weighted</span><a href="#highScoreWeighted" 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>
54
54
<div class="tsd-signature">high<wbr/>Score<wbr/>Weighted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
55
55
<ul>
56
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/atomic.ts#L11">atomic.ts:11</a></li></ul></aside></section></section></div>
56
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/atomic.ts#L11">atomic.ts:11</a></li></ul></aside></section></section></div>
57
57
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
58
58
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav>
59
59
<div class="tsd-navigation settings">
+1
-1
variables/defaultStrCompareTransformFuncs.html
+1
-1
variables/defaultStrCompareTransformFuncs.html
···
17
17
<h1>Variable defaultStrCompareTransformFuncs<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
18
18
<div class="tsd-signature">default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>str<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">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
19
19
<ul>
20
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/index.ts#L15">index.ts:15</a></li></ul></aside></div>
20
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/index.ts#L15">index.ts:15</a></li></ul></aside></div>
21
21
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
22
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav>
23
23
<div class="tsd-navigation settings">
+1
-1
variables/defaultStrategies.html
+1
-1
variables/defaultStrategies.html
···
17
17
<h1>Variable defaultStrategies<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
18
18
<div class="tsd-signature">default<wbr/>Strategies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
19
19
<ul>
20
-
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/5fa531a/src/index.ts#L26">index.ts:26</a></li></ul></aside></div>
20
+
<li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/d78cc6b/src/index.ts#L26">index.ts:26</a></li></ul></aside></div>
21
21
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
22
22
<nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav>
23
23
<div class="tsd-navigation settings">