-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
42 lines (37 loc) · 1.27 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*
* @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: 2.0
/**
* 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; // tslint:disable-line:max-line-length
// EXPORTS //
export = prevGraphemeClusterBreak;