Deploying to gh-pages from @ FoxxMD/string-sameness@e078f29daa1992f6b4c021328e778c177f7eac58 🚀 · foxxmd.dev/string-sameness@98dd29c

+1 -1

assets/search.js

··· 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\":[]}}"); 1 + window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"reorderStr\",\"url\":\"functions/reorderStr.html\",\"classes\":\"tsd-kind-function\"},{\"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\":\"strategies\",\"url\":\"variables/strategies.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/strategies.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"strategies\"},{\"kind\":1024,\"name\":\"diceStrategy\",\"url\":\"variables/strategies.html#__type.diceStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"strategies.__type\"},{\"kind\":1024,\"name\":\"levenStrategy\",\"url\":\"variables/strategies.html#__type.levenStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"strategies.__type\"},{\"kind\":1024,\"name\":\"cosineStrategy\",\"url\":\"variables/strategies.html#__type.cosineStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"strategies.__type\"},{\"kind\":1024,\"name\":\"cosineStrategyAggressive\",\"url\":\"variables/strategies.html#__type.cosineStrategyAggressive\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"strategies.__type\"},{\"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\"},{\"kind\":1024,\"name\":\"reorder\",\"url\":\"interfaces/StringComparisonOptions.html#reorder\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"StringComparisonOptions\"},{\"kind\":32,\"name\":\"transforms\",\"url\":\"variables/transforms.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/transforms.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"transforms\"},{\"kind\":1024,\"name\":\"lowercase\",\"url\":\"variables/transforms.html#__type.lowercase\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transforms.__type\"},{\"kind\":1024,\"name\":\"trim\",\"url\":\"variables/transforms.html#__type.trim\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transforms.__type\"},{\"kind\":1024,\"name\":\"replaceMultiWhitespace\",\"url\":\"variables/transforms.html#__type.replaceMultiWhitespace\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transforms.__type\"},{\"kind\":1024,\"name\":\"replaceUnicode\",\"url\":\"variables/transforms.html#__type.replaceUnicode\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transforms.__type\"},{\"kind\":1024,\"name\":\"removeWhitespace\",\"url\":\"variables/transforms.html#__type.removeWhitespace\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transforms.__type\"},{\"kind\":1024,\"name\":\"removePunctuation\",\"url\":\"variables/transforms.html#__type.removePunctuation\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"transforms.__type\"},{\"kind\":32,\"name\":\"strDefaultTransforms\",\"url\":\"variables/strDefaultTransforms.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":256,\"name\":\"ComparisonStrategyResult\",\"url\":\"interfaces/ComparisonStrategyResult.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"score\",\"url\":\"interfaces/ComparisonStrategyResult.html#score\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"ComparisonStrategyResult\"},{\"kind\":1024,\"name\":\"rawScore\",\"url\":\"interfaces/ComparisonStrategyResult.html#rawScore\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"ComparisonStrategyResult\"},{\"kind\":4194304,\"name\":\"StringTransformFunc\",\"url\":\"types/StringTransformFunc.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/StringTransformFunc.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"StringTransformFunc\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,47.671]],[\"comment/0\",[]],[\"name/1\",[1,47.671]],[\"comment/1\",[]],[\"name/2\",[2,47.671]],[\"comment/2\",[]],[\"name/3\",[3,18.788]],[\"comment/3\",[]],[\"name/4\",[4,31.781]],[\"comment/4\",[]],[\"name/5\",[5,23.308]],[\"comment/5\",[]],[\"name/6\",[3,18.788]],[\"comment/6\",[]],[\"name/7\",[6,31.781]],[\"comment/7\",[]],[\"name/8\",[7,31.781]],[\"comment/8\",[]],[\"name/9\",[8,31.781]],[\"comment/9\",[]],[\"name/10\",[9,31.781]],[\"comment/10\",[]],[\"name/11\",[10,31.781]],[\"comment/11\",[]],[\"name/12\",[11,31.781]],[\"comment/12\",[]],[\"name/13\",[5,23.308]],[\"comment/13\",[]],[\"name/14\",[3,18.788]],[\"comment/14\",[]],[\"name/15\",[12,31.781]],[\"comment/15\",[]],[\"name/16\",[13,31.781]],[\"comment/16\",[]],[\"name/17\",[14,31.781]],[\"comment/17\",[]],[\"name/18\",[15,26.672]],[\"comment/18\",[]],[\"name/19\",[5,23.308]],[\"comment/19\",[]],[\"name/20\",[16,31.781]],[\"comment/20\",[]],[\"name/21\",[15,26.672]],[\"comment/21\",[]],[\"name/22\",[3,18.788]],[\"comment/22\",[]],[\"name/23\",[17,31.781]],[\"comment/23\",[]],[\"name/24\",[18,31.781]],[\"comment/24\",[]],[\"name/25\",[19,31.781]],[\"comment/25\",[]],[\"name/26\",[20,31.781]],[\"comment/26\",[]],[\"name/27\",[21,31.781]],[\"comment/27\",[]],[\"name/28\",[22,31.781]],[\"comment/28\",[]],[\"name/29\",[23,31.781]],[\"comment/29\",[]],[\"name/30\",[24,31.781]],[\"comment/30\",[]],[\"name/31\",[25,31.781]],[\"comment/31\",[]],[\"name/32\",[26,31.781]],[\"comment/32\",[]],[\"name/33\",[27,31.781]],[\"comment/33\",[]],[\"name/34\",[3,18.788]],[\"comment/34\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":3,\"name\":{\"3\":{},\"6\":{},\"14\":{},\"22\":{},\"34\":{}},\"comment\":{}}],[\"comparisonstrategyresult\",{\"_index\":24,\"name\":{\"30\":{}},\"comment\":{}}],[\"cosinestrategy\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"cosinestrategyaggressive\",{\"_index\":9,\"name\":{\"10\":{}},\"comment\":{}}],[\"createstringsameness\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"defaultstrategies\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"defaultstrcomparetransformfuncs\",{\"_index\":10,\"name\":{\"11\":{}},\"comment\":{}}],[\"dicestrategy\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"highscore\",{\"_index\":12,\"name\":{\"15\":{}},\"comment\":{}}],[\"highscoreweighted\",{\"_index\":13,\"name\":{\"16\":{}},\"comment\":{}}],[\"levenstrategy\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"lowercase\",{\"_index\":17,\"name\":{\"23\":{}},\"comment\":{}}],[\"rawscore\",{\"_index\":26,\"name\":{\"32\":{}},\"comment\":{}}],[\"removepunctuation\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"removewhitespace\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"reorder\",{\"_index\":16,\"name\":{\"20\":{}},\"comment\":{}}],[\"reorderstr\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"replacemultiwhitespace\",{\"_index\":19,\"name\":{\"25\":{}},\"comment\":{}}],[\"replaceunicode\",{\"_index\":20,\"name\":{\"26\":{}},\"comment\":{}}],[\"score\",{\"_index\":25,\"name\":{\"31\":{}},\"comment\":{}}],[\"strategies\",{\"_index\":5,\"name\":{\"5\":{},\"13\":{},\"19\":{}},\"comment\":{}}],[\"strdefaulttransforms\",{\"_index\":23,\"name\":{\"29\":{}},\"comment\":{}}],[\"stringcomparisonoptions\",{\"_index\":14,\"name\":{\"17\":{}},\"comment\":{}}],[\"stringsameness\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"stringsamenessresult\",{\"_index\":11,\"name\":{\"12\":{}},\"comment\":{}}],[\"stringtransformfunc\",{\"_index\":27,\"name\":{\"33\":{}},\"comment\":{}}],[\"transforms\",{\"_index\":15,\"name\":{\"18\":{},\"21\":{}},\"comment\":{}}],[\"trim\",{\"_index\":18,\"name\":{\"24\":{}},\"comment\":{}}]],\"pipeline\":[]}}");

