All files main.js

100% Statements 90/90
100% Branches 8/8
100% Functions 1/1
100% Lines 90/90

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 911x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 13x 13x 13x 13x 13x 13x 13x 13x 13x 3x 3x 13x 3x 3x 3x 3x 3x 7x 13x 26x 26x 26x 26x 7x 13x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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';
 
// MODULES //
 
var numGraphemeClusters = require( '@stdlib/string/num-grapheme-clusters' );
var nextGraphemeClusterBreak = require( '@stdlib/string/next-grapheme-cluster-break' );
 
 
// MAIN //
 
/**
* Truncates a string to a specified length in grapheme clusters.
*
* @param {string} str - input string
* @param {NonNegativeInteger} len - output string length (including ending)
* @param {string} ending - custom ending
* @returns {string} truncated string
*
* @example
* var out = truncate( 'beep boop', 7, '...' );
* // returns 'beep...'
*
* @example
* var out = truncate( 'beep boop', 5, '>>>' );
* // returns 'be>>>'
*
* @example
* var out = truncate( 'beep boop', 10, '...' );
* // returns 'beep boop'
*
* @example
* var out = truncate( 'beep boop', 0, '...' );
* // returns ''
*
* @example
* var out = truncate( 'beep boop', 2, '...' );
* // returns '..'
*
* @example
* var out = truncate( '🐺 Wolf Brothers 🐺', 7, '...' );
* // returns '🐺 Wo...'
*/
function truncate( str, len, ending ) {
	var endingLength;
	var fromIndex;
	var nVisual;
	var idx;
 
	endingLength = numGraphemeClusters( ending );
	fromIndex = 0;
	if ( len >= numGraphemeClusters( str ) ) {
		return str;
	}
	if ( len - endingLength <= 0 ) {
		// Note: when slicing the ending, we use UTF-16 code units since `slice` operates on them.
		// If `ending` contains multi-code-unit graphemes, it will slice in the middle of a grapheme.
		// This mimics the original truncate behavior.
		return ending.slice( 0, len );
	}
	nVisual = 0;
	while ( nVisual < len - endingLength ) {
		idx = nextGraphemeClusterBreak( str, fromIndex );
		fromIndex = idx;
		nVisual += 1;
	}
	return str.substring( 0, idx ) + ending;
}
 
 
// EXPORTS //
 
module.exports = truncate;