External module "string/prev-grapheme-cluster-break/docs/types/index.d"

Export assignment prevGraphemeClusterBreak

• prevGraphemeClusterBreak(str: string, fromIndex?: undefined | number): number

• Returns the previous extended grapheme cluster break in a string before a specified position.

  throws

  first argument must be a string

  throws

  second argument must be an integer

  Parameters

  • str: string

    input string

  • Optional fromIndex: undefined | number

    position (default: str.length-1)

  Returns number

  previous grapheme break position

  Example

  var out = prevGraphemeClusterBreak( 'अनुच्छेद', 2 );
  // returns 0
  
  out = prevGraphemeClusterBreak( '🌷', 1 );
  // returns -1