+10 -4

functions/createStringSameness.html

··· 41 41 <h5>options: <a href="../interfaces/StringComparisonOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StringComparisonOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div> 42 42 <h4 class="tsd-returns-title">Returns <a href="../interfaces/StringSamenessResult.html" class="tsd-signature-type" data-tsd-kind="Interface">StringSamenessResult</a></h4></li></ul></li></ul><aside class="tsd-sources"> 43 43 <ul> 44 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/215caef/src/index.ts#L80">index.ts:80</a></li></ul></aside></li></ul></section></div> 44 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/index.ts#L109">index.ts:109</a></li></ul></aside></li></ul></section></div> 45 45 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 46 46 <div class="tsd-navigation settings"> 47 47 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> ··· 67 67 <ul> 68 68 <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> 69 69 <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> 70 - <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> 71 - <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> 70 + <li class="tsd-kind-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 71 + <li class="tsd-kind-type-alias"><a href="../types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</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"><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/>Strategies</a></li> 72 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> 73 - <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> 74 + <li class="tsd-kind-function"><a href="reorderStr.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>reorder<wbr/>Str</a></li> 75 + <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> 76 + <li class="tsd-kind-variable"><a href="../variables/strategies.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>strategies</a></li> 77 + <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> 78 + <li class="tsd-kind-variable"><a href="../variables/transforms.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>transforms</a></li> 79 + <li class="tsd-kind-variable"><a href="../variables/strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 74 80 <div class="container tsd-generator"> 75 81 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 76 82 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+71

functions/reorderStr.html

