addBestMatch | WebHare Platform SDK

Function addBestMatch

addBestMatch(
    name: string,
    alternatives: string[],
    matchCase?: { matchCase?: boolean },
): string
Return match info as text to append to the end of a message
Parameters
- name: string
  Name to search
- alternatives: string[]
  Alternatives to choose from
- matchCase: { matchCase?: boolean } = {}
  Do a case sensitive compare (defaults to FALSE)
Returns string
Returns ", did you mean 'XXX'?" text if a better match was found, otherwise an empty string
Example
```
throw new Error(`${libname} does not export '${name}'${addBestMatch(name, Object.keys(lib))}`);
```
- Defined in jssdk/js-api-tools/src/levenshtein.ts:30