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 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 62x 62x 62x 62x 62x 62x 62x 8x 8x 62x 10x 10x 44x 44x 44x 44x 44x 62x 25x 14x 25x 4x 11x 7x 7x 62x 9x 9x 9x 9x 8x 8x 9x 62x 15x 15x 15x 11x 11x 15x 15x 18x 62x 12x 12x 12x 12x 12x | /**
* @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.
*/
'use strict';
// MODULES //
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var contains = require( '@stdlib/array/base/assert/contains' ).factory;
var format = require( '@stdlib/string/format' );
var truncateCodeUnit = require( '@stdlib/string/base/truncate' );
var truncateCodePoint = require( '@stdlib/string/base/truncate-code-point' );
var truncateGraphemeCluster = require( '@stdlib/string/base/truncate-grapheme-cluster' );
// VARIABLES //
var MODES = [ 'grapheme', 'code_point', 'code_unit' ];
var FCNS = {
'grapheme': truncateGraphemeCluster,
'code_point': truncateCodePoint,
'code_unit': truncateCodeUnit
};
var isMode = contains( MODES );
// MAIN //
/**
* Truncates a string to a specified length.
*
* @param {string} str - input string
* @param {NonNegativeInteger} len - output string length (including ending)
* @param {string} [ending="..."] - custom ending
* @param {Options} [options] - options
* @param {string} [options.mode="grapheme"] - type of "character" to truncate (must be either `grapheme`, `code_point`, or `code_unit`)
* @throws {TypeError} first argument must be a string
* @throws {TypeError} second argument must be a nonnegative integer
* @throws {TypeError} third argument must be a string (if provided before options)
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {string} truncated string
*
* @example
* var str = 'beep boop';
* var out = truncate( str, 7 );
* // returns 'beep...'
*
* @example
* var str = 'beep boop';
* var out = truncate( str, 5, '>>>' );
* // returns 'be>>>'
*
* @example
* var str = 'beep boop';
* var out = truncate( str, 10 );
* // returns 'beep boop'
*
* @example
* var str = 'beep boop';
* var out = truncate( str, 0 );
* // returns ''
*
* @example
* var str = 'beep boop';
* var out = truncate( str, 2 );
* // returns '..'
*
* @example
* var str = '🐺 Wolf Brothers 🐺';
* var out = truncate( str, 7, {
* 'mode': 'grapheme'
* });
* // returns '🐺 Wo...'
*/
function truncate( str, len ) {
var options;
var ending;
var nargs;
var opts;
if ( !isString( str ) ) {
throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
}
if ( !isNonNegativeInteger( len ) ) {
throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%s`.', len ) );
}
opts = {
'mode': 'grapheme'
};
ending = '...';
nargs = arguments.length;
if ( nargs === 3 ) {
if ( isPlainObject( arguments[ 2 ] ) ) {
options = arguments[ 2 ];
} else if ( isString( arguments[ 2 ] ) ) {
ending = arguments[ 2 ];
} else {
throw new TypeError( format( 'invalid argument. Third argument must be either a string or an options object. Value: `%s`.', arguments[ 2 ] ) );
}
} else if ( nargs > 3 ) {
ending = arguments[ 2 ];
if ( !isString( ending ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be a string. Value: `%s`.', ending ) );
}
options = arguments[ 3 ];
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
}
if ( options ) {
if ( hasOwnProp( options, 'mode' ) ) {
opts.mode = options.mode;
if ( !isMode( opts.mode ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Value: `%s`.', 'mode', MODES.join( '", "' ), opts.mode ) );
}
}
}
return FCNS[ opts.mode ]( str, len, ending );
}
// EXPORTS //
module.exports = truncate;
|