··· 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>reorderStr | string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><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="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">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">string-sameness Docs</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">string-sameness Docs</a></li> 16 + <li><a href="reorderStr.html">reorderStr</a></li></ul> 17 + <h1>Function reorderStr</h1></div> 18 + <section class="tsd-panel"> 19 + <ul class="tsd-signatures tsd-kind-function"> 20 + <li class="tsd-signature tsd-anchor-link" id="reorderStr">reorder<wbr/>Str<span class="tsd-signature-symbol">(</span>cleanA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cleanB<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><span class="tsd-signature-type">string</span><a href="#reorderStr" 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>cleanA: <span class="tsd-signature-type">string</span></h5></li> 27 + <li> 28 + <h5>cleanB: <span class="tsd-signature-type">string</span></h5></li> 29 + <li> 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 + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"> 32 + <ul> 33 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/index.ts#L79">index.ts:79</a></li></ul></aside></li></ul></section></div> 34 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 35 + <div class="tsd-navigation settings"> 36 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 37 + <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> 38 + <div class="tsd-accordion-details"> 39 + <div class="tsd-filter-visibility"> 40 + <h4 class="uppercase">Member Visibility</h4><form> 41 + <ul id="tsd-filter-options"> 42 + <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> 43 + <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> 44 + <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> 45 + <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> 46 + <div class="tsd-theme-toggle"> 47 + <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> 48 + <nav class="tsd-navigation primary"> 49 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 50 + <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> 51 + <div class="tsd-accordion-details"> 52 + <ul> 53 + <li><a href="../modules.html">string-<wbr/>sameness <wbr/>Docs</a> 54 + <ul></ul></li></ul></div></details></nav> 55 + <nav class="tsd-navigation secondary menu-sticky"> 56 + <ul> 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"><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> 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-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 60 + <li class="tsd-kind-type-alias"><a href="../types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</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"><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/>Strategies</a></li> 62 + <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> 63 + <li class="current tsd-kind-function"><a href="reorderStr.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>reorder<wbr/>Str</a></li> 64 + <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> 65 + <li class="tsd-kind-variable"><a href="../variables/strategies.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>strategies</a></li> 66 + <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> 67 + <li class="tsd-kind-variable"><a href="../variables/transforms.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>transforms</a></li> 68 + <li class="tsd-kind-variable"><a href="../variables/strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 69 + <div class="container tsd-generator"> 70 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 71 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+10 -4

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/215caef/src/index.ts#L32">index.ts:32</a></li></ul></aside></li></ul></section></div> 33 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/index.ts#L23">index.ts:23</a></li></ul></aside></li></ul></section></div> 34 34 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 35 35 <div class="tsd-navigation settings"> 36 36 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> ··· 56 56 <ul> 57 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"><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> 58 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"><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> 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> 59 + <li class="tsd-kind-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 60 + <li class="tsd-kind-type-alias"><a href="../types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</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"><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/>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-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 + <li class="tsd-kind-function"><a href="reorderStr.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>reorder<wbr/>Str</a></li> 64 + <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> 65 + <li class="tsd-kind-variable"><a href="../variables/strategies.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>strategies</a></li> 66 + <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> 67 + <li class="tsd-kind-variable"><a href="../variables/transforms.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>transforms</a></li> 68 + <li class="tsd-kind-variable"><a href="../variables/strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 63 69 <div class="container tsd-generator"> 64 70 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 65 71 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+45 -10

index.html

··· 42 42 </a> 43 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 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> 45 + <p>When no strategies are explicitly passed a default set of strategies is used, found in <code>import {defaultStrategies} from @foxxmd/string-sameness;</code>:</p> 46 46 <ul> 47 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 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 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 50 </ul> 51 + <p>Strategies can be accessed individually using <code>import {strategies} from @foxxmd/string-sameness</code></p> 51 52 52 53 <a href="#bring-your-own-strategy" id="bring-your-own-strategy" style="color: inherit; text-decoration: none;"> 53 54 <h3>Bring Your Own Strategy</h3> ··· 64 65 </a> 65 66 <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> 66 67 <ul> 67 - <li>convert to lowercase</li> 68 - <li>trim (remove whitespace at beginning/end)</li> 69 - <li>remove non-alphanumeric characters (punctuation and newlines)</li> 70 - <li>replace any instances of 2 or more consecutive whitespace with 1 whitespace</li> 68 + <li><p>normalize unicode EX convert Ö => O</p> 69 + </li> 70 + <li><p>convert to lowercase</p> 71 + </li> 72 + <li><p>trim (remove whitespace at beginning/end)</p> 73 + </li> 74 + <li><p>remove non-alphanumeric characters (punctuation and newlines)</p> 75 + </li> 76 + <li><p>replace any instances of 2 or more consecutive whitespace with 1 whitespace</p> 77 + </li> 78 + <li><p>The default set of transformer functions is exported as <code>import {strDefaultTransforms} from @foxxmd/string-sameness;</code></p> 79 + </li> 80 + <li><p>All built-in transformers can be found at <code>import {transforms} from @foxxmd/string-sameness;</code></p> 81 + </li> 71 82 </ul> 72 - <p>This default set of functions is exported as <code>defaultStrCompareTransformFuncs</code>.</p> 73 83 <p>Example of supplying your own transform functions:</p> 74 84 <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 85 </code></pre> 76 86 87 + <a href="#token-re-ordering" id="token-re-ordering" style="color: inherit; text-decoration: none;"> 88 + <h2>Token Re-ordering</h2> 89 + </a> 90 + <p>If tokens (word) ordering in the strings is not important you can choose to have string-sameness attempt to re-order all words before comparing sameness. This makes comparison scores much closer to "absolute sameness in all characters within string". EX:</p> 91 + <ul> 92 + <li><code>this is correct order</code></li> 93 + <li><code>order correct this is</code></li> 94 + </ul> 95 + <p>Scores 60 <strong>without</strong> reordering </p> 96 + <p>Scores 100 <strong>with</strong> reordering</p> 97 + <p>Behavior caveats:</p> 98 + <ul> 99 + <li>The <strong>second</strong> string argument is reordered to match the <strong>first</strong> string argument</li> 100 + <li>If the second string is longer than the first than any non-matched words are concatenated to the end of the re-ordered string in the same order they were found</li> 101 + </ul> 102 + <p>To use:</p> 103 + <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">res</span><span class="hl-1"> = </span><span class="hl-6">stringSameness</span><span class="hl-1">(</span><span class="hl-0">strA</span><span class="hl-1">, </span><span class="hl-0">strB</span><span class="hl-1">, {</span><span class="hl-0">reorder:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">});</span> 104 + </code></pre> 105 + 77 106 <a href="#factory" id="factory" style="color: inherit; text-decoration: none;"> 78 107 <h2>Factory</h2> 79 108 </a> 80 109 <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> 110 + <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-0">strategies</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">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-4">const</span><span class="hl-1"> {</span><span class="hl-5">levenStrategy</span><span class="hl-1">} = </span><span class="hl-0">strategies</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">levenStrategy</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> 82 111 </code></pre> 83 112 </div></div> 84 113 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> ··· 106 135 <ul> 107 136 <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> 108 137 <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> 109 - <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> 110 - <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> 138 + <li class="tsd-kind-interface"><a href="interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 139 + <li class="tsd-kind-type-alias"><a href="types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</a></li> 140 + <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"><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/>Strategies</a></li> 111 141 <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> 112 - <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> 142 + <li class="tsd-kind-function"><a href="functions/reorderStr.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>reorder<wbr/>Str</a></li> 143 + <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> 144 + <li class="tsd-kind-variable"><a href="variables/strategies.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>strategies</a></li> 145 + <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> 146 + <li class="tsd-kind-variable"><a href="variables/transforms.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>transforms</a></li> 147 + <li class="tsd-kind-variable"><a href="variables/strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 113 148 <div class="container tsd-generator"> 114 149 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 115 150 <div class="overlay"></div><script src="assets/main.js"></script></body></html>

