time-to-botec/squiggle/node_modules/@stdlib/string/next-grapheme-cluster-break/lib/index.js

44 lines
1.1 KiB
JavaScript
Raw Normal View History

/**
* @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.
*/
'use strict';
/**
* Return the next extended grapheme cluster break in a string after a specified position.
*
* @module @stdlib/string/next-grapheme-cluster-break
*
* @example
* var nextGraphemeClusterBreak = require( '@stdlib/string/next-grapheme-cluster-break' );
*
* var out = nextGraphemeClusterBreak( 'अनुच्छेद', 1 );
* // returns 3
*
* out = nextGraphemeClusterBreak( '🌷', 0 );
* // returns -1
*/
// MODULES //
var nextGraphemeClusterBreak = require( './main.js' );
// EXPORTS //
module.exports = nextGraphemeClusterBreak;