diff --git a/assets/search.js b/assets/search.js index 4f4d813..ffbcf8e 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +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\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\",\"8388608\":\"Reference\"},\"rows\":[{\"kind\":2,\"name\":\"index\",\"url\":\"modules/index.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"reorderStr\",\"url\":\"functions/index.reorderStr.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":64,\"name\":\"stringSameness\",\"url\":\"functions/index.stringSameness.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":64,\"name\":\"createStringSameness\",\"url\":\"functions/index.createStringSameness.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/index.createStringSameness.html#createStringSameness.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"index.createStringSameness.createStringSameness\"},{\"kind\":32,\"name\":\"defaultStrategies\",\"url\":\"variables/index.defaultStrategies.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":32,\"name\":\"strategies\",\"url\":\"variables/index.strategies.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/index.strategies.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"index.strategies\"},{\"kind\":1024,\"name\":\"diceStrategy\",\"url\":\"variables/index.strategies.html#__type.diceStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"index.strategies.__type\"},{\"kind\":1024,\"name\":\"levenStrategy\",\"url\":\"variables/index.strategies.html#__type.levenStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"index.strategies.__type\"},{\"kind\":1024,\"name\":\"cosineStrategy\",\"url\":\"variables/index.strategies.html#__type.cosineStrategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"index.strategies.__type\"},{\"kind\":1024,\"name\":\"cosineStrategyAggressive\",\"url\":\"variables/index.strategies.html#__type.cosineStrategyAggressive\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"index.strategies.__type\"},{\"kind\":32,\"name\":\"defaultStrCompareTransformFuncs\",\"url\":\"variables/index.defaultStrCompareTransformFuncs.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":2,\"name\":\"matchingStrategies\",\"url\":\"modules/matchingStrategies.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":2,\"name\":\"normalization\",\"url\":\"modules/normalization.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"lowercase\",\"url\":\"functions/normalization.lowercase.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"normalization\"},{\"kind\":64,\"name\":\"trim\",\"url\":\"functions/normalization.trim.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"normalization\"},{\"kind\":64,\"name\":\"replaceUnicode\",\"url\":\"functions/normalization.replaceUnicode.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"normalization\"},{\"kind\":64,\"name\":\"removePunctuation\",\"url\":\"functions/normalization.removePunctuation.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"normalization\"},{\"kind\":64,\"name\":\"removeWhitespace\",\"url\":\"functions/normalization.removeWhitespace.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"normalization\"},{\"kind\":64,\"name\":\"replaceMultiWhitespace\",\"url\":\"functions/normalization.replaceMultiWhitespace.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"normalization\"},{\"kind\":32,\"name\":\"transforms\",\"url\":\"variables/normalization.transforms.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"normalization\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/normalization.transforms.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"normalization.transforms\"},{\"kind\":1024,\"name\":\"lowercase\",\"url\":\"variables/normalization.transforms.html#__type.lowercase\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"normalization.transforms.__type\"},{\"kind\":1024,\"name\":\"trim\",\"url\":\"variables/normalization.transforms.html#__type.trim\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"normalization.transforms.__type\"},{\"kind\":1024,\"name\":\"replaceMultiWhitespace\",\"url\":\"variables/normalization.transforms.html#__type.replaceMultiWhitespace\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"normalization.transforms.__type\"},{\"kind\":1024,\"name\":\"replaceUnicode\",\"url\":\"variables/normalization.transforms.html#__type.replaceUnicode\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"normalization.transforms.__type\"},{\"kind\":1024,\"name\":\"removeWhitespace\",\"url\":\"variables/normalization.transforms.html#__type.removeWhitespace\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"normalization.transforms.__type\"},{\"kind\":1024,\"name\":\"removePunctuation\",\"url\":\"variables/normalization.transforms.html#__type.removePunctuation\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"normalization.transforms.__type\"},{\"kind\":32,\"name\":\"strDefaultTransforms\",\"url\":\"variables/normalization.strDefaultTransforms.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"normalization\"},{\"kind\":256,\"name\":\"StringSamenessResult\",\"url\":\"interfaces/index.StringSamenessResult.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":1024,\"name\":\"strategies\",\"url\":\"interfaces/index.StringSamenessResult.html#strategies\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"index.StringSamenessResult\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/index.StringSamenessResult.html#strategies.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"index.StringSamenessResult.strategies\"},{\"kind\":1024,\"name\":\"highScore\",\"url\":\"interfaces/index.StringSamenessResult.html#highScore\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"index.StringSamenessResult\"},{\"kind\":1024,\"name\":\"highScoreWeighted\",\"url\":\"interfaces/index.StringSamenessResult.html#highScoreWeighted\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"index.StringSamenessResult\"},{\"kind\":256,\"name\":\"StringComparisonOptions\",\"url\":\"interfaces/index.StringComparisonOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":1024,\"name\":\"transforms\",\"url\":\"interfaces/index.StringComparisonOptions.html#transforms\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"index.StringComparisonOptions\"},{\"kind\":1024,\"name\":\"strategies\",\"url\":\"interfaces/index.StringComparisonOptions.html#strategies\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"index.StringComparisonOptions\"},{\"kind\":1024,\"name\":\"reorder\",\"url\":\"interfaces/index.StringComparisonOptions.html#reorder\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"index.StringComparisonOptions\"},{\"kind\":8388608,\"name\":\"transforms\",\"url\":\"modules/index.html#transforms\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":8388608,\"name\":\"strDefaultTransforms\",\"url\":\"modules/index.html#strDefaultTransforms\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":256,\"name\":\"ComparisonStrategyResult\",\"url\":\"interfaces/index.ComparisonStrategyResult.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":1024,\"name\":\"score\",\"url\":\"interfaces/index.ComparisonStrategyResult.html#score\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"index.ComparisonStrategyResult\"},{\"kind\":1024,\"name\":\"rawScore\",\"url\":\"interfaces/index.ComparisonStrategyResult.html#rawScore\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"index.ComparisonStrategyResult\"},{\"kind\":4194304,\"name\":\"StringTransformFunc\",\"url\":\"types/index.StringTransformFunc.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"index\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/index.StringTransformFunc.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"index.StringTransformFunc\"},{\"kind\":32,\"name\":\"levenStrategy\",\"url\":\"variables/matchingStrategies.levenStrategy.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"matchingStrategies\"},{\"kind\":32,\"name\":\"cosineStrategy\",\"url\":\"variables/matchingStrategies.cosineStrategy.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"matchingStrategies\"},{\"kind\":32,\"name\":\"cosineStrategyAggressive\",\"url\":\"variables/matchingStrategies.cosineStrategyAggressive.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"matchingStrategies\"},{\"kind\":32,\"name\":\"diceStrategy\",\"url\":\"variables/matchingStrategies.diceStrategy.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"matchingStrategies\"},{\"kind\":256,\"name\":\"ComparisonStrategy\",\"url\":\"interfaces/matchingStrategies.ComparisonStrategy.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"matchingStrategies\"},{\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/matchingStrategies.ComparisonStrategy.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"matchingStrategies.ComparisonStrategy\"},{\"kind\":1024,\"name\":\"strategy\",\"url\":\"interfaces/matchingStrategies.ComparisonStrategy.html#strategy\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"matchingStrategies.ComparisonStrategy\"},{\"kind\":1024,\"name\":\"isValid\",\"url\":\"interfaces/matchingStrategies.ComparisonStrategy.html#isValid\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"matchingStrategies.ComparisonStrategy\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/matchingStrategies.ComparisonStrategy.html#isValid.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"matchingStrategies.ComparisonStrategy.isValid\"},{\"kind\":256,\"name\":\"ComparisonStrategyResultObject\",\"url\":\"interfaces/matchingStrategies.ComparisonStrategyResultObject.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"matchingStrategies\"},{\"kind\":1024,\"name\":\"score\",\"url\":\"interfaces/matchingStrategies.ComparisonStrategyResultObject.html#score\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"matchingStrategies.ComparisonStrategyResultObject\"},{\"kind\":1024,\"name\":\"rawScore\",\"url\":\"interfaces/matchingStrategies.ComparisonStrategyResultObject.html#rawScore\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"matchingStrategies.ComparisonStrategyResultObject\"},{\"kind\":4194304,\"name\":\"ComparisonStrategyResultValue\",\"url\":\"types/matchingStrategies.ComparisonStrategyResultValue.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"matchingStrategies\"},{\"kind\":4194304,\"name\":\"StrategyFunc\",\"url\":\"types/matchingStrategies.StrategyFunc.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"matchingStrategies\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/matchingStrategies.StrategyFunc.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"matchingStrategies.StrategyFunc\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,37.217]],[\"comment/0\",[]],[\"name/1\",[1,55.825]],[\"comment/1\",[]],[\"name/2\",[2,55.825]],[\"comment/2\",[]],[\"name/3\",[3,55.825]],[\"comment/3\",[]],[\"name/4\",[4,21.122]],[\"comment/4\",[]],[\"name/5\",[5,37.217]],[\"comment/5\",[]],[\"name/6\",[6,28.744]],[\"comment/6\",[]],[\"name/7\",[4,21.122]],[\"comment/7\",[]],[\"name/8\",[7,32.108]],[\"comment/8\",[]],[\"name/9\",[8,32.108]],[\"comment/9\",[]],[\"name/10\",[9,32.108]],[\"comment/10\",[]],[\"name/11\",[10,32.108]],[\"comment/11\",[]],[\"name/12\",[11,37.217]],[\"comment/12\",[]],[\"name/13\",[12,37.217]],[\"comment/13\",[]],[\"name/14\",[13,37.217]],[\"comment/14\",[]],[\"name/15\",[14,48.163]],[\"comment/15\",[]],[\"name/16\",[15,48.163]],[\"comment/16\",[]],[\"name/17\",[16,48.163]],[\"comment/17\",[]],[\"name/18\",[17,48.163]],[\"comment/18\",[]],[\"name/19\",[18,48.163]],[\"comment/19\",[]],[\"name/20\",[19,48.163]],[\"comment/20\",[]],[\"name/21\",[20,28.744]],[\"comment/21\",[]],[\"name/22\",[4,21.122]],[\"comment/22\",[]],[\"name/23\",[14,32.108]],[\"comment/23\",[]],[\"name/24\",[15,32.108]],[\"comment/24\",[]],[\"name/25\",[19,32.108]],[\"comment/25\",[]],[\"name/26\",[16,32.108]],[\"comment/26\",[]],[\"name/27\",[18,32.108]],[\"comment/27\",[]],[\"name/28\",[17,32.108]],[\"comment/28\",[]],[\"name/29\",[21,32.108]],[\"comment/29\",[]],[\"name/30\",[22,37.217]],[\"comment/30\",[]],[\"name/31\",[6,28.744]],[\"comment/31\",[]],[\"name/32\",[4,21.122]],[\"comment/32\",[]],[\"name/33\",[23,37.217]],[\"comment/33\",[]],[\"name/34\",[24,37.217]],[\"comment/34\",[]],[\"name/35\",[25,37.217]],[\"comment/35\",[]],[\"name/36\",[20,28.744]],[\"comment/36\",[]],[\"name/37\",[6,28.744]],[\"comment/37\",[]],[\"name/38\",[26,37.217]],[\"comment/38\",[]],[\"name/39\",[20,28.744]],[\"comment/39\",[]],[\"name/40\",[21,32.108]],[\"comment/40\",[]],[\"name/41\",[27,37.217]],[\"comment/41\",[]],[\"name/42\",[28,32.108]],[\"comment/42\",[]],[\"name/43\",[29,32.108]],[\"comment/43\",[]],[\"name/44\",[30,37.217]],[\"comment/44\",[]],[\"name/45\",[4,21.122]],[\"comment/45\",[]],[\"name/46\",[8,32.108]],[\"comment/46\",[]],[\"name/47\",[9,32.108]],[\"comment/47\",[]],[\"name/48\",[10,32.108]],[\"comment/48\",[]],[\"name/49\",[7,32.108]],[\"comment/49\",[]],[\"name/50\",[31,37.217]],[\"comment/50\",[]],[\"name/51\",[32,37.217]],[\"comment/51\",[]],[\"name/52\",[33,37.217]],[\"comment/52\",[]],[\"name/53\",[34,37.217]],[\"comment/53\",[]],[\"name/54\",[4,21.122]],[\"comment/54\",[]],[\"name/55\",[35,37.217]],[\"comment/55\",[]],[\"name/56\",[28,32.108]],[\"comment/56\",[]],[\"name/57\",[29,32.108]],[\"comment/57\",[]],[\"name/58\",[36,37.217]],[\"comment/58\",[]],[\"name/59\",[37,37.217]],[\"comment/59\",[]],[\"name/60\",[4,21.122]],[\"comment/60\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{},\"7\":{},\"22\":{},\"32\":{},\"45\":{},\"54\":{},\"60\":{}},\"comment\":{}}],[\"comparisonstrategy\",{\"_index\":31,\"name\":{\"50\":{}},\"comment\":{}}],[\"comparisonstrategyresult\",{\"_index\":27,\"name\":{\"41\":{}},\"comment\":{}}],[\"comparisonstrategyresultobject\",{\"_index\":35,\"name\":{\"55\":{}},\"comment\":{}}],[\"comparisonstrategyresultvalue\",{\"_index\":36,\"name\":{\"58\":{}},\"comment\":{}}],[\"cosinestrategy\",{\"_index\":9,\"name\":{\"10\":{},\"47\":{}},\"comment\":{}}],[\"cosinestrategyaggressive\",{\"_index\":10,\"name\":{\"11\":{},\"48\":{}},\"comment\":{}}],[\"createstringsameness\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"defaultstrategies\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"defaultstrcomparetransformfuncs\",{\"_index\":11,\"name\":{\"12\":{}},\"comment\":{}}],[\"dicestrategy\",{\"_index\":7,\"name\":{\"8\":{},\"49\":{}},\"comment\":{}}],[\"highscore\",{\"_index\":23,\"name\":{\"33\":{}},\"comment\":{}}],[\"highscoreweighted\",{\"_index\":24,\"name\":{\"34\":{}},\"comment\":{}}],[\"index\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"isvalid\",{\"_index\":34,\"name\":{\"53\":{}},\"comment\":{}}],[\"levenstrategy\",{\"_index\":8,\"name\":{\"9\":{},\"46\":{}},\"comment\":{}}],[\"lowercase\",{\"_index\":14,\"name\":{\"15\":{},\"23\":{}},\"comment\":{}}],[\"matchingstrategies\",{\"_index\":12,\"name\":{\"13\":{}},\"comment\":{}}],[\"name\",{\"_index\":32,\"name\":{\"51\":{}},\"comment\":{}}],[\"normalization\",{\"_index\":13,\"name\":{\"14\":{}},\"comment\":{}}],[\"rawscore\",{\"_index\":29,\"name\":{\"43\":{},\"57\":{}},\"comment\":{}}],[\"removepunctuation\",{\"_index\":17,\"name\":{\"18\":{},\"28\":{}},\"comment\":{}}],[\"removewhitespace\",{\"_index\":18,\"name\":{\"19\":{},\"27\":{}},\"comment\":{}}],[\"reorder\",{\"_index\":26,\"name\":{\"38\":{}},\"comment\":{}}],[\"reorderstr\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"replacemultiwhitespace\",{\"_index\":19,\"name\":{\"20\":{},\"25\":{}},\"comment\":{}}],[\"replaceunicode\",{\"_index\":16,\"name\":{\"17\":{},\"26\":{}},\"comment\":{}}],[\"score\",{\"_index\":28,\"name\":{\"42\":{},\"56\":{}},\"comment\":{}}],[\"strategies\",{\"_index\":6,\"name\":{\"6\":{},\"31\":{},\"37\":{}},\"comment\":{}}],[\"strategy\",{\"_index\":33,\"name\":{\"52\":{}},\"comment\":{}}],[\"strategyfunc\",{\"_index\":37,\"name\":{\"59\":{}},\"comment\":{}}],[\"strdefaulttransforms\",{\"_index\":21,\"name\":{\"29\":{},\"40\":{}},\"comment\":{}}],[\"stringcomparisonoptions\",{\"_index\":25,\"name\":{\"35\":{}},\"comment\":{}}],[\"stringsameness\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"stringsamenessresult\",{\"_index\":22,\"name\":{\"30\":{}},\"comment\":{}}],[\"stringtransformfunc\",{\"_index\":30,\"name\":{\"44\":{}},\"comment\":{}}],[\"transforms\",{\"_index\":20,\"name\":{\"21\":{},\"36\":{},\"39\":{}},\"comment\":{}}],[\"trim\",{\"_index\":15,\"name\":{\"16\":{},\"24\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/functions/createStringSameness.html b/functions/createStringSameness.html deleted file mode 100644 index 12bdcd8..0000000 --- a/functions/createStringSameness.html +++ /dev/null @@ -1,82 +0,0 @@ -createStringSameness | string-sameness Docs
-
- -
-
-
-
- -

