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
43
44
45
|
/*
* @license Apache-2.0
*
* Copyright (c) 2020 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 a Unicode code point from a string at specified position.
*
* @param str - input string
* @param idx - position
* @param backward - backward iteration for low surrogates (default: false)
* @throws first argument must be a string
* @throws second argument must be a nonnegative integer
* @throws third argument must be a boolean
* @throws position must be a valid index in string
* @returns code point
*
* @example
* var str = codePointAt( 'अनुच्छेद', 2 );
* // returns 2369
*
* str = codePointAt( '🌷', 1, true );
* // returns 127799
*/
declare function codePointAt( str: string, idx: number, backward?: boolean ): number; // tslint:disable-line:max-line-length
// EXPORTS //
export = codePointAt;
|
