Deploying to gh-pages from @ FoxxMD/string-sameness@5fa531a127c8e4140f38d48dc28db65498cf79e5 🚀 · foxxmd.dev/string-sameness@73f16a7

+11 -4

assets/highlight.css

··· 15 15 --dark-hl-6: #DCDCAA; 16 16 --light-hl-7: #008000; 17 17 --dark-hl-7: #6A9955; 18 - --light-hl-8: #811F3F; 19 - --dark-hl-8: #D16969; 20 - --light-hl-9: #D16969; 21 - --dark-hl-9: #CE9178; 18 + --light-hl-8: #267F99; 19 + --dark-hl-8: #4EC9B0; 20 + --light-hl-9: #811F3F; 21 + --dark-hl-9: #D16969; 22 + --light-hl-10: #D16969; 23 + --dark-hl-10: #CE9178; 22 24 --light-code-background: #FFFFFF; 23 25 --dark-code-background: #1E1E1E; 24 26 } ··· 34 36 --hl-7: var(--light-hl-7); 35 37 --hl-8: var(--light-hl-8); 36 38 --hl-9: var(--light-hl-9); 39 + --hl-10: var(--light-hl-10); 37 40 --code-background: var(--light-code-background); 38 41 } } 39 42 ··· 48 51 --hl-7: var(--dark-hl-7); 49 52 --hl-8: var(--dark-hl-8); 50 53 --hl-9: var(--dark-hl-9); 54 + --hl-10: var(--dark-hl-10); 51 55 --code-background: var(--dark-code-background); 52 56 } } 53 57 ··· 62 66 --hl-7: var(--light-hl-7); 63 67 --hl-8: var(--light-hl-8); 64 68 --hl-9: var(--light-hl-9); 69 + --hl-10: var(--light-hl-10); 65 70 --code-background: var(--light-code-background); 66 71 } 67 72 ··· 76 81 --hl-7: var(--dark-hl-7); 77 82 --hl-8: var(--dark-hl-8); 78 83 --hl-9: var(--dark-hl-9); 84 + --hl-10: var(--dark-hl-10); 79 85 --code-background: var(--dark-code-background); 80 86 } 81 87 ··· 89 95 .hl-7 { color: var(--hl-7); } 90 96 .hl-8 { color: var(--hl-8); } 91 97 .hl-9 { color: var(--hl-9); } 98 + .hl-10 { color: var(--hl-10); } 92 99 pre, code { background: var(--code-background); }

+1 -1

assets/search.js