Function createStringSameness

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/functions/index.createStringSameness.html b/functions/index.createStringSameness.html new file mode 100644 index 0000000..3e70776 --- /dev/null +++ b/functions/index.createStringSameness.html @@ -0,0 +1,86 @@ +createStringSameness | string-sameness Docs
+
+ +
+
+
+
+ +

Function createStringSameness

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/reorderStr.html b/functions/index.reorderStr.html similarity index 50% rename from functions/reorderStr.html rename to functions/index.reorderStr.html index c868a5b..6b6a56f 100644 --- a/functions/reorderStr.html +++ b/functions/index.reorderStr.html @@ -13,11 +13,12 @@
+
  • index
    • +
  • reorderStr

    • Function reorderStr

    -

    Returns string

    +
  • Defined in index.ts:79
    • @@ -50,22 +51,25 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • StringComparisonOptions
    • +
  • StringSamenessResult
    • +
  • ComparisonStrategyResult
    • +
  • StringTransformFunc
    • +
  • defaultStrategies
    • +
  • stringSameness
    • +
  • reorderStr
    • +
  • createStringSameness
    • +
  • strategies
    • +
  • defaultStrCompareTransformFuncs
    • +
  • transforms
    • +
  • strDefaultTransforms

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/index.stringSameness.html b/functions/index.stringSameness.html new file mode 100644 index 0000000..d9a6635 --- /dev/null +++ b/functions/index.stringSameness.html @@ -0,0 +1,75 @@ +stringSameness | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Function stringSameness

    +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/functions/normalization.lowercase.html b/functions/normalization.lowercase.html new file mode 100644 index 0000000..0b978cd --- /dev/null +++ b/functions/normalization.lowercase.html @@ -0,0 +1,67 @@ +lowercase | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Function lowercase

    +
    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        str: string
      +

      Returns string

    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/defaultStrategies.html b/functions/normalization.removePunctuation.html similarity index 54% rename from variables/defaultStrategies.html rename to functions/normalization.removePunctuation.html index 837c4cb..188f5eb 100644 --- a/variables/defaultStrategies.html +++ b/functions/normalization.removePunctuation.html @@ -1,4 +1,4 @@ -defaultStrategies | string-sameness Docs
    +removePunctuation | string-sameness Docs
    +
    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        str: string
      +

      Returns string

    +
  • Defined in atomic.ts:68
    • @@ -37,22 +47,21 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • lowercase
    • +
  • trim
    • +
  • replaceUnicode
    • +
  • removePunctuation
    • +
  • removeWhitespace
    • +
  • replaceMultiWhitespace
    • +
  • transforms
    • +
  • strDefaultTransforms

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/normalization.removeWhitespace.html b/functions/normalization.removeWhitespace.html new file mode 100644 index 0000000..bc51eec --- /dev/null +++ b/functions/normalization.removeWhitespace.html @@ -0,0 +1,67 @@ +removeWhitespace | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Function removeWhitespace

    +
    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        str: string
      +

      Returns string

    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/functions/normalization.replaceMultiWhitespace.html b/functions/normalization.replaceMultiWhitespace.html new file mode 100644 index 0000000..c2a3b3f --- /dev/null +++ b/functions/normalization.replaceMultiWhitespace.html @@ -0,0 +1,67 @@ +replaceMultiWhitespace | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Function replaceMultiWhitespace

    +
    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        str: string
      +

      Returns string

    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/functions/normalization.replaceUnicode.html b/functions/normalization.replaceUnicode.html new file mode 100644 index 0000000..60d587e --- /dev/null +++ b/functions/normalization.replaceUnicode.html @@ -0,0 +1,67 @@ +replaceUnicode | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Function replaceUnicode

    +
    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        str: string
      +

      Returns string

    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/functions/normalization.trim.html b/functions/normalization.trim.html new file mode 100644 index 0000000..75dac70 --- /dev/null +++ b/functions/normalization.trim.html @@ -0,0 +1,67 @@ +trim | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Function trim

    +
    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        str: string
      +

      Returns string

    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/functions/stringSameness.html b/functions/stringSameness.html deleted file mode 100644 index 2ab1439..0000000 --- a/functions/stringSameness.html +++ /dev/null @@ -1,71 +0,0 @@ -stringSameness | string-sameness Docs
    -
    - -
    -
    -
    -
    - -

    Function stringSameness

    -
    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/index.html b/index.html index c50f08f..4507e99 100644 --- a/index.html +++ b/index.html @@ -130,21 +130,10 @@
    - +
  • index
    • +
  • matchingStrategies
    • +
  • normalization

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ComparisonStrategyResult.html b/interfaces/index.ComparisonStrategyResult.html similarity index 72% rename from interfaces/ComparisonStrategyResult.html rename to interfaces/index.ComparisonStrategyResult.html index 5d17d88..4b9f7f5 100644 --- a/interfaces/ComparisonStrategyResult.html +++ b/interfaces/index.ComparisonStrategyResult.html @@ -13,16 +13,17 @@
    +
  • index
    • +
  • ComparisonStrategyResult

    • Interface ComparisonStrategyResult

    Hierarchy

    +
  • Defined in atomic.ts:39
    • @@ -30,8 +31,8 @@

    Properties

    -
    score -rawScore? +
    score +rawScore?

    Properties

    @@ -40,17 +41,17 @@
    score: number

    The normalized (0 to 100) score of this comparison

    +
  • Defined in atomic.ts:30

    • Optional rawScore

    rawScore?: number

    The raw value returned by the comparison (not normalized)

    +
  • Defined in atomic.ts:34
    • @@ -70,14 +71,17 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • score
    • +
  • rawScore?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/StringComparisonOptions.html b/interfaces/index.StringComparisonOptions.html similarity index 71% rename from interfaces/StringComparisonOptions.html rename to interfaces/index.StringComparisonOptions.html index 5fb8703..98197bb 100644 --- a/interfaces/StringComparisonOptions.html +++ b/interfaces/index.StringComparisonOptions.html @@ -13,14 +13,15 @@
    +
  • index
    • +
  • StringComparisonOptions

    • Interface StringComparisonOptions

    Hierarchy

    • StringComparisonOptions
    +
  • Defined in atomic.ts:1
    • @@ -28,26 +29,26 @@

    Properties

    -
    transforms? -strategies? -reorder? +
    transforms? +strategies? +reorder?

    Properties

    Optional transforms

    -
    transforms?: StringTransformFunc[]
    +
    transforms?: StringTransformFunc[]

    An array of transformations to apply to each string before comparing similarity

    +
  • Defined in atomic.ts:5

    • Optional strategies

    -
    strategies?: ComparisonStrategy<ComparisonStrategyResultValue>[]
    +
    strategies?: ComparisonStrategy<ComparisonStrategyResultValue>[]

    An array of strategies used to score similarity. All strategies scores are combined for an average high score.

    +
  • Defined in atomic.ts:9

    • Optional reorder

    reorder?: boolean
    @@ -55,7 +56,7 @@

    Useful when only the differences in content are important, but not the order of the content

    +
  • Defined in atomic.ts:15
    • @@ -75,15 +76,18 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • transforms?
    • +
  • strategies?
    • +
  • reorder?

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/StringSamenessResult.html b/interfaces/index.StringSamenessResult.html similarity index 72% rename from interfaces/StringSamenessResult.html rename to interfaces/index.StringSamenessResult.html index 90e11a9..8c49d2d 100644 --- a/interfaces/StringSamenessResult.html +++ b/interfaces/index.StringSamenessResult.html @@ -13,14 +13,15 @@
    +
  • index
    • +
  • StringSamenessResult

    • Interface StringSamenessResult

    Hierarchy

    • StringSamenessResult
    +
  • Defined in atomic.ts:18
    • @@ -28,32 +29,32 @@

    Properties

    -
    strategies -highScore -highScoreWeighted +
    strategies +highScore +highScoreWeighted

    Properties

    strategies

    -
    strategies: {
        [key: string]: ComparisonStrategyResult;
    }
    +
    strategies: {
        [key: string]: ComparisonStrategyResult;
    }

    Type declaration

    +
  • Defined in atomic.ts:19

    • highScore

    highScore: number
    +
  • Defined in atomic.ts:22

    • highScoreWeighted

    highScoreWeighted: number
    +
  • Defined in atomic.ts:23
    • @@ -73,15 +74,18 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • strategies
    • +
  • highScore
    • +
  • highScoreWeighted

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/matchingStrategies.ComparisonStrategy.html b/interfaces/matchingStrategies.ComparisonStrategy.html new file mode 100644 index 0000000..9dd7f7b --- /dev/null +++ b/interfaces/matchingStrategies.ComparisonStrategy.html @@ -0,0 +1,112 @@ +ComparisonStrategy | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Interface ComparisonStrategy<T>

    +
    +

    Type Parameters

    +
    +
    +

    Hierarchy

    +
      +
    • ComparisonStrategy
    +
    +
    +
    + +
    +
    +

    Properties

    +
    name +strategy +isValid? +
    +
    +

    Properties

    +
    +

    name

    +
    name: string
    +

    The name of this strategy

    +
    +
    +

    strategy

    +
    strategy: StrategyFunc<T>
    +

    A function that accepts two string arguments and returns a number

    +
    +
    +

    Optional isValid

    +
    isValid?: ((strA: string, strB: string) => boolean)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (strA: string, strB: string): boolean
        • +
      • +

        An optional function that accepts two string arguments and returns whether this strategy should be used

        +
        +
        +

        Parameters

        +
          +
        • +
          strA: string
          • +
        • +
          strB: string
        +

        Returns boolean

    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/interfaces/matchingStrategies.ComparisonStrategyResultObject.html b/interfaces/matchingStrategies.ComparisonStrategyResultObject.html new file mode 100644 index 0000000..6384692 --- /dev/null +++ b/interfaces/matchingStrategies.ComparisonStrategyResultObject.html @@ -0,0 +1,88 @@ +ComparisonStrategyResultObject | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Interface ComparisonStrategyResultObject

    +
    +

    Hierarchy

    +
    +
    +

    Indexable

    +
    [key: string]: any
    +
    +
    +
    + +
    +
    +

    Properties

    +
    score +rawScore? +
    +
    +

    Properties

    +
    +

    score

    +
    score: number
    +

    The normalized (0 to 100) score of this comparison

    +
    +
    +

    Optional rawScore

    +
    rawScore?: number
    +

    The raw value returned by the comparison (not normalized)

    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/modules.html b/modules.html index 691e957..ca0062a 100644 --- a/modules.html +++ b/modules.html @@ -16,28 +16,10 @@

    Index

    -

    Interfaces

    -
    StringComparisonOptions -StringSamenessResult -ComparisonStrategyResult -
    -
    -

    Type Aliases

    -
    StringTransformFunc -
    -
    -

    Variables

    -
    defaultStrategies -strategies -defaultStrCompareTransformFuncs -transforms -strDefaultTransforms -
    -
    -

    Functions

    -
    stringSameness -reorderStr -createStringSameness +

    Modules

    +
    index +matchingStrategies +normalization
    @@ -59,21 +41,10 @@
    -
    +
  • index
    • +
  • matchingStrategies
    • +
  • normalization

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/index.html b/modules/index.html new file mode 100644 index 0000000..d51aaca --- /dev/null +++ b/modules/index.html @@ -0,0 +1,100 @@ +index | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Module index

    +
    +
    +
    +
    +
    + +
    +
    +

    Interfaces

    +
    StringComparisonOptions +StringSamenessResult +ComparisonStrategyResult +
    +
    +

    Type Aliases

    +
    StringTransformFunc +
    +
    +

    Variables

    +
    defaultStrategies +strategies +defaultStrCompareTransformFuncs +
    +
    +

    Functions

    +
    stringSameness +reorderStr +createStringSameness +
    +
    +

    References

    +
    transforms +strDefaultTransforms +
    +
    +

    References

    +
    +

    transforms

    Re-exports transforms
    +
    +

    strDefaultTransforms

    Re-exports strDefaultTransforms
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/modules/matchingStrategies.html b/modules/matchingStrategies.html new file mode 100644 index 0000000..a9a1547 --- /dev/null +++ b/modules/matchingStrategies.html @@ -0,0 +1,78 @@ +matchingStrategies | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Module matchingStrategies

    +
    +
    +
    +
    +

    Index

    +
    +

    Interfaces

    +
    ComparisonStrategyResultObject +ComparisonStrategy +
    +
    +

    Type Aliases

    +
    ComparisonStrategyResultValue +StrategyFunc +
    +
    +

    Variables

    +
    cosineStrategy +cosineStrategyAggressive +diceStrategy +levenStrategy +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/modules/normalization.html b/modules/normalization.html new file mode 100644 index 0000000..355713d --- /dev/null +++ b/modules/normalization.html @@ -0,0 +1,75 @@ +normalization | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Module normalization

    +
    +
    +
    +
    +

    Index

    +
    +

    Functions

    +
    lowercase +trim +replaceUnicode +removePunctuation +removeWhitespace +replaceMultiWhitespace +
    +
    +

    Variables

    +
    transforms +strDefaultTransforms +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/types/StringTransformFunc.html b/types/index.StringTransformFunc.html similarity index 56% rename from types/StringTransformFunc.html rename to types/index.StringTransformFunc.html index baec427..2edaea3 100644 --- a/types/StringTransformFunc.html +++ b/types/index.StringTransformFunc.html @@ -13,7 +13,8 @@
    +
  • index
    • +
  • StringTransformFunc

    • Type alias StringTransformFunc

    StringTransformFunc: ((str: string) => string)
    @@ -30,7 +31,7 @@
    str: string

    Returns string

    +
  • Defined in atomic.ts:68
    • @@ -50,22 +51,25 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • StringComparisonOptions
    • +
  • StringSamenessResult
    • +
  • ComparisonStrategyResult
    • +
  • StringTransformFunc
    • +
  • defaultStrategies
    • +
  • stringSameness
    • +
  • reorderStr
    • +
  • createStringSameness
    • +
  • strategies
    • +
  • defaultStrCompareTransformFuncs
    • +
  • transforms
    • +
  • strDefaultTransforms

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/defaultStrCompareTransformFuncs.html b/types/matchingStrategies.ComparisonStrategyResultValue.html similarity index 51% rename from variables/defaultStrCompareTransformFuncs.html rename to types/matchingStrategies.ComparisonStrategyResultValue.html index 0cb9981..4f46136 100644 --- a/variables/defaultStrCompareTransformFuncs.html +++ b/types/matchingStrategies.ComparisonStrategyResultValue.html @@ -1,4 +1,4 @@ -defaultStrCompareTransformFuncs | string-sameness Docs
    +ComparisonStrategyResultValue | string-sameness Docs
    +
    ComparisonStrategyResultValue: number | ComparisonStrategyResultObject
    +
  • Defined in atomic.ts:48
    • @@ -37,22 +38,21 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • ComparisonStrategyResultObject
    • +
  • ComparisonStrategyResultValue
    • +
  • StrategyFunc
    • +
  • ComparisonStrategy
    • +
  • cosineStrategy
    • +
  • cosineStrategyAggressive
    • +
  • diceStrategy
    • +
  • levenStrategy

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/types/matchingStrategies.StrategyFunc.html b/types/matchingStrategies.StrategyFunc.html new file mode 100644 index 0000000..476988e --- /dev/null +++ b/types/matchingStrategies.StrategyFunc.html @@ -0,0 +1,78 @@ +StrategyFunc | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Type alias StrategyFunc<T>

    +
    StrategyFunc<T>: ((strA: string, strB: string) => T)
    +
    +

    Type Parameters

    +
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (strA: string, strB: string): T
        • +
      • +
        +

        Parameters

        +
          +
        • +
          strA: string
          • +
        • +
          strB: string
        +

        Returns T

    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/index.defaultStrCompareTransformFuncs.html b/variables/index.defaultStrCompareTransformFuncs.html new file mode 100644 index 0000000..ca9211e --- /dev/null +++ b/variables/index.defaultStrCompareTransformFuncs.html @@ -0,0 +1,62 @@ +defaultStrCompareTransformFuncs | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Variable defaultStrCompareTransformFuncsConst

    +
    defaultStrCompareTransformFuncs: StringTransformFunc[] = strDefaultTransforms
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/index.defaultStrategies.html b/variables/index.defaultStrategies.html new file mode 100644 index 0000000..42b8179 --- /dev/null +++ b/variables/index.defaultStrategies.html @@ -0,0 +1,62 @@ +defaultStrategies | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Variable defaultStrategiesConst

    +
    defaultStrategies: ComparisonStrategy<ComparisonStrategyResultObject>[] = ...
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/index.strategies.html b/variables/index.strategies.html new file mode 100644 index 0000000..c38ed6a --- /dev/null +++ b/variables/index.strategies.html @@ -0,0 +1,73 @@ +strategies | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Variable strategiesConst

    +
    strategies: {
        diceStrategy: ComparisonStrategy<ComparisonStrategyResultObject>;
        levenStrategy: ComparisonStrategy<ComparisonStrategyResultObject>;
        cosineStrategy: ComparisonStrategy<ComparisonStrategyResultObject>;
        cosineStrategyAggressive: ComparisonStrategy<ComparisonStrategyResultObject>;
    } = ...
    +
    +

    Type declaration

    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/matchingStrategies.cosineStrategy.html b/variables/matchingStrategies.cosineStrategy.html new file mode 100644 index 0000000..279a6db --- /dev/null +++ b/variables/matchingStrategies.cosineStrategy.html @@ -0,0 +1,62 @@ +cosineStrategy | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Variable cosineStrategyConst

    +
    cosineStrategy: ComparisonStrategy<ComparisonStrategyResultObject> = ...
    +

    Compares whole tokens (words) within a string independent of order

    +

    This strategy is automatically disabled for strings with less than 4 words because it can lead to inaccurate scores due to not comparing characters IE it is not very useful for short sentences and comparing single words with typos

    +

    If you'd like to use it even in these scenarios build your own strategy array using cosineStrategyAggressive instead of this one

    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/matchingStrategies.cosineStrategyAggressive.html b/variables/matchingStrategies.cosineStrategyAggressive.html new file mode 100644 index 0000000..b480bd1 --- /dev/null +++ b/variables/matchingStrategies.cosineStrategyAggressive.html @@ -0,0 +1,60 @@ +cosineStrategyAggressive | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Variable cosineStrategyAggressiveConst

    +
    cosineStrategyAggressive: ComparisonStrategy<ComparisonStrategyResultObject> = ...
    +

    Always runs (strings are always valid) which may lead to inaccurate scores in low token-count strings

    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/matchingStrategies.diceStrategy.html b/variables/matchingStrategies.diceStrategy.html new file mode 100644 index 0000000..8d9f7ae --- /dev/null +++ b/variables/matchingStrategies.diceStrategy.html @@ -0,0 +1,58 @@ +diceStrategy | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Variable diceStrategyConst

    +
    diceStrategy: ComparisonStrategy<ComparisonStrategyResultObject> = ...
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/matchingStrategies.levenStrategy.html b/variables/matchingStrategies.levenStrategy.html new file mode 100644 index 0000000..e89145c --- /dev/null +++ b/variables/matchingStrategies.levenStrategy.html @@ -0,0 +1,58 @@ +levenStrategy | string-sameness Docs
    +
    + +
    +
    +
    +
    + +

    Variable levenStrategyConst

    +
    levenStrategy: ComparisonStrategy<ComparisonStrategyResultObject> = ...
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    + +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/variables/strDefaultTransforms.html b/variables/normalization.strDefaultTransforms.html similarity index 56% rename from variables/strDefaultTransforms.html rename to variables/normalization.strDefaultTransforms.html index 555ab73..7fa4f7c 100644 --- a/variables/strDefaultTransforms.html +++ b/variables/normalization.strDefaultTransforms.html @@ -13,11 +13,12 @@
    +
  • normalization
    • +
  • strDefaultTransforms

    • Variable strDefaultTransformsConst

    -
    strDefaultTransforms: StringTransformFunc[] = ...
    @@ -37,22 +38,21 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • lowercase
    • +
  • trim
    • +
  • replaceUnicode
    • +
  • removePunctuation
    • +
  • removeWhitespace
    • +
  • replaceMultiWhitespace
    • +
  • transforms
    • +
  • strDefaultTransforms

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/transforms.html b/variables/normalization.transforms.html similarity index 52% rename from variables/transforms.html rename to variables/normalization.transforms.html index 8c81d31..0ab7c7d 100644 --- a/variables/transforms.html +++ b/variables/normalization.transforms.html @@ -13,26 +13,27 @@
    +
  • normalization
    • +
  • transforms

    • Variable transformsConst

    -
    transforms: {
        lowercase: StringTransformFunc;
        trim: StringTransformFunc;
        replaceMultiWhitespace: StringTransformFunc;
        replaceUnicode: StringTransformFunc;
        removeWhitespace: StringTransformFunc;
        removePunctuation: StringTransformFunc;
    } = ...
    +
    transforms: {
        lowercase: StringTransformFunc;
        trim: StringTransformFunc;
        replaceMultiWhitespace: StringTransformFunc;
        replaceUnicode: StringTransformFunc;
        removeWhitespace: StringTransformFunc;
        removePunctuation: StringTransformFunc;
    } = ...

    Type declaration

    @@ -52,22 +53,21 @@

    Modules
    +
  • string-sameness Docs +
    • +
  • lowercase
    • +
  • trim
    • +
  • replaceUnicode
    • +
  • removePunctuation
    • +
  • removeWhitespace
    • +
  • replaceMultiWhitespace
    • +
  • transforms
    • +
  • strDefaultTransforms

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/strategies.html b/variables/strategies.html deleted file mode 100644 index 61e894d..0000000 --- a/variables/strategies.html +++ /dev/null @@ -1,69 +0,0 @@ -strategies | string-sameness Docs
    -
    - -
    -
    -
    -
    - -

    Variable strategiesConst

    -
    strategies: {
        diceStrategy: ComparisonStrategy<ComparisonStrategyResultObject>;
        levenStrategy: ComparisonStrategy<ComparisonStrategyResultObject>;
        cosineStrategy: ComparisonStrategy<ComparisonStrategyResultObject>;
        cosineStrategyAggressive: ComparisonStrategy<ComparisonStrategyResultObject>;
    } = ...
    -
    -

    Type declaration

    -
      -
    • -
      diceStrategy: ComparisonStrategy<ComparisonStrategyResultObject>
      • -
    • -
      levenStrategy: ComparisonStrategy<ComparisonStrategyResultObject>
      • -
    • -
      cosineStrategy: ComparisonStrategy<ComparisonStrategyResultObject>
      • -
    • -
      cosineStrategyAggressive: ComparisonStrategy<ComparisonStrategyResultObject>
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file