+83

interfaces/ComparisonStrategyResult.html

··· 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ComparisonStrategyResult | string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><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="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">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">string-sameness Docs</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">string-sameness Docs</a></li> 16 + <li><a href="ComparisonStrategyResult.html">ComparisonStrategyResult</a></li></ul> 17 + <h1>Interface ComparisonStrategyResult</h1></div> 18 + <section class="tsd-panel tsd-hierarchy"> 19 + <h4>Hierarchy</h4> 20 + <ul class="tsd-hierarchy"> 21 + <li><span class="tsd-signature-type">ComparisonStrategyResultObject</span> 22 + <ul class="tsd-hierarchy"> 23 + <li><span class="target">ComparisonStrategyResult</span></li></ul></li></ul></section><aside class="tsd-sources"> 24 + <ul> 25 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L39">atomic.ts:39</a></li></ul></aside> 26 + <section class="tsd-panel-group tsd-index-group"> 27 + <section class="tsd-panel tsd-index-panel"> 28 + <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> 29 + <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> 30 + <div class="tsd-accordion-details"> 31 + <section class="tsd-index-section"> 32 + <h3 class="tsd-index-heading">Properties</h3> 33 + <div class="tsd-index-list"><a href="ComparisonStrategyResult.html#score" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><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>score</span></a> 34 + <a href="ComparisonStrategyResult.html#rawScore" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><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>raw<wbr/>Score?</span></a> 35 + </div></section></div></details></section></section> 36 + <section class="tsd-panel-group tsd-member-group"> 37 + <h2>Properties</h2> 38 + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="score" class="tsd-anchor"></a> 39 + <h3 class="tsd-anchor-link"><span>score</span><a href="#score" 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> 40 + <div class="tsd-signature">score<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> 41 + <div class="tsd-comment tsd-typography"><p>The normalized (0 to 100) score of this comparison</p> 42 + </div><aside class="tsd-sources"> 43 + <p>Inherited from ComparisonStrategyResultObject.score</p> 44 + <ul> 45 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L30">atomic.ts:30</a></li></ul></aside></section> 46 + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="rawScore" class="tsd-anchor"></a> 47 + <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>raw<wbr/>Score</span><a href="#rawScore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> 48 + <div class="tsd-signature">raw<wbr/>Score<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div> 49 + <div class="tsd-comment tsd-typography"><p>The raw value returned by the comparison (not normalized)</p> 50 + </div><aside class="tsd-sources"> 51 + <p>Inherited from ComparisonStrategyResultObject.rawScore</p> 52 + <ul> 53 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L34">atomic.ts:34</a></li></ul></aside></section></section></div> 54 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 55 + <div class="tsd-navigation settings"> 56 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 57 + <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> 58 + <div class="tsd-accordion-details"> 59 + <div class="tsd-filter-visibility"> 60 + <h4 class="uppercase">Member Visibility</h4><form> 61 + <ul id="tsd-filter-options"> 62 + <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> 63 + <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> 64 + <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> 65 + <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> 66 + <div class="tsd-theme-toggle"> 67 + <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> 68 + <nav class="tsd-navigation primary"> 69 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 70 + <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> 71 + <div class="tsd-accordion-details"> 72 + <ul> 73 + <li><a href="../modules.html">string-<wbr/>sameness <wbr/>Docs</a> 74 + <ul></ul></li></ul></div></details></nav> 75 + <nav class="tsd-navigation secondary menu-sticky"> 76 + <ul> 77 + <li class="current tsd-kind-interface"><a href="ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</span></a> 78 + <ul> 79 + <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ComparisonStrategyResult.html#score" 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>score</a></li> 80 + <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ComparisonStrategyResult.html#rawScore" 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>raw<wbr/>Score?</a></li></ul></li></ul></nav></div></div> 81 + <div class="container tsd-generator"> 82 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 83 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+20 -6

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/215caef/src/atomic.ts#L1">atomic.ts:1</a></li></ul></aside> 23 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/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"> ··· 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 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> 33 + <a href="StringComparisonOptions.html#reorder" 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>reorder?</span></a> 33 34 </div></section></div></details></section></section> 34 35 <section class="tsd-panel-group tsd-member-group"> 35 36 <h2>Properties</h2> 36 37 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="transforms" class="tsd-anchor"></a> 37 38 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transforms</span><a href="#transforms" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3> 38 - <div class="tsd-signature">transforms<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"> 39 + <div class="tsd-signature">transforms<span class="tsd-signature-symbol">?:</span> <a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><span class="tsd-signature-symbol">[]</span></div> 40 + <div class="tsd-comment tsd-typography"><p>An array of transformations to apply to each string before comparing similarity</p> 41 + </div><aside class="tsd-sources"> 39 42 <ul> 40 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/215caef/src/atomic.ts#L2">atomic.ts:2</a></li></ul></aside></section> 43 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L5">atomic.ts:5</a></li></ul></aside></section> 41 44 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strategies" class="tsd-anchor"></a> 42 45 <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"> 46 + <div class="tsd-signature">strategies<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultValue</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div> 47 + <div class="tsd-comment tsd-typography"><p>An array of strategies used to score similarity. All strategies scores are combined for an average high score.</p> 48 + </div><aside class="tsd-sources"> 44 49 <ul> 45 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/215caef/src/atomic.ts#L3">atomic.ts:3</a></li></ul></aside></section></section></div> 50 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L9">atomic.ts:9</a></li></ul></aside></section> 51 + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reorder" class="tsd-anchor"></a> 52 + <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>reorder</span><a href="#reorder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> 53 + <div class="tsd-signature">reorder<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div> 54 + <div class="tsd-comment tsd-typography"><p>Reorder second string so its token match order of first string as closely as possible</p> 55 + <p>Useful when only the differences in content are important, but not the order of the content</p> 56 + </div><aside class="tsd-sources"> 57 + <ul> 58 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L15">atomic.ts:15</a></li></ul></aside></section></section></div> 46 59 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 47 60 <div class="tsd-navigation settings"> 48 61 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> ··· 69 82 <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> 70 83 <ul> 71 84 <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> 72 - <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> 85 + <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> 86 + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringComparisonOptions.html#reorder" 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>reorder?</a></li></ul></li></ul></nav></div></div> 73 87 <div class="container tsd-generator"> 74 88 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 75 89 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+6 -6

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/215caef/src/atomic.ts#L6">atomic.ts:6</a></li></ul></aside> 23 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L18">atomic.ts:18</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"> ··· 36 36 <h2>Properties</h2> 37 37 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="strategies" class="tsd-anchor"></a> 38 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> 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><a href="ComparisonStrategyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ComparisonStrategyResult</a><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 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"> 44 + <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="ComparisonStrategyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ComparisonStrategyResult</a></h5></li></ul></div><aside class="tsd-sources"> 45 45 <ul> 46 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/215caef/src/atomic.ts#L7">atomic.ts:7</a></li></ul></aside></section> 46 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L19">atomic.ts:19</a></li></ul></aside></section> 47 47 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="highScore" class="tsd-anchor"></a> 48 48 <h3 class="tsd-anchor-link"><span>high<wbr/>Score</span><a href="#highScore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> 49 49 <div class="tsd-signature">high<wbr/>Score<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"> 50 50 <ul> 51 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/215caef/src/atomic.ts#L10">atomic.ts:10</a></li></ul></aside></section> 51 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L22">atomic.ts:22</a></li></ul></aside></section> 52 52 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="highScoreWeighted" class="tsd-anchor"></a> 53 53 <h3 class="tsd-anchor-link"><span>high<wbr/>Score<wbr/>Weighted</span><a href="#highScoreWeighted" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> 54 54 <div class="tsd-signature">high<wbr/>Score<wbr/>Weighted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"> 55 55 <ul> 56 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/215caef/src/atomic.ts#L11">atomic.ts:11</a></li></ul></aside></section></section></div> 56 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L23">atomic.ts:23</a></li></ul></aside></section></section></div> 57 57 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 58 58 <div class="tsd-navigation settings"> 59 59 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