··· 1 - window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"8388608\":\"Reference\"},\"rows\":[{\"kind\":32,\"name\":\"defaultStrCompareTransformFuncs\",\"url\":\"variables/defaultStrCompareTransformFuncs.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":256,\"name\":\"StringComparisonOptions\",\"url\":\"interfaces/StringComparisonOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"transforms\",\"url\":\"interfaces/StringComparisonOptions.html#transforms\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringComparisonOptions\"},{\"kind\":256,\"name\":\"StringSamenessResult\",\"url\":\"interfaces/StringSamenessResult.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"scores\",\"url\":\"interfaces/StringSamenessResult.html#scores\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringSamenessResult\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/StringSamenessResult.html#scores.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"StringSamenessResult.scores\"},{\"kind\":1024,\"name\":\"dice\",\"url\":\"interfaces/StringSamenessResult.html#scores.__type.dice\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"StringSamenessResult.scores.__type\"},{\"kind\":1024,\"name\":\"cosine\",\"url\":\"interfaces/StringSamenessResult.html#scores.__type.cosine\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"StringSamenessResult.scores.__type\"},{\"kind\":1024,\"name\":\"leven\",\"url\":\"interfaces/StringSamenessResult.html#scores.__type.leven\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"StringSamenessResult.scores.__type\"},{\"kind\":1024,\"name\":\"highScore\",\"url\":\"interfaces/StringSamenessResult.html#highScore\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringSamenessResult\"},{\"kind\":1024,\"name\":\"highScoreWeighted\",\"url\":\"interfaces/StringSamenessResult.html#highScoreWeighted\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringSamenessResult\"},{\"kind\":64,\"name\":\"stringSameness\",\"url\":\"functions/stringSameness.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":8388608,\"name\":\"default\",\"url\":\"modules.html#default\",\"classes\":\"tsd-kind-reference\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,22.336]],[\"comment/0\",[]],[\"name/1\",[1,22.336]],[\"comment/1\",[]],[\"name/2\",[2,22.336]],[\"comment/2\",[]],[\"name/3\",[3,22.336]],[\"comment/3\",[]],[\"name/4\",[4,22.336]],[\"comment/4\",[]],[\"name/5\",[5,22.336]],[\"comment/5\",[]],[\"name/6\",[6,22.336]],[\"comment/6\",[]],[\"name/7\",[7,22.336]],[\"comment/7\",[]],[\"name/8\",[8,22.336]],[\"comment/8\",[]],[\"name/9\",[9,22.336]],[\"comment/9\",[]],[\"name/10\",[10,22.336]],[\"comment/10\",[]],[\"name/11\",[11,33.504]],[\"comment/11\",[]],[\"name/12\",[12,22.336]],[\"comment/12\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"cosine\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"default\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"defaultstrcomparetransformfuncs\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"dice\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"highscore\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"highscoreweighted\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"leven\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"scores\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"stringcomparisonoptions\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"stringsameness\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"stringsamenessresult\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"transforms\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); 1 + window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"65536\":\"Type literal\"},\"rows\":[{\"kind\":64,\"name\":\"stringSameness\",\"url\":\"functions/stringSameness.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"createStringSameness\",\"url\":\"functions/createStringSameness.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createStringSameness.html#createStringSameness.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"createStringSameness.createStringSameness\"},{\"kind\":32,\"name\":\"defaultStrategies\",\"url\":\"variables/defaultStrategies.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":32,\"name\":\"defaultStrCompareTransformFuncs\",\"url\":\"variables/defaultStrCompareTransformFuncs.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":256,\"name\":\"StringSamenessResult\",\"url\":\"interfaces/StringSamenessResult.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"strategies\",\"url\":\"interfaces/StringSamenessResult.html#strategies\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringSamenessResult\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/StringSamenessResult.html#strategies.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"StringSamenessResult.strategies\"},{\"kind\":1024,\"name\":\"highScore\",\"url\":\"interfaces/StringSamenessResult.html#highScore\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringSamenessResult\"},{\"kind\":1024,\"name\":\"highScoreWeighted\",\"url\":\"interfaces/StringSamenessResult.html#highScoreWeighted\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringSamenessResult\"},{\"kind\":256,\"name\":\"StringComparisonOptions\",\"url\":\"interfaces/StringComparisonOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"transforms\",\"url\":\"interfaces/StringComparisonOptions.html#transforms\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringComparisonOptions\"},{\"kind\":1024,\"name\":\"strategies\",\"url\":\"interfaces/StringComparisonOptions.html#strategies\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringComparisonOptions\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,33.504]],[\"comment/0\",[]],[\"name/1\",[1,33.504]],[\"comment/1\",[]],[\"name/2\",[2,17.228]],[\"comment/2\",[]],[\"name/3\",[3,22.336]],[\"comment/3\",[]],[\"name/4\",[4,22.336]],[\"comment/4\",[]],[\"name/5\",[5,22.336]],[\"comment/5\",[]],[\"name/6\",[6,17.228]],[\"comment/6\",[]],[\"name/7\",[2,17.228]],[\"comment/7\",[]],[\"name/8\",[7,22.336]],[\"comment/8\",[]],[\"name/9\",[8,22.336]],[\"comment/9\",[]],[\"name/10\",[9,22.336]],[\"comment/10\",[]],[\"name/11\",[10,22.336]],[\"comment/11\",[]],[\"name/12\",[6,17.228]],[\"comment/12\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":2,\"name\":{\"2\":{},\"7\":{}},\"comment\":{}}],[\"createstringsameness\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"defaultstrategies\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"defaultstrcomparetransformfuncs\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"highscore\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"highscoreweighted\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"strategies\",{\"_index\":6,\"name\":{\"6\":{},\"12\":{}},\"comment\":{}}],[\"stringcomparisonoptions\",{\"_index\":9,\"name\":{\"10\":{}},\"comment\":{}}],[\"stringsameness\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"stringsamenessresult\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"transforms\",{\"_index\":10,\"name\":{\"11\":{}},\"comment\":{}}]],\"pipeline\":[]}}");

+77

functions/createStringSameness.html

