diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/README.md b/lib/node_modules/@stdlib/string/base/truncate-middle/README.md new file mode 100644 index 00000000000..3f50acde855 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/README.md @@ -0,0 +1,92 @@ + + +# truncateMiddle + +> Truncate the middle UTF-16 code units of a string to return a string having a specified length. + +
+ +## Usage + +```javascript +var truncateMiddle = require( '@stdlib/string/base/truncate-middle' ); +``` + +#### truncateMiddle( str, len, seq ) + +Truncates the middle UTF-16 code units of a string to return a string having a specified length. + +```javascript +var out = truncateMiddle( 'beep boop', 7, '...' ); +// returns 'be...op' + +out = truncateMiddle( 'beep boop', 7, '!' ); +// returns 'bee!oop' + +out = truncateMiddle( 'beep boop', 7, '!!!' ); +// returns 'be!!!op' +``` + +
+ + + +
+ +## Examples + + + +```javascript +var truncateMiddle = require( '@stdlib/string/base/truncate-middle' ); + +var str = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'; +var out = truncateMiddle( str, 15, '...' ); +// returns 'Lorem ... elit.' + +str = 'To be or not to be, that is the question'; +out = truncateMiddle( str, 19, '|' ); +// returns 'To be or | question' + +str = 'The quick fox jumps over the lazy dog.'; +out = truncateMiddle( str, 28, '...' ); +// returns 'The quick fox...he lazy dog.' +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/benchmark/benchmark.js b/lib/node_modules/@stdlib/string/base/truncate-middle/benchmark/benchmark.js new file mode 100644 index 00000000000..6da36d6bd77 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/benchmark/benchmark.js @@ -0,0 +1,56 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 bench = require( '@stdlib/bench' ); +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var pkg = require( './../package.json' ).name; +var truncateMiddle = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var values; + var out; + var i; + + values = [ + 'beep boop', + 'foo bar', + 'xyz abc', + '🐶🐮🐷🐰🐸' + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = truncateMiddle( values[ i%values.length ], 7, '...' ); + if ( typeof out !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( !isString( out ) ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/docs/repl.txt b/lib/node_modules/@stdlib/string/base/truncate-middle/docs/repl.txt new file mode 100644 index 00000000000..39ca0eb420c --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/docs/repl.txt @@ -0,0 +1,31 @@ + +{{alias}}( str, len, seq ) + Truncates the middle UTF-16 code units of a string to return a string + having a specified length. + + Parameters + ---------- + str: string + Input string. + + len: integer + Output string length. + + seq: string + Custom replacement sequence. + + Returns + ------- + out: string + Truncated string. + + Examples + -------- + > var str = 'beep boop'; + > var out = {{alias}}( str, 5, '...' ) + 'b...p' + > out = {{alias}}( str, 5, '|' ) + 'be|op' + + See Also + -------- diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/base/truncate-middle/docs/types/index.d.ts new file mode 100644 index 00000000000..712847d96f1 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/docs/types/index.d.ts @@ -0,0 +1,59 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2023 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: 4.1 + +/** +* Truncates the middle UTF-16 code units of a string to return a string having a specified length. +* +* @param str - input string +* @param len - output string length (including sequence) +* @param seq - custom replacement sequence +* @returns truncated string +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 5, '...' ); +* // returns 'b...p' +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 5, '>>>' ); +* // returns 'b>>>p' +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 10, '...' ); +* // returns 'beep boop' +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 0, '...' ); +* // returns '' +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 2, '...' ); +* // returns '..' +*/ +declare function truncateMiddle( str: string, len: number, seq: string ): string; + + +// EXPORTS // + +export = truncateMiddle; diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/docs/types/test.ts b/lib/node_modules/@stdlib/string/base/truncate-middle/docs/types/test.ts new file mode 100644 index 00000000000..f7c6020e702 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/docs/types/test.ts @@ -0,0 +1,63 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2023 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. +*/ + +import truncateMiddle = require( './index' ); + + +// TESTS // + +// The function returns a string... +{ + truncateMiddle( 'abcdefghi', 3, '...' ); // $ExpectType string +} + +// The compiler throws an error if the function is not provided a string as its first argument... +{ + truncateMiddle( true, 6, '...' ); // $ExpectError + truncateMiddle( false, 6, '...' ); // $ExpectError + truncateMiddle( 3, 6, '...' ); // $ExpectError + truncateMiddle( [], 6, '...' ); // $ExpectError + truncateMiddle( {}, 6, '...' ); // $ExpectError + truncateMiddle( ( x: number ): number => x, 6, '...' ); // $ExpectError +} + +// The compiler throws an error if the function is not provided a number as its second argument... +{ + truncateMiddle( 'abd', true, '...' ); // $ExpectError + truncateMiddle( 'abd', false, '...' ); // $ExpectError + truncateMiddle( 'abd', 'abc', '...' ); // $ExpectError + truncateMiddle( 'abd', [], '...' ); // $ExpectError + truncateMiddle( 'abd', {}, '...' ); // $ExpectError + truncateMiddle( 'abd', ( x: number ): number => x, '...' ); // $ExpectError +} + +// The compiler throws an error if the function is not provided a string as its third argument... +{ + truncateMiddle( 'beep boop', 4, true ); // $ExpectError + truncateMiddle( 'beep boop', 4, false ); // $ExpectError + truncateMiddle( 'beep boop', 4, 123 ); // $ExpectError + truncateMiddle( 'beep boop', 4, [], 0 ); // $ExpectError + truncateMiddle( 'beep boop', 4, {}, 0 ); // $ExpectError + truncateMiddle( 'beep boop', 4, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + truncateMiddle(); // $ExpectError + truncateMiddle( 'abc', 4, '|', true ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/examples/index.js b/lib/node_modules/@stdlib/string/base/truncate-middle/examples/index.js new file mode 100644 index 00000000000..50d16125b27 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/examples/index.js @@ -0,0 +1,36 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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'; + +var truncateMiddle = require( './../lib' ); + +var str = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'; +var out = truncateMiddle( str, 15, '...' ); +console.log( out ); +// => 'Lorem ... elit.' + +str = 'To be or not to be, that is the question'; +out = truncateMiddle( str, 19, '|' ); +console.log( out ); +// => 'To be or | question' + +str = 'The quick fox jumps over the lazy dog.'; +out = truncateMiddle( str, 28, '...' ); +console.log( out ); +// => 'The quick fox...he lazy dog.' diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/lib/index.js b/lib/node_modules/@stdlib/string/base/truncate-middle/lib/index.js new file mode 100644 index 00000000000..4690cc0cb53 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/lib/index.js @@ -0,0 +1,43 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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'; + +/** +* Truncate the middle UTF-16 code units of a string to return a string having a specified length. +* +* @module @stdlib/string/base/truncate-middle +* +* @example +* var truncateMiddle = require( '@stdlib/string/base/truncate-middle' ); +* +* var out = truncateMiddle( 'beep boop', 7, '...' ); +* // returns 'be...op' +* +* out = truncateMiddle( 'beep boop', 7, '|' ); +* // returns 'bee|oop' +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/lib/main.js b/lib/node_modules/@stdlib/string/base/truncate-middle/lib/main.js new file mode 100644 index 00000000000..19525c71a34 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/lib/main.js @@ -0,0 +1,89 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 isOdd = require( '@stdlib/math/base/assert/is-odd' ); +var round = require( '@stdlib/math/base/special/round' ); + + +// MAIN // + +/** +* Truncates the middle UTF-16 code units of a string to return a string having a specified length. +* +* @param {string} str - input string +* @param {integer} len - output string length (including sequence) +* @param {string} seq - custom replacement sequence +* @returns {string} truncated string +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 5, '...' ); +* // returns 'b...p' +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 5, '>>>' ); +* // returns 'b>>>p' +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 10, '...' ); +* // returns 'beep boop' +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 0, '...' ); +* // returns '' +* +* @example +* var str = 'beep boop'; +* var out = truncateMiddle( str, 2, '...' ); +* // returns '..' +*/ +function truncateMiddle( str, len, seq ) { + var finalLength; + var seqLength; + var strLength; + var seqStart; + var seqEnd; + + seqLength = seq.length; + strLength = str.length; + if ( len > strLength ) { + return str; + } + finalLength = len - seqLength; + if ( finalLength < 0 ) { + return seq.slice( 0, len ); + } + + seqStart = round( finalLength / 2 ); + seqEnd = ( isOdd( finalLength ) ) ? seqStart-1 : seqStart; + seqEnd = strLength - seqEnd; + + return str.substring( 0, seqStart ) + seq + str.substring( seqEnd ); +} + + +// EXPORTS // + +module.exports = truncateMiddle; diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/package.json b/lib/node_modules/@stdlib/string/base/truncate-middle/package.json new file mode 100644 index 00000000000..490b3e3a475 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/package.json @@ -0,0 +1,68 @@ +{ + "name": "@stdlib/string/base/truncate-middle", + "version": "0.0.0", + "description": "Truncate the middle UTF-16 code units of a string to return a string having a specified length.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdstring", + "utilities", + "utility", + "utils", + "util", + "string", + "str", + "base", + "truncate", + "middle", + "character", + "char", + "codeunit", + "unicode" + ] +} diff --git a/lib/node_modules/@stdlib/string/base/truncate-middle/test/test.js b/lib/node_modules/@stdlib/string/base/truncate-middle/test/test.js new file mode 100644 index 00000000000..0ba15ad10b5 --- /dev/null +++ b/lib/node_modules/@stdlib/string/base/truncate-middle/test/test.js @@ -0,0 +1,93 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 tape = require( 'tape' ); +var truncateMiddle = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof truncateMiddle, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function truncates a string to the specified length', function test( t ) { + var expected; + var actual; + var str; + var len; + + str = 'beep boop'; + len = 5; + expected = 'b...p'; + actual = truncateMiddle( str, len, '...' ); + t.strictEqual( actual, expected, 'returns expected value' ); + + str = 'beep boop'; + len = 10; + expected = 'beep boop'; + actual = truncateMiddle( str, len, '...' ); + t.strictEqual( actual, expected, 'returns expected value' ); + + str = 'beep boop'; + len = 0; + expected = ''; + actual = truncateMiddle( str, len, '...' ); + t.strictEqual( actual, expected, 'returns expected value' ); + + str = 'beep boop'; + len = 1; + expected = '.'; + actual = truncateMiddle( str, len, '...' ); + t.strictEqual( actual, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function truncates a string to the specified length (custom replacement sequence)', function test( t ) { + var expected; + var actual; + var str; + var len; + + str = 'beep boop'; + len = 5; + expected = 'be|op'; + actual = truncateMiddle( str, len, '|' ); + t.strictEqual( actual, expected, 'returns expected value' ); + + str = 'beep boop'; + len = 7; + expected = 'bee!oop'; + actual = truncateMiddle( str, len, '!' ); + t.strictEqual( actual, expected, 'returns expected value' ); + + str = 'beep boop'; + len = 3; + expected = 'b!p'; + actual = truncateMiddle( str, len, '!' ); + t.strictEqual( actual, expected, 'returns expected value' ); + + t.end(); +});