+19 -4

modules.html

··· 19 19 <h3 class="tsd-index-heading">Interfaces</h3> 20 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> 21 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> 22 + <a href="interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</span></a> 23 + </div></section> 24 + <section class="tsd-index-section"> 25 + <h3 class="tsd-index-heading">Type Aliases</h3> 26 + <div class="tsd-index-list"><a href="types/StringTransformFunc.html" class="tsd-index-link tsd-kind-type-alias"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg><span>String<wbr/>Transform<wbr/>Func</span></a> 22 27 </div></section> 23 28 <section class="tsd-index-section"> 24 29 <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> 30 + <div class="tsd-index-list"><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"><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/>Strategies</span></a> 31 + <a href="variables/strategies.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>strategies</span></a> 32 + <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"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</span></a> 33 + <a href="variables/transforms.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>transforms</span></a> 34 + <a href="variables/strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</span></a> 27 35 </div></section> 28 36 <section class="tsd-index-section"> 29 37 <h3 class="tsd-index-heading">Functions</h3> 30 38 <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> 39 + <a href="functions/reorderStr.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>reorder<wbr/>Str</span></a> 31 40 <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 41 </div></section></section></section></div> 33 42 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> ··· 55 64 <ul> 56 65 <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> 57 66 <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> 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"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 67 + <li class="tsd-kind-interface"><a href="interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 68 + <li class="tsd-kind-type-alias"><a href="types/StringTransformFunc.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>String<wbr/>Transform<wbr/>Func</a></li> 59 69 <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> 60 70 <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> 61 - <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> 71 + <li class="tsd-kind-function"><a href="functions/reorderStr.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>reorder<wbr/>Str</a></li> 72 + <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> 73 + <li class="tsd-kind-variable"><a href="variables/strategies.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>strategies</a></li> 74 + <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> 75 + <li class="tsd-kind-variable"><a href="variables/transforms.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>transforms</a></li> 76 + <li class="tsd-kind-variable"><a href="variables/strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 62 77 <div class="container tsd-generator"> 63 78 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 64 79 <div class="overlay"></div><script src="assets/main.js"></script></body></html>

