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

Export assignment nextGraphemeClusterBreak

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

• Returns the next extended grapheme cluster break in a string after 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: 0)

  Returns number

  next grapheme break position

  Example

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