Interface FuzzyMatcherConstructor

constructor

• new FuzzyMatcherConstructor<Target, Pronounceable, Extraction>(targets: Target[], distance: ((a: Pronounceable, b: Pronounceable) => number) | Distance<Pronounceable>, extract?: (target: Target) => Extraction): FuzzyMatcher<Target, Extraction>

• memberof

  FuzzyMatcherConstructor

  Type parameters

  • Target

    The type of the object to match against.

  • Pronounceable

    The type of input for the distance function.

  • Extraction

    The type of query object.

  Parameters

  • targets: Target[]

    The set of objects that will be matched against. The order of equal targets is not guaranteed to be preserved.

  • distance: ((a: Pronounceable, b: Pronounceable) => number) | Distance<Pronounceable>

    The distance function.

  • Optional extract: (target: Target) => Extraction

    • • (target: Target): Extraction

      • Parameters

        • target: Target

        Returns Extraction

  Returns FuzzyMatcher<Target, Extraction>

  The fuzzy matcher instance.