+71

types/StringTransformFunc.html

··· 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StringTransformFunc | string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><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="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">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">string-sameness Docs</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">string-sameness Docs</a></li> 16 + <li><a href="StringTransformFunc.html">StringTransformFunc</a></li></ul> 17 + <h1>Type alias StringTransformFunc</h1></div> 18 + <div class="tsd-signature">String<wbr/>Transform<wbr/>Func<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></div> 19 + <div class="tsd-type-declaration"> 20 + <h4>Type declaration</h4> 21 + <ul class="tsd-parameters"> 22 + <li class="tsd-parameter-signature"> 23 + <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> 24 + <li class="tsd-signature" id="__type.__type-1"><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></li> 25 + <li class="tsd-description"> 26 + <div class="tsd-parameters"> 27 + <h4 class="tsd-parameters-title">Parameters</h4> 28 + <ul class="tsd-parameter-list"> 29 + <li> 30 + <h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div> 31 + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><aside class="tsd-sources"> 32 + <ul> 33 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/atomic.ts#L68">atomic.ts:68</a></li></ul></aside></div> 34 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 35 + <div class="tsd-navigation settings"> 36 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 37 + <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> 38 + <div class="tsd-accordion-details"> 39 + <div class="tsd-filter-visibility"> 40 + <h4 class="uppercase">Member Visibility</h4><form> 41 + <ul id="tsd-filter-options"> 42 + <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> 43 + <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> 44 + <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> 45 + <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> 46 + <div class="tsd-theme-toggle"> 47 + <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> 48 + <nav class="tsd-navigation primary"> 49 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 50 + <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> 51 + <div class="tsd-accordion-details"> 52 + <ul> 53 + <li><a href="../modules.html">string-<wbr/>sameness <wbr/>Docs</a> 54 + <ul></ul></li></ul></div></details></nav> 55 + <nav class="tsd-navigation secondary menu-sticky"> 56 + <ul> 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"><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> 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-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 60 + <li class="current tsd-kind-type-alias"><a href="StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</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"><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/>Strategies</a></li> 62 + <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> 63 + <li class="tsd-kind-function"><a href="../functions/reorderStr.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>reorder<wbr/>Str</a></li> 64 + <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> 65 + <li class="tsd-kind-variable"><a href="../variables/strategies.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>strategies</a></li> 66 + <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> 67 + <li class="tsd-kind-variable"><a href="../variables/transforms.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>transforms</a></li> 68 + <li class="tsd-kind-variable"><a href="../variables/strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 69 + <div class="container tsd-generator"> 70 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 71 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+11 -5

variables/defaultStrCompareTransformFuncs.html

··· 15 15 <li><a href="../modules.html">string-sameness Docs</a></li> 16 16 <li><a href="defaultStrCompareTransformFuncs.html">defaultStrCompareTransformFuncs</a></li></ul> 17 17 <h1>Variable defaultStrCompareTransformFuncs<code class="tsd-tag ts-flagConst">Const</code> </h1></div> 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"> 18 + <div class="tsd-signature">default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs<span class="tsd-signature-symbol">:</span> <a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = strDefaultTransforms</span></div><aside class="tsd-sources"> 19 19 <ul> 20 - <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/215caef/src/index.ts#L15">index.ts:15</a></li></ul></aside></div> 20 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/index.ts#L121">index.ts:121</a></li></ul></aside></div> 21 21 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 22 22 <div class="tsd-navigation settings"> 23 23 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> ··· 43 43 <ul> 44 44 <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> 45 45 <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> 46 - <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> 47 - <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> 46 + <li class="tsd-kind-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 47 + <li class="tsd-kind-type-alias"><a href="../types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</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"><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/>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-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 + <li class="tsd-kind-function"><a href="../functions/reorderStr.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>reorder<wbr/>Str</a></li> 51 + <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> 52 + <li class="tsd-kind-variable"><a href="strategies.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>strategies</a></li> 53 + <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"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 54 + <li class="tsd-kind-variable"><a href="transforms.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>transforms</a></li> 55 + <li class="tsd-kind-variable"><a href="strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 50 56 <div class="container tsd-generator"> 51 57 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 52 58 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+11 -5

