@newdash/newdash/string/distance.d.ts

javascript/typescript utility library

/**
 * calculate distance of two string
 *
 * @since 5.16.0
 * @category String
 *
 * @param s1
 * @param s2
 */
export declare function distance(s1?: string, s2?: string): number;
/**
 * get closest string from dict
 *
 * @since 5.16.0
 * @category string
 * @param input
 * @param dict
 *
 *
 * ```ts
  const dict = ['hello', 'haha', 'mama', 'moment', 'world', 'latest'];

  expect(closest('h', dict)).toBe('haha');
  expect(closest('he', dict)).toBe('hello');
  expect(closest('m', dict)).toBe('mama');
  expect(closest('mo', dict)).toBe('mama');
  expect(closest('mome', dict)).toBe('mama');
  expect(closest('latast', dict)).toBe('latest');
  ```
 */
export declare function closest(input: string, dict: Array<string>): string;