ChemPal Documentation - v0.0.13-beta.5
    Preparing search index...

    Function isFuzzScorerName

    • Type guard — narrows an arbitrary string (e.g. out of userSettings) to a valid scorer key, so callers can safely index FUZZ_SCORERS[name].

      Parameters

      • name: unknown

        Candidate scorer name.

      Returns name is
          | "ratio"
          | "partial_ratio"
          | "token_sort_ratio"
          | "token_set_ratio"
          | "token_similarity_sort_ratio"
          | "partial_token_sort_ratio"
          | "partial_token_set_ratio"
          | "partial_token_similarity_sort_ratio"
          | "WRatio"

      True when name is a registered scorer.

      if (isFuzzScorerName(userSettings.fuzzScorerOverride)) {
      const scorer = FUZZ_SCORERS[userSettings.fuzzScorerOverride];
      }
      export function isFuzzScorerName(name: unknown): name is FuzzScorerName {
      return typeof name === "string" && name in FUZZ_SCORERS;
      }