··· 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createStringSameness | FoxxMD Common Libs</title><meta name="description" content="Documentation for FoxxMD Common Libs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> 2 + <div class="tsd-toolbar-contents container"> 3 + <div class="table-cell" id="tsd-search" data-base=".."> 4 + <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> 5 + <div class="field"> 6 + <div id="tsd-toolbar-links"><a href="https://github.com/foxxmd/common-libs">Docs</a><a href="https://github.com/foxxmd/common-libs">GitHub</a></div></div> 7 + <ul class="results"> 8 + <li class="state loading">Preparing search index...</li> 9 + <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">FoxxMD Common Libs</a></div> 10 + <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> 11 + <div class="container container-main"> 12 + <div class="col-8 col-content"> 13 + <div class="tsd-page-title"> 14 + <ul class="tsd-breadcrumb"> 15 + <li><a href="../modules.html">FoxxMD Common Libs</a></li> 16 + <li><a href="createStringSameness.html">createStringSameness</a></li></ul> 17 + <h1>Function createStringSameness</h1></div> 18 + <section class="tsd-panel"> 19 + <ul class="tsd-signatures tsd-kind-function"> 20 + <li class="tsd-signature tsd-anchor-link" id="createStringSameness">create<wbr/>String<wbr/>Sameness<span class="tsd-signature-symbol">(</span>defaults<span class="tsd-signature-symbol">: </span><a href="../interfaces/StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>valA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, valB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/StringSamenessResult.html" class="tsd-signature-type" data-tsd-kind="Interface">StringSamenessResult</a><span class="tsd-signature-symbol">)</span><a href="#createStringSameness" 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></li> 21 + <li class="tsd-description"> 22 + <div class="tsd-parameters"> 23 + <h4 class="tsd-parameters-title">Parameters</h4> 24 + <ul class="tsd-parameter-list"> 25 + <li> 26 + <h5>defaults: <a href="../interfaces/StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a></h5></li></ul></div> 27 + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>valA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, valB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/StringSamenessResult.html" class="tsd-signature-type" data-tsd-kind="Interface">StringSamenessResult</a><span class="tsd-signature-symbol">)</span></h4> 28 + <ul class="tsd-parameters"> 29 + <li class="tsd-parameter-signature"> 30 + <ul class="tsd-signatures tsd-kind-type-literal"> 31 + <li class="tsd-signature" id="createStringSameness.__type.__type-1"><span class="tsd-signature-symbol">(</span>valA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, valB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/StringSamenessResult.html" class="tsd-signature-type" data-tsd-kind="Interface">StringSamenessResult</a></li> 32 + <li class="tsd-description"> 33 + <div class="tsd-parameters"> 34 + <h4 class="tsd-parameters-title">Parameters</h4> 35 + <ul class="tsd-parameter-list"> 36 + <li> 37 + <h5>valA: <span class="tsd-signature-type">string</span></h5></li> 38 + <li> 39 + <h5>valB: <span class="tsd-signature-type">string</span></h5></li> 40 + <li> 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 + <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 + <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> 45 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 46 + <nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav> 47 + <div class="tsd-navigation settings"> 48 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 49 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> 50 + <div class="tsd-accordion-details"> 51 + <div class="tsd-filter-visibility"> 52 + <h4 class="uppercase">Member Visibility</h4><form> 53 + <ul id="tsd-filter-options"> 54 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> 55 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> 56 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> 57 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> 58 + <div class="tsd-theme-toggle"> 59 + <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> 60 + <nav class="tsd-navigation primary"> 61 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 62 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> 63 + <div class="tsd-accordion-details"> 64 + <ul> 65 + <li><a href="../modules.html">FoxxMD <wbr/>Common <wbr/>Libs</a> 66 + <ul></ul></li></ul></div></details></nav> 67 + <nav class="tsd-navigation secondary menu-sticky"> 68 + <ul> 69 + <li class="tsd-kind-interface"><a href="../interfaces/StringComparisonOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>String<wbr/>Comparison<wbr/>Options</a></li> 70 + <li class="tsd-kind-interface"><a href="../interfaces/StringSamenessResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>String<wbr/>Sameness<wbr/>Result</a></li> 71 + <li class="tsd-kind-variable"><a href="../variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 72 + <li class="tsd-kind-variable"><a href="../variables/defaultStrategies.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Strategies</a></li> 73 + <li class="tsd-kind-function"><a href="stringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>string<wbr/>Sameness</a></li> 74 + <li class="current tsd-kind-function"><a href="createStringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>create<wbr/>String<wbr/>Sameness</a></li></ul></nav></div></div> 75 + <div class="container tsd-generator"> 76 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 77 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+4 -3

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/3915030/src/index.ts#L36">index.ts:36</a></li></ul></aside></li></ul></section></div> 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> 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"> ··· 55 55 <ul></ul></li></ul></div></details></nav> 56 56 <nav class="tsd-navigation secondary menu-sticky"> 57 57 <ul> 58 - <li class="tsd-kind-variable"><a href="../variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 59 58 <li class="tsd-kind-interface"><a href="../interfaces/StringComparisonOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>String<wbr/>Comparison<wbr/>Options</a></li> 60 59 <li class="tsd-kind-interface"><a href="../interfaces/StringSamenessResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>String<wbr/>Sameness<wbr/>Result</a></li> 60 + <li class="tsd-kind-variable"><a href="../variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 61 + <li class="tsd-kind-variable"><a href="../variables/defaultStrategies.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Strategies</a></li> 61 62 <li class="current tsd-kind-function"><a href="stringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>string<wbr/>Sameness</a></li> 62 - <li class="tsd-kind-reference"><a href="../modules.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg>default</a></li></ul></nav></div></div> 63 + <li class="tsd-kind-function"><a href="createStringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>create<wbr/>String<wbr/>Sameness</a></li></ul></nav></div></div> 63 64 <div class="container tsd-generator"> 64 65 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 65 66 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+44 -14

index.html