variables/defaultStrategies.html

··· 15 15 <li><a href="../modules.html">string-sameness Docs</a></li> 16 16 <li><a href="defaultStrategies.html">defaultStrategies</a></li></ul> 17 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"> 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-type">ComparisonStrategyResultObject</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/215caef/src/index.ts#L26">index.ts:26</a></li></ul></aside></div> 20 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/index.ts#L17">index.ts:17</a></li></ul></aside></div> 21 21 <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 22 22 <div class="tsd-navigation settings"> 23 23 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> ··· 43 43 <ul> 44 44 <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> 45 45 <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> 46 - <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> 47 - <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> 46 + <li class="tsd-kind-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 47 + <li class="tsd-kind-type-alias"><a href="../types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</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"><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/>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-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 + <li class="tsd-kind-function"><a href="../functions/reorderStr.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>reorder<wbr/>Str</a></li> 51 + <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> 52 + <li class="tsd-kind-variable"><a href="strategies.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>strategies</a></li> 53 + <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"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 54 + <li class="tsd-kind-variable"><a href="transforms.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>transforms</a></li> 55 + <li class="tsd-kind-variable"><a href="strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 50 56 <div class="container tsd-generator"> 51 57 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 52 58 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+58

variables/strDefaultTransforms.html

··· 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>strDefaultTransforms | string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><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="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">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">string-sameness Docs</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">string-sameness Docs</a></li> 16 + <li><a href="strDefaultTransforms.html">strDefaultTransforms</a></li></ul> 17 + <h1>Variable strDefaultTransforms<code class="tsd-tag ts-flagConst">Const</code> </h1></div> 18 + <div class="tsd-signature">str<wbr/>Default<wbr/>Transforms<span class="tsd-signature-symbol">:</span> <a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><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/e078f29/src/normalization/index.ts#L23">normalization/index.ts:23</a></li></ul></aside></div> 21 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 22 + <div class="tsd-navigation settings"> 23 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 24 + <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> 25 + <div class="tsd-accordion-details"> 26 + <div class="tsd-filter-visibility"> 27 + <h4 class="uppercase">Member Visibility</h4><form> 28 + <ul id="tsd-filter-options"> 29 + <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> 30 + <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> 31 + <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> 32 + <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> 33 + <div class="tsd-theme-toggle"> 34 + <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> 35 + <nav class="tsd-navigation primary"> 36 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 37 + <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> 38 + <div class="tsd-accordion-details"> 39 + <ul> 40 + <li><a href="../modules.html">string-<wbr/>sameness <wbr/>Docs</a> 41 + <ul></ul></li></ul></div></details></nav> 42 + <nav class="tsd-navigation secondary menu-sticky"> 43 + <ul> 44 + <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> 45 + <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> 46 + <li class="tsd-kind-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 47 + <li class="tsd-kind-type-alias"><a href="../types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</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"><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/>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/reorderStr.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>reorder<wbr/>Str</a></li> 51 + <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> 52 + <li class="tsd-kind-variable"><a href="strategies.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>strategies</a></li> 53 + <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"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 54 + <li class="tsd-kind-variable"><a href="transforms.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>transforms</a></li> 55 + <li class="current tsd-kind-variable"><a href="strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 56 + <div class="container tsd-generator"> 57 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 58 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+69

variables/strategies.html

··· 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>strategies | string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><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="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">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">string-sameness Docs</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">string-sameness Docs</a></li> 16 + <li><a href="strategies.html">strategies</a></li></ul> 17 + <h1>Variable strategies<code class="tsd-tag ts-flagConst">Const</code> </h1></div> 18 + <div class="tsd-signature">strategies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>diceStrategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span>levenStrategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span>cosineStrategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span>cosineStrategyAggressive<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultObject</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div> 19 + <div class="tsd-type-declaration"> 20 + <h4>Type declaration</h4> 21 + <ul class="tsd-parameters"> 22 + <li class="tsd-parameter"> 23 + <h5>dice<wbr/>Strategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultObject</span><span class="tsd-signature-symbol">></span></h5></li> 24 + <li class="tsd-parameter"> 25 + <h5>leven<wbr/>Strategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultObject</span><span class="tsd-signature-symbol">></span></h5></li> 26 + <li class="tsd-parameter"> 27 + <h5>cosine<wbr/>Strategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultObject</span><span class="tsd-signature-symbol">></span></h5></li> 28 + <li class="tsd-parameter"> 29 + <h5>cosine<wbr/>Strategy<wbr/>Aggressive<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComparisonStrategy</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ComparisonStrategyResultObject</span><span class="tsd-signature-symbol">></span></h5></li></ul></div><aside class="tsd-sources"> 30 + <ul> 31 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/index.ts#L113">index.ts:113</a></li></ul></aside></div> 32 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 33 + <div class="tsd-navigation settings"> 34 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 35 + <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> 36 + <div class="tsd-accordion-details"> 37 + <div class="tsd-filter-visibility"> 38 + <h4 class="uppercase">Member Visibility</h4><form> 39 + <ul id="tsd-filter-options"> 40 + <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> 41 + <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> 42 + <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> 43 + <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> 44 + <div class="tsd-theme-toggle"> 45 + <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> 46 + <nav class="tsd-navigation primary"> 47 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 48 + <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> 49 + <div class="tsd-accordion-details"> 50 + <ul> 51 + <li><a href="../modules.html">string-<wbr/>sameness <wbr/>Docs</a> 52 + <ul></ul></li></ul></div></details></nav> 53 + <nav class="tsd-navigation secondary menu-sticky"> 54 + <ul> 55 + <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> 56 + <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> 57 + <li class="tsd-kind-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 58 + <li class="tsd-kind-type-alias"><a href="../types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</a></li> 59 + <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"><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/>Strategies</a></li> 60 + <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> 61 + <li class="tsd-kind-function"><a href="../functions/reorderStr.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>reorder<wbr/>Str</a></li> 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> 63 + <li class="current tsd-kind-variable"><a href="strategies.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>strategies</a></li> 64 + <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"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 65 + <li class="tsd-kind-variable"><a href="transforms.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>transforms</a></li> 66 + <li class="tsd-kind-variable"><a href="strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 67 + <div class="container tsd-generator"> 68 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 69 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+73

