diff --git a/functions/index.createStringSameness.html b/functions/index.createStringSameness.html index cbc5c94..e0938fe 100644 --- a/functions/index.createStringSameness.html +++ b/functions/index.createStringSameness.html @@ -42,7 +42,7 @@
valB: string
options: StringComparisonOptions = {}

Returns StringSamenessResult

+
  • Defined in index.ts:153
    • diff --git a/functions/index.reorderStr.html b/functions/index.reorderStr.html index 44409b0..0a346cb 100644 --- a/functions/index.reorderStr.html +++ b/functions/index.reorderStr.html @@ -31,7 +31,7 @@
    strB: string
    Optional options: StringComparisonOptions

    Returns [string, string]

    +
  • Defined in index.ts:82
    • diff --git a/functions/index.stringSameness.html b/functions/index.stringSameness.html index 0e20800..974e4c4 100644 --- a/functions/index.stringSameness.html +++ b/functions/index.stringSameness.html @@ -31,7 +31,7 @@
    valB: string
    Optional options: StringComparisonOptions

    Returns StringSamenessResult

    +
  • Defined in index.ts:23
    • diff --git a/functions/normalization.lowercase.html b/functions/normalization.lowercase.html index 443a790..3bfe584 100644 --- a/functions/normalization.lowercase.html +++ b/functions/normalization.lowercase.html @@ -27,7 +27,7 @@

    Parameters

    str: string

    Returns string

    +
  • Defined in atomic.ts:77
    • diff --git a/functions/normalization.removeNonAlphanumeric.html b/functions/normalization.removeNonAlphanumeric.html index ad810de..fa9c91f 100644 --- a/functions/normalization.removeNonAlphanumeric.html +++ b/functions/normalization.removeNonAlphanumeric.html @@ -27,7 +27,7 @@

    Parameters

    str: string

    Returns string

    +
  • Defined in atomic.ts:77
    • diff --git a/functions/normalization.removePunctuation.html b/functions/normalization.removePunctuation.html index 92a6db7..ff7080c 100644 --- a/functions/normalization.removePunctuation.html +++ b/functions/normalization.removePunctuation.html @@ -27,7 +27,7 @@

    Parameters

    str: string

    Returns string

    +
  • Defined in atomic.ts:77
    • diff --git a/functions/normalization.removeWhitespace.html b/functions/normalization.removeWhitespace.html index 2c36b21..8fe0835 100644 --- a/functions/normalization.removeWhitespace.html +++ b/functions/normalization.removeWhitespace.html @@ -27,7 +27,7 @@

    Parameters

    str: string

    Returns string

    +
  • Defined in atomic.ts:77
    • diff --git a/functions/normalization.replaceMultiWhitespace.html b/functions/normalization.replaceMultiWhitespace.html index 9434207..ce4b5a3 100644 --- a/functions/normalization.replaceMultiWhitespace.html +++ b/functions/normalization.replaceMultiWhitespace.html @@ -27,7 +27,7 @@

    Parameters

    str: string

    Returns string

    +
  • Defined in atomic.ts:77
    • diff --git a/functions/normalization.replaceUnicode.html b/functions/normalization.replaceUnicode.html index 062b700..4e38ae6 100644 --- a/functions/normalization.replaceUnicode.html +++ b/functions/normalization.replaceUnicode.html @@ -27,7 +27,7 @@

    Parameters

    str: string

    Returns string

    +
  • Defined in atomic.ts:77
    • diff --git a/functions/normalization.trim.html b/functions/normalization.trim.html index 308f838..22dfbab 100644 --- a/functions/normalization.trim.html +++ b/functions/normalization.trim.html @@ -27,7 +27,7 @@

    Parameters

    str: string

    Returns string

    +
  • Defined in atomic.ts:77
    • diff --git a/interfaces/index.ComparisonStrategyResult.html b/interfaces/index.ComparisonStrategyResult.html index 4e7e25b..4dffc59 100644 --- a/interfaces/index.ComparisonStrategyResult.html +++ b/interfaces/index.ComparisonStrategyResult.html @@ -23,7 +23,7 @@

    Hierarchy

    • ComparisonStrategyResult
    +
  • Defined in atomic.ts:48
    • @@ -43,7 +43,7 @@

    score

    Inherited from ComparisonStrategyResultObject.score

    +
  • Defined in atomic.ts:39

    • Optional rawScore

    rawScore?: number
    @@ -51,7 +51,7 @@

    Optional

    +
  • Defined in atomic.ts:43
    • diff --git a/interfaces/index.StringComparisonOptions.html b/interfaces/index.StringComparisonOptions.html index 12bc623..0b550b8 100644 --- a/interfaces/index.StringComparisonOptions.html +++ b/interfaces/index.StringComparisonOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    • StringComparisonOptions
    +
  • Defined in atomic.ts:1
    • @@ -42,14 +42,14 @@

    Optional

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

    +
  • Defined in atomic.ts:5

    • Optional strategies

    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
    @@ -57,7 +57,7 @@

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

    +
  • Defined in atomic.ts:15

    • Optional delimiter

    delimiter?: string | RegExp
    @@ -67,7 +67,7 @@

    OptionalDefault

    " "

    +
  • Defined in atomic.ts:24
    • diff --git a/interfaces/index.StringSamenessResult.html b/interfaces/index.StringSamenessResult.html index 2e4be50..11884e7 100644 --- a/interfaces/index.StringSamenessResult.html +++ b/interfaces/index.StringSamenessResult.html @@ -21,7 +21,7 @@

    Hierarchy

    • StringSamenessResult
    +
  • Defined in atomic.ts:27
    • @@ -44,17 +44,17 @@

    Type declaration

  • [key: string]: ComparisonStrategyResult
    • +
  • Defined in atomic.ts:28

    • highScore

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

    • highScoreWeighted

    highScoreWeighted: number
    +
  • Defined in atomic.ts:32
    • diff --git a/interfaces/matchingStrategies.ComparisonStrategy.html b/interfaces/matchingStrategies.ComparisonStrategy.html index 86e8b54..00a7ca8 100644 --- a/interfaces/matchingStrategies.ComparisonStrategy.html +++ b/interfaces/matchingStrategies.ComparisonStrategy.html @@ -26,7 +26,7 @@

    Hierarchy

    • ComparisonStrategy
    +
  • Defined in atomic.ts:61
    • @@ -46,14 +46,14 @@

    name

    The name of this strategy

    +
  • Defined in atomic.ts:65

    • strategy

    strategy: StrategyFunc<T>

    A function that accepts two string arguments and returns a number

    +
  • Defined in atomic.ts:69

    • Optional isValid

    isValid?: ((strA: string, strB: string) => boolean)
    @@ -75,7 +75,7 @@
    strA: string
    strB: string

    Returns boolean

    +
  • Defined in atomic.ts:74
    • diff --git a/interfaces/matchingStrategies.ComparisonStrategyResultObject.html b/interfaces/matchingStrategies.ComparisonStrategyResultObject.html index 8e2cb2a..adfa1bb 100644 --- a/interfaces/matchingStrategies.ComparisonStrategyResultObject.html +++ b/interfaces/matchingStrategies.ComparisonStrategyResultObject.html @@ -26,7 +26,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in atomic.ts:35
    • @@ -45,14 +45,14 @@

    score

    The normalized (0 to 100) score of this comparison

    +
  • Defined in atomic.ts:39

    • Optional rawScore

    rawScore?: number

    The raw value returned by the comparison (not normalized)

    +
  • Defined in atomic.ts:43
    • diff --git a/modules/index.html b/modules/index.html index 8aad4f8..f69d802 100644 --- a/modules/index.html +++ b/modules/index.html @@ -16,7 +16,7 @@
  • index

    • Module index

    +
  • Defined in index.ts:1
    • diff --git a/modules/matchingStrategies.html b/modules/matchingStrategies.html index f54e166..72d20e2 100644 --- a/modules/matchingStrategies.html +++ b/modules/matchingStrategies.html @@ -16,7 +16,7 @@
  • matchingStrategies

    • Module matchingStrategies

    +
  • Defined in matchingStrategies/index.ts:1
    • diff --git a/modules/normalization.html b/modules/normalization.html index 92e6f00..87e8e51 100644 --- a/modules/normalization.html +++ b/modules/normalization.html @@ -16,7 +16,7 @@
  • normalization

    • Module normalization

    +
  • Defined in normalization/index.ts:1
    • diff --git a/types/index.StringTransformFunc.html b/types/index.StringTransformFunc.html index b5cf930..609de0e 100644 --- a/types/index.StringTransformFunc.html +++ b/types/index.StringTransformFunc.html @@ -31,7 +31,7 @@

    Parameters

    str: string

    Returns string

    +
  • Defined in atomic.ts:77
    • diff --git a/types/matchingStrategies.ComparisonStrategyResultValue.html b/types/matchingStrategies.ComparisonStrategyResultValue.html index cf06587..0cc93d8 100644 --- a/types/matchingStrategies.ComparisonStrategyResultValue.html +++ b/types/matchingStrategies.ComparisonStrategyResultValue.html @@ -18,7 +18,7 @@

    Type alias ComparisonStrategyResultValue

    ComparisonStrategyResultValue: number | ComparisonStrategyResultObject
    +
  • Defined in atomic.ts:57
    • diff --git a/types/matchingStrategies.StrategyFunc.html b/types/matchingStrategies.StrategyFunc.html index 92f8183..38fba46 100644 --- a/types/matchingStrategies.StrategyFunc.html +++ b/types/matchingStrategies.StrategyFunc.html @@ -38,7 +38,7 @@
    strA: string
    strB: string

    Returns T

    +
  • Defined in atomic.ts:59
    • diff --git a/variables/index.defaultStrCompareTransformFuncs.html b/variables/index.defaultStrCompareTransformFuncs.html index 5395bd3..8552b3c 100644 --- a/variables/index.defaultStrCompareTransformFuncs.html +++ b/variables/index.defaultStrCompareTransformFuncs.html @@ -18,7 +18,7 @@

    Variable defaultStrCompareTransformFuncsConst

    defaultStrCompareTransformFuncs: StringTransformFunc[] = strDefaultTransforms
    +
  • Defined in index.ts:165
    • diff --git a/variables/index.defaultStrategies.html b/variables/index.defaultStrategies.html index 52fed7a..6bc515a 100644 --- a/variables/index.defaultStrategies.html +++ b/variables/index.defaultStrategies.html @@ -18,7 +18,7 @@

    Variable defaultStrategiesConst

    defaultStrategies: ComparisonStrategy<ComparisonStrategyResultObject>[] = ...
    +
  • Defined in index.ts:17
    • diff --git a/variables/index.strategies.html b/variables/index.strategies.html index 938ab54..5f3966f 100644 --- a/variables/index.strategies.html +++ b/variables/index.strategies.html @@ -29,7 +29,7 @@
    cosineStrategy:
    cosineStrategyAggressive: ComparisonStrategy<ComparisonStrategyResultObject>
    +
  • Defined in index.ts:157
    • diff --git a/variables/matchingStrategies.cosineStrategy.html b/variables/matchingStrategies.cosineStrategy.html index 98a6d3f..aaf92c0 100644 --- a/variables/matchingStrategies.cosineStrategy.html +++ b/variables/matchingStrategies.cosineStrategy.html @@ -22,7 +22,7 @@

    Variable cosineStrategyConst

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

    +
  • Defined in matchingStrategies/cosineSimilarity.ts:93
    • diff --git a/variables/matchingStrategies.cosineStrategyAggressive.html b/variables/matchingStrategies.cosineStrategyAggressive.html index 04c9b10..5d3633b 100644 --- a/variables/matchingStrategies.cosineStrategyAggressive.html +++ b/variables/matchingStrategies.cosineStrategyAggressive.html @@ -20,7 +20,7 @@

    Variable cosineStrategyAggressiveConst

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

    +
  • Defined in matchingStrategies/cosineSimilarity.ts:108
    • diff --git a/variables/matchingStrategies.diceStrategy.html b/variables/matchingStrategies.diceStrategy.html index f327ee6..ded24c9 100644 --- a/variables/matchingStrategies.diceStrategy.html +++ b/variables/matchingStrategies.diceStrategy.html @@ -18,7 +18,7 @@

    Variable diceStrategyConst

    diceStrategy: ComparisonStrategy<ComparisonStrategyResultObject> = ...
    +
  • Defined in matchingStrategies/diceSimilarity.ts:5
    • diff --git a/variables/matchingStrategies.levenStrategy.html b/variables/matchingStrategies.levenStrategy.html index 09046bb..280d0ee 100644 --- a/variables/matchingStrategies.levenStrategy.html +++ b/variables/matchingStrategies.levenStrategy.html @@ -18,7 +18,7 @@

    Variable levenStrategyConst

    levenStrategy: ComparisonStrategy<ComparisonStrategyResultObject> = ...
    +
  • Defined in matchingStrategies/levenSimilarity.ts:33
    • diff --git a/variables/normalization.strDefaultTransforms.html b/variables/normalization.strDefaultTransforms.html index 1ad3e9d..3c0592f 100644 --- a/variables/normalization.strDefaultTransforms.html +++ b/variables/normalization.strDefaultTransforms.html @@ -18,7 +18,7 @@

    Variable strDefaultTransformsConst

    strDefaultTransforms: StringTransformFunc[] = ...
    +
  • Defined in normalization/index.ts:25
    • diff --git a/variables/normalization.transforms.html b/variables/normalization.transforms.html index 608aa3d..764c904 100644 --- a/variables/normalization.transforms.html +++ b/variables/normalization.transforms.html @@ -33,7 +33,7 @@
    removeWhitespace:
    removePunctuation: StringTransformFunc
    +
  • Defined in normalization/index.ts:16