main.js (1797B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2021 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var isString = require( '@stdlib/assert/is-string' ).isPrimitive; 24 var nextGraphemeClusterBreak = require( './../../next-grapheme-cluster-break' ); 25 var format = require( './../../format' ); 26 27 28 // MAIN // 29 30 /** 31 * Splits a string by its grapheme cluster breaks. 32 * 33 * @param {string} str - input string 34 * @throws {TypeError} must provide a string primitive 35 * @returns {StringArray} array of grapheme clusters 36 * 37 * @example 38 * var out = splitGraphemeClusters( 'café' ); 39 * // returns [ 'c', 'a', 'f', 'é' ] 40 * 41 * @example 42 * var out = splitGraphemeClusters( '🍕🍕🍕' ); 43 * // returns [ '🍕', '🍕', '🍕' ] 44 */ 45 function splitGraphemeClusters( str ) { 46 var idx; 47 var brk; 48 var out; 49 50 if ( !isString( str ) ) { 51 throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) ); 52 } 53 idx = 0; 54 out = []; 55 if ( str.length === 0 ) { 56 return out; 57 } 58 brk = nextGraphemeClusterBreak( str, idx ); 59 while ( brk !== -1 ) { 60 out.push( str.substring( idx, brk ) ); 61 idx = brk; 62 brk = nextGraphemeClusterBreak( str, idx ); 63 } 64 out.push( str.substring( idx ) ); 65 return out; 66 } 67 68 69 // EXPORTS // 70 71 module.exports = splitGraphemeClusters;