@stdlib/string
Version:
String manipulation functions.
43 lines (37 loc) • 1.26 kB
TypeScript
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 4.1
/**
* Returns the previous extended grapheme cluster break in a string before a specified position.
*
* @param str - input string
* @param fromIndex - position (default: str.length-1)
* @throws first argument must be a string
* @throws second argument must be an integer
* @returns previous grapheme break position
*
* @example
* var out = prevGraphemeClusterBreak( 'अनुच्छेद', 2 );
* // returns 0
*
* out = prevGraphemeClusterBreak( '🌷', 1 );
* // returns -1
*/
declare function prevGraphemeClusterBreak( str: string, fromIndex?: number ): number;
// EXPORTS //
export = prevGraphemeClusterBreak;