··· 16 16 <a href="#string-sameness" id="string-sameness" style="color: inherit; text-decoration: none;"> 17 17 <h1>string-sameness</h1> 18 18 </a> 19 - <p>Generate a score that represents how closely the same two strings are. The comparison function uses an average of:</p> 20 - <ul> 21 - <li><a href="https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient">Dice's Coefficient</a></li> 22 - <li><a href="https://en.wikipedia.org/wiki/Cosine_similarity">Cosine Similarity</a></li> 23 - <li><a href="https://en.wikipedia.org/wiki/Levenshtein_distance">Levenshtein Distance</a></li> 24 - </ul> 25 - <p>weighted by the length of the content being compared (more weight for longer content).</p> 19 + <p>Generate scores that represents how similar two strings are based on different string comparison algorithms.</p> 20 + <p>Scores from all used algorithms are averaged and then weighted by the length of the content being compared (more weight for longer content).</p> 26 21 <p>The sameness is then given a <strong>score of 0 to 100.</strong></p> 27 22 <ul> 28 23 <li>0 => Totally unique pieces of content</li> ··· 30 25 </ul> 31 26 32 27 <a href="#installusage" id="installusage" style="color: inherit; text-decoration: none;"> 33 - <h2>Install/Usage</h2> 28 + <h1>Install/Usage</h1> 34 29 </a> 35 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> 36 31 </code></pre> 37 - <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">// "scores": {</span><br/><span class="hl-7">// "dice": 66.66,</span><br/><span class="hl-7">// "cosine": 75,</span><br/><span class="hl-7">// "leven": 79.16</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> 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> 33 + </code></pre> 34 + 35 + <a href="#options" id="options" style="color: inherit; text-decoration: none;"> 36 + <h1>Options</h1> 37 + </a> 38 + <p>An optional third argument can be provided to <code>stringSameness</code> to customize how strings are normalized before comparison and what strategies are used for comparison.</p> 39 + 40 + <a href="#strategies" id="strategies" style="color: inherit; text-decoration: none;"> 41 + <h2>Strategies</h2> 42 + </a> 43 + <p>Pass a list of <code>ComparisonStrategy</code> objects using <code>{strategies: []}</code> to define which string comparisons should be performed on the given strings.</p> 44 + <p>The average of the scores from all passed strategies is returned as <code>highScore</code> (and <code>highScoreWeighted</code>) from <code>stringSameness()</code></p> 45 + <p>When no strategies are explicitly passed a default set of strategies is used, found in <code>@foxxmd/string-sameness/strategies</code>:</p> 46 + <ul> 47 + <li><a href="https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient">Dice's Coefficient</a> in <a href="/src/matchingStrategies/diceSimilarity.ts"><code>diceSimilarities.ts</code></a></li> 48 + <li><a href="https://en.wikipedia.org/wiki/Cosine_similarity">Cosine Similarity</a> in <a href="/src/matchingStrategies/cosineSimilarity.ts"><code>cosineSimilarities.ts</code></a></li> 49 + <li><a href="https://en.wikipedia.org/wiki/Levenshtein_distance">Levenshtein Distance</a> in <a href="/src/matchingStrategies/levenSimilarity.ts"><code>levenSimilarities.ts</code></a></li> 50 + </ul> 51 + 52 + <a href="#bring-your-own-strategy" id="bring-your-own-strategy" style="color: inherit; text-decoration: none;"> 53 + <h3>Bring Your Own Strategy</h3> 54 + </a> 55 + <p>Use your own strategy by creating an object that conforms to <code>ComparisonStrategy</code>:</p> 56 + <pre><code class="language-ts"><span class="hl-2">export</span><span class="hl-1"> </span><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-8">ComparisonStrategy</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">/**</span><br/><span class="hl-7"> * The name of this strategy</span><br/><span class="hl-7"> * */</span><br/><span class="hl-1"> </span><span class="hl-0">name</span><span class="hl-1">: </span><span class="hl-8">string</span><br/><span class="hl-1"> </span><span class="hl-7">/**</span><br/><span class="hl-7"> * A function that accepts two string arguments and returns a number between 0 and 100 signifying how closely similar the strings are:</span><br/><span class="hl-7"> * 0 => not similar at all</span><br/><span class="hl-7"> * 100 => identical</span><br/><span class="hl-7"> * */</span><br/><span class="hl-1"> </span><span class="hl-6">strategy</span><span class="hl-1">: (</span><span class="hl-0">strA</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">, </span><span class="hl-0">strB</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-8">number</span><br/><span class="hl-1"> </span><span class="hl-7">/**</span><br/><span class="hl-7"> * An optional function that accepts two string arguments and returns whether this strategy should be used</span><br/><span class="hl-7"> * */</span><br/><span class="hl-1"> </span><span class="hl-6">isValid</span><span class="hl-1">?: (</span><span class="hl-0">strA</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">, </span><span class="hl-0">strB</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-8">boolean</span><br/><span class="hl-1">}</span> 57 + </code></pre> 58 + <p>Example of using your own strategy with the defaults:</p> 59 + <pre><code class="language-ts"><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/><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">ComparisonStrategy</span><span class="hl-1">, </span><span class="hl-0">levenStrategy</span><span class="hl-1">, </span><span class="hl-0">cosineStrategy</span><span class="hl-1">, </span><span class="hl-0">diceStrategy</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">"@foxxmd/string-sameness/strategies"</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">myStrat</span><span class="hl-1">: </span><span class="hl-8">ComparisonStrategy</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">'MyCoolStrat'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">strategy</span><span class="hl-0">:</span><span class="hl-1"> (</span><span class="hl-0">valA</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">, </span><span class="hl-0">valB</span><span class="hl-1">: </span><span class="hl-8">string</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">a</span><span class="hl-1"> = </span><span class="hl-0">valA</span><span class="hl-1">.</span><span class="hl-6">concat</span><span class="hl-1">(</span><span class="hl-0">valB</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-2">return</span><span class="hl-1"> </span><span class="hl-0">a</span><span class="hl-1">.</span><span class="hl-0">length</span><span class="hl-1">;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">}</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">strats</span><span class="hl-1"> = [</span><br/><span class="hl-1"> </span><span class="hl-0">levenStrategy</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">cosineStrategy</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">diceStrategy</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">myStrat</span><br/><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><span class="hl-0">strategies:</span><span class="hl-1"> </span><span class="hl-0">strats</span><span class="hl-1">});</span> 38 60 </code></pre> 39 61 40 62 <a href="#normalization" id="normalization" style="color: inherit; text-decoration: none;"> 41 - <h3>Normalization</h3> 63 + <h2>Normalization</h2> 42 64 </a> 43 - <p>A third argument may be passed to <code>stringSameness</code> to provide a list of functions to apply to the strings to compare. When not explicitly provided a default set of functions is applied to normalize the strings (to remove trivial differences):</p> 65 + <p>Pass a list of functions using <code>{transforms: []}</code> to transform the strings before comparison. When not explicitly provided a default set of functions is applied to normalize the strings (to remove trivial differences):</p> 44 66 <ul> 45 67 <li>convert to lowercase</li> 46 68 <li>trim (remove whitespace at beginning/end)</li> ··· 49 71 </ul> 50 72 <p>This default set of functions is exported as <code>defaultStrCompareTransformFuncs</code>.</p> 51 73 <p>Example of supplying your own transform functions:</p> 52 - <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-0">defaultStrCompareTransformFuncs</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">myFuncs</span><span class="hl-1"> = [</span><br/><span class="hl-1"> ...</span><span class="hl-0">defaultStrCompareTransformFuncs</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">// replace all vowels with the letter e</span><br/><span class="hl-1"> (</span><span class="hl-0">str</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-0">str</span><span class="hl-1">.</span><span class="hl-6">replace</span><span class="hl-1">(</span><span class="hl-8">/</span><span class="hl-9">[</span><span class="hl-8">aeiou</span><span class="hl-9">]</span><span class="hl-8">/</span><span class="hl-4">ig</span><span class="hl-1">, </span><span class="hl-3">'e'</span><span class="hl-1">)</span><br/><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><span class="hl-0">myFuncs</span><span class="hl-1">);</span> 74 + <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-0">defaultStrCompareTransformFuncs</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">myFuncs</span><span class="hl-1"> = [</span><br/><span class="hl-1"> ...</span><span class="hl-0">defaultStrCompareTransformFuncs</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">// replace all vowels with the letter e</span><br/><span class="hl-1"> (</span><span class="hl-0">str</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-0">str</span><span class="hl-1">.</span><span class="hl-6">replace</span><span class="hl-1">(</span><span class="hl-9">/</span><span class="hl-10">[</span><span class="hl-9">aeiou</span><span class="hl-10">]</span><span class="hl-9">/</span><span class="hl-4">ig</span><span class="hl-1">, </span><span class="hl-3">'e'</span><span class="hl-1">)</span><br/><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><span class="hl-0">transforms:</span><span class="hl-1"> </span><span class="hl-0">myFuncs</span><span class="hl-1">});</span> 75 + </code></pre> 76 + 77 + <a href="#factory" id="factory" style="color: inherit; text-decoration: none;"> 78 + <h2>Factory</h2> 79 + </a> 80 + <p>For convenience, a factory function is also provided:</p> 81 + <pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">createStringSameness</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/><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">levenStrategy</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">"@foxxmd/string-sameness/strategies"</span><span class="hl-1">;</span><br/><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">myTransforms</span><span class="hl-1">, </span><span class="hl-0">myStrats</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">'./util'</span><span class="hl-1">;</span><br/><br/><span class="hl-7">// sets the default object to used with the third argument for `stringSameness`</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">myCompare</span><span class="hl-1"> = </span><span class="hl-6">createStringSameness</span><span class="hl-1">({</span><span class="hl-0">transforms:</span><span class="hl-1"> </span><span class="hl-0">myTransforms</span><span class="hl-1">, </span><span class="hl-0">strategies:</span><span class="hl-1"> </span><span class="hl-0">myStrats</span><span class="hl-1">});</span><br/><br/><span class="hl-7">// uses myTransforms and myStrats</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">plainResult</span><span class="hl-1"> = </span><span class="hl-6">myCompare</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/><br/><span class="hl-7">// override your defaults using the third argument like normal</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">overrideResults</span><span class="hl-1"> = </span><span class="hl-6">myCompare</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><span class="hl-0">strategies:</span><span class="hl-1"> [</span><span class="hl-0">levenStrategy</span><span class="hl-1">]});</span> 53 82 </code></pre> 54 83 </div></div> 55 84 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> ··· 76 105 <ul></ul></li></ul></div></details></nav> 77 106 <nav class="tsd-navigation secondary menu-sticky"> 78 107 <ul> 79 - <li class="tsd-kind-variable"><a href="variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 80 108 <li class="tsd-kind-interface"><a href="interfaces/StringComparisonOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>String<wbr/>Comparison<wbr/>Options</a></li> 81 109 <li class="tsd-kind-interface"><a href="interfaces/StringSamenessResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>String<wbr/>Sameness<wbr/>Result</a></li> 110 + <li class="tsd-kind-variable"><a href="variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 111 + <li class="tsd-kind-variable"><a href="variables/defaultStrategies.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Strategies</a></li> 82 112 <li class="tsd-kind-function"><a href="functions/stringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>string<wbr/>Sameness</a></li> 83 - <li class="tsd-kind-reference"><a href="modules.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg>default</a></li></ul></nav></div></div> 113 + <li class="tsd-kind-function"><a href="functions/createStringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>create<wbr/>String<wbr/>Sameness</a></li></ul></nav></div></div> 84 114 <div class="container tsd-generator"> 85 115 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 86 116 <div class="overlay"></div><script src="assets/main.js"></script></body></html>

+10 -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/3915030/src/index.ts#L21">index.ts:21</a></li></ul></aside> 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> 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"> ··· 29 29 <section class="tsd-index-section"> 30 30 <h3 class="tsd-index-heading">Properties</h3> 31 31 <div class="tsd-index-list"><a href="StringComparisonOptions.html#transforms" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>transforms?</span></a> 32 + <a href="StringComparisonOptions.html#strategies" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>strategies?</span></a> 32 33 </div></section></div></details></section></section> 33 34 <section class="tsd-panel-group tsd-member-group"> 34 35 <h2>Properties</h2> ··· 36 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> 37 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"> 38 39 <ul> 39 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/3915030/src/index.ts#L22">index.ts:22</a></li></ul></aside></section></section></div> 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> 41 + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strategies" class="tsd-anchor"></a> 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 + <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 + <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> 40 46 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 41 47 <nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav> 42 48 <div class="tsd-navigation settings"> ··· 63 69 <ul> 64 70 <li class="current tsd-kind-interface"><a href="StringComparisonOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>String<wbr/>Comparison<wbr/>Options</span></a> 65 71 <ul> 66 - <li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringComparisonOptions.html#transforms" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>transforms?</a></li></ul></li></ul></nav></div></div> 72 + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringComparisonOptions.html#transforms" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>transforms?</a></li> 73 + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringComparisonOptions.html#strategies" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>strategies?</a></li></ul></li></ul></nav></div></div> 67 74 <div class="container tsd-generator"> 68 75 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 69 76 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+11 -15

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/3915030/src/index.ts#L25">index.ts:25</a></li></ul></aside> 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> 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"> ··· 28 28 <div class="tsd-accordion-details"> 29 29 <section class="tsd-index-section"> 30 30 <h3 class="tsd-index-heading">Properties</h3> 31 - <div class="tsd-index-list"><a href="StringSamenessResult.html#scores" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>scores</span></a> 31 + <div class="tsd-index-list"><a href="StringSamenessResult.html#strategies" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>strategies</span></a> 32 32 <a href="StringSamenessResult.html#highScore" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>high<wbr/>Score</span></a> 33 33 <a href="StringSamenessResult.html#highScoreWeighted" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>high<wbr/>Score<wbr/>Weighted</span></a> 34 34 </div></section></div></details></section></section> 35 35 <section class="tsd-panel-group tsd-member-group"> 36 36 <h2>Properties</h2> 37 - <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="scores" class="tsd-anchor"></a> 38 - <h3 class="tsd-anchor-link"><span>scores</span><a href="#scores" 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> 39 - <div class="tsd-signature">scores<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>dice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>cosine<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span>leven<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> 37 + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strategies" class="tsd-anchor"></a> 38 + <h3 class="tsd-anchor-link"><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"><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> 39 + <div class="tsd-signature">strategies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[key: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategyResult</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> 40 40 <div class="tsd-type-declaration"> 41 41 <h4>Type declaration</h4> 42 42 <ul class="tsd-parameters"> 43 - <li class="tsd-parameter"> 44 - <h5>dice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li> 45 - <li class="tsd-parameter"> 46 - <h5>cosine<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li> 47 - <li class="tsd-parameter"> 48 - <h5>leven<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><aside class="tsd-sources"> 43 + <li class="tsd-parameter-index-signature"> 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"> 49 45 <ul> 50 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/3915030/src/index.ts#L26">index.ts:26</a></li></ul></aside></section> 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> 51 47 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="highScore" class="tsd-anchor"></a> 52 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> 53 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"> 54 50 <ul> 55 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/3915030/src/index.ts#L31">index.ts:31</a></li></ul></aside></section> 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> 56 52 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="highScoreWeighted" class="tsd-anchor"></a> 57 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> 58 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"> 59 55 <ul> 60 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/3915030/src/index.ts#L32">index.ts:32</a></li></ul></aside></section></section></div> 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> 61 57 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 62 58 <nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav> 63 59 <div class="tsd-navigation settings"> ··· 84 80 <ul> 85 81 <li class="current tsd-kind-interface"><a href="StringSamenessResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>String<wbr/>Sameness<wbr/>Result</span></a> 86 82 <ul> 87 - <li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringSamenessResult.html#scores" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>scores</a></li> 83 + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringSamenessResult.html#strategies" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>strategies</a></li> 88 84 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringSamenessResult.html#highScore" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>high<wbr/>Score</a></li> 89 85 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringSamenessResult.html#highScoreWeighted" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>high<wbr/>Score<wbr/>Weighted</a></li></ul></li></ul></nav></div></div> 90 86 <div class="container tsd-generator">

+11 -18

modules.html

··· 14 14 <h2>FoxxMD Common Libs</h2></div> 15 15 <section class="tsd-panel-group tsd-index-group"> 16 16 <section class="tsd-panel tsd-index-panel"> 17 - <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> 18 - <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary> 19 - <div class="tsd-accordion-details"> 20 - <section class="tsd-index-section"> 21 - <h3 class="tsd-index-heading">Variables</h3> 22 - <div class="tsd-index-list"><a href="variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg><span>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</span></a> 23 - </div></section> 17 + <h3 class="tsd-index-heading uppercase">Index</h3> 24 18 <section class="tsd-index-section"> 25 19 <h3 class="tsd-index-heading">Interfaces</h3> 26 20 <div class="tsd-index-list"><a href="interfaces/StringComparisonOptions.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>String<wbr/>Comparison<wbr/>Options</span></a> 27 21 <a href="interfaces/StringSamenessResult.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>String<wbr/>Sameness<wbr/>Result</span></a> 28 22 </div></section> 29 23 <section class="tsd-index-section"> 24 + <h3 class="tsd-index-heading">Variables</h3> 25 + <div class="tsd-index-list"><a href="variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg><span>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</span></a> 26 + <a href="variables/defaultStrategies.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>default<wbr/>Strategies</span></a> 27 + </div></section> 28 + <section class="tsd-index-section"> 30 29 <h3 class="tsd-index-heading">Functions</h3> 31 30 <div class="tsd-index-list"><a href="functions/stringSameness.html" class="tsd-index-link tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>string<wbr/>Sameness</span></a> 32 - </div></section> 33 - <section class="tsd-index-section"> 34 - <h3 class="tsd-index-heading">References</h3> 35 - <div class="tsd-index-list"><a href="modules.html#default" class="tsd-index-link tsd-kind-reference"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg><span>default</span></a> 36 - </div></section></div></details></section></section> 37 - <section class="tsd-panel-group tsd-member-group"> 38 - <h2>References</h2> 39 - <section class="tsd-panel tsd-member tsd-kind-reference"><a id="default" class="tsd-anchor"></a> 40 - <h3 class="tsd-anchor-link"><span>default</span><a href="#default" 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>Renames and re-exports <a href="functions/stringSameness.html">stringSameness</a></section></section></div> 31 + <a href="functions/createStringSameness.html" class="tsd-index-link tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>create<wbr/>String<wbr/>Sameness</span></a> 32 + </div></section></section></section></div> 41 33 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 42 34 <nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav> 43 35 <div class="tsd-navigation settings"> ··· 62 54 <ul></ul></li></ul></div></details></nav> 63 55 <nav class="tsd-navigation secondary menu-sticky"> 64 56 <ul> 65 - <li class="tsd-kind-variable"><a href="variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 66 57 <li class="tsd-kind-interface"><a href="interfaces/StringComparisonOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>String<wbr/>Comparison<wbr/>Options</a></li> 67 58 <li class="tsd-kind-interface"><a href="interfaces/StringSamenessResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>String<wbr/>Sameness<wbr/>Result</a></li> 59 + <li class="tsd-kind-variable"><a href="variables/defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 60 + <li class="tsd-kind-variable"><a href="variables/defaultStrategies.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Strategies</a></li> 68 61 <li class="tsd-kind-function"><a href="functions/stringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>string<wbr/>Sameness</a></li> 69 - <li class="tsd-kind-reference"><a href="modules.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>default</a></li></ul></nav></div></div> 62 + <li class="tsd-kind-function"><a href="functions/createStringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>create<wbr/>String<wbr/>Sameness</a></li></ul></nav></div></div> 70 63 <div class="container tsd-generator"> 71 64 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 72 65 <div class="overlay"></div><script src="assets/main.js"></script></body></html>

+4 -3

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/3915030/src/index.ts#L10">index.ts:10</a></li></ul></aside></div> 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> 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"> ··· 42 42 <ul></ul></li></ul></div></details></nav> 43 43 <nav class="tsd-navigation secondary menu-sticky"> 44 44 <ul> 45 - <li class="current tsd-kind-variable"><a href="defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 46 45 <li class="tsd-kind-interface"><a href="../interfaces/StringComparisonOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>String<wbr/>Comparison<wbr/>Options</a></li> 47 46 <li class="tsd-kind-interface"><a href="../interfaces/StringSamenessResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>String<wbr/>Sameness<wbr/>Result</a></li> 47 + <li class="current tsd-kind-variable"><a href="defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 48 + <li class="tsd-kind-variable"><a href="defaultStrategies.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Strategies</a></li> 48 49 <li class="tsd-kind-function"><a href="../functions/stringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>string<wbr/>Sameness</a></li> 49 - <li class="tsd-kind-reference"><a href="../modules.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg>default</a></li></ul></nav></div></div> 50 + <li class="tsd-kind-function"><a href="../functions/createStringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>create<wbr/>String<wbr/>Sameness</a></li></ul></nav></div></div> 50 51 <div class="container tsd-generator"> 51 52 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 52 53 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+53

variables/defaultStrategies.html

··· 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>defaultStrategies | FoxxMD Common Libs</title><meta name="description" content="Documentation for FoxxMD Common Libs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> 2 + <div class="tsd-toolbar-contents container"> 3 + <div class="table-cell" id="tsd-search" data-base=".."> 4 + <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> 5 + <div class="field"> 6 + <div id="tsd-toolbar-links"><a href="https://github.com/foxxmd/common-libs">Docs</a><a href="https://github.com/foxxmd/common-libs">GitHub</a></div></div> 7 + <ul class="results"> 8 + <li class="state loading">Preparing search index...</li> 9 + <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">FoxxMD Common Libs</a></div> 10 + <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> 11 + <div class="container container-main"> 12 + <div class="col-8 col-content"> 13 + <div class="tsd-page-title"> 14 + <ul class="tsd-breadcrumb"> 15 + <li><a href="../modules.html">FoxxMD Common Libs</a></li> 16 + <li><a href="defaultStrategies.html">defaultStrategies</a></li></ul> 17 + <h1>Variable defaultStrategies<code class="tsd-tag ts-flagConst">Const</code> </h1></div> 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 + <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> 21 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 22 + <nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://typedoc.org/api" target="_blank">API</a></nav> 23 + <div class="tsd-navigation settings"> 24 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 25 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> 26 + <div class="tsd-accordion-details"> 27 + <div class="tsd-filter-visibility"> 28 + <h4 class="uppercase">Member Visibility</h4><form> 29 + <ul id="tsd-filter-options"> 30 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> 31 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> 32 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> 33 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> 34 + <div class="tsd-theme-toggle"> 35 + <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> 36 + <nav class="tsd-navigation primary"> 37 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 38 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> 39 + <div class="tsd-accordion-details"> 40 + <ul> 41 + <li><a href="../modules.html">FoxxMD <wbr/>Common <wbr/>Libs</a> 42 + <ul></ul></li></ul></div></details></nav> 43 + <nav class="tsd-navigation secondary menu-sticky"> 44 + <ul> 45 + <li class="tsd-kind-interface"><a href="../interfaces/StringComparisonOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>String<wbr/>Comparison<wbr/>Options</a></li> 46 + <li class="tsd-kind-interface"><a href="../interfaces/StringSamenessResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>String<wbr/>Sameness<wbr/>Result</a></li> 47 + <li class="tsd-kind-variable"><a href="defaultStrCompareTransformFuncs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 48 + <li class="current tsd-kind-variable"><a href="defaultStrategies.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Strategies</a></li> 49 + <li class="tsd-kind-function"><a href="../functions/stringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>string<wbr/>Sameness</a></li> 50 + <li class="tsd-kind-function"><a href="../functions/createStringSameness.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>create<wbr/>String<wbr/>Sameness</a></li></ul></nav></div></div> 51 + <div class="container tsd-generator"> 52 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 53 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

Configure Feed

Configure Feed