variables/transforms.html

··· 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>transforms | string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><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="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">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">string-sameness Docs</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">string-sameness Docs</a></li> 16 + <li><a href="transforms.html">transforms</a></li></ul> 17 + <h1>Variable transforms<code class="tsd-tag ts-flagConst">Const</code> </h1></div> 18 + <div class="tsd-signature">transforms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>lowercase<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><span class="tsd-signature-symbol">; </span><br/><span> </span>trim<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><span class="tsd-signature-symbol">; </span><br/><span> </span>replaceMultiWhitespace<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><span class="tsd-signature-symbol">; </span><br/><span> </span>replaceUnicode<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><span class="tsd-signature-symbol">; </span><br/><span> </span>removeWhitespace<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><span class="tsd-signature-symbol">; </span><br/><span> </span>removePunctuation<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div> 19 + <div class="tsd-type-declaration"> 20 + <h4>Type declaration</h4> 21 + <ul class="tsd-parameters"> 22 + <li class="tsd-parameter"> 23 + <h5>lowercase<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a></h5></li> 24 + <li class="tsd-parameter"> 25 + <h5>trim<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a></h5></li> 26 + <li class="tsd-parameter"> 27 + <h5>replace<wbr/>Multi<wbr/>Whitespace<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a></h5></li> 28 + <li class="tsd-parameter"> 29 + <h5>replace<wbr/>Unicode<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a></h5></li> 30 + <li class="tsd-parameter"> 31 + <h5>remove<wbr/>Whitespace<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a></h5></li> 32 + <li class="tsd-parameter"> 33 + <h5>remove<wbr/>Punctuation<span class="tsd-signature-symbol">: </span><a href="../types/StringTransformFunc.html" class="tsd-signature-type" data-tsd-kind="Type alias">StringTransformFunc</a></h5></li></ul></div><aside class="tsd-sources"> 34 + <ul> 35 + <li>Defined in <a href="https://github.com/FoxxMD/string-sameness/blob/e078f29/src/normalization/index.ts#L14">normalization/index.ts:14</a></li></ul></aside></div> 36 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 37 + <div class="tsd-navigation settings"> 38 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 39 + <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> 40 + <div class="tsd-accordion-details"> 41 + <div class="tsd-filter-visibility"> 42 + <h4 class="uppercase">Member Visibility</h4><form> 43 + <ul id="tsd-filter-options"> 44 + <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> 45 + <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> 46 + <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> 47 + <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> 48 + <div class="tsd-theme-toggle"> 49 + <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> 50 + <nav class="tsd-navigation primary"> 51 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 52 + <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> 53 + <div class="tsd-accordion-details"> 54 + <ul> 55 + <li><a href="../modules.html">string-<wbr/>sameness <wbr/>Docs</a> 56 + <ul></ul></li></ul></div></details></nav> 57 + <nav class="tsd-navigation secondary menu-sticky"> 58 + <ul> 59 + <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 + <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> 61 + <li class="tsd-kind-interface"><a href="../interfaces/ComparisonStrategyResult.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>Comparison<wbr/>Strategy<wbr/>Result</a></li> 62 + <li class="tsd-kind-type-alias"><a href="../types/StringTransformFunc.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)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>String<wbr/>Transform<wbr/>Func</a></li> 63 + <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"><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/>Strategies</a></li> 64 + <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> 65 + <li class="tsd-kind-function"><a href="../functions/reorderStr.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>reorder<wbr/>Str</a></li> 66 + <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> 67 + <li class="tsd-kind-variable"><a href="strategies.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>strategies</a></li> 68 + <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"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>default<wbr/>Str<wbr/>Compare<wbr/>Transform<wbr/>Funcs</a></li> 69 + <li class="current tsd-kind-variable"><a href="transforms.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>transforms</a></li> 70 + <li class="tsd-kind-variable"><a href="strDefaultTransforms.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>str<wbr/>Default<wbr/>Transforms</a></li></ul></nav></div></div> 71 + <div class="container tsd-generator"> 72 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 73 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

Configure Feed

Configure Feed