highlight-matches-utils/index.js.flow

Utility functions to mark and/or highlight character matches in texts

// @flow

declare type SplitMatchesResult = Array<{|
  isMatch: boolean,
  str: string
|}>

declare module.exports: {
  highlightChars<T>(
    text: string,
    chars: string,
    matchesWrapper: (s: string, index: number, array: SplitMatchesResult) => T,
    noMatchesWrapper?: (
      s: string,
      index: number,
      array: SplitMatchesResult
    ) => T
  ): Array<T>,

  highlightMatches<T>(
    text: string,
    matches: number[],
    matchesWrapper: (s: string, index: number, array: SplitMatchesResult) => T,
    noMatchesWrapper?: (
      s: string,
      index: number,
      array: SplitMatchesResult
    ) => T
  ): Array<T>,

  splitMatches(text: string, matches: number[]): SplitMatchesResult
}