feat: refactor truncate string package

lib/node_modules/@stdlib/string/base/truncate-code-points/README.md

@@ -0,0 +1,99 @@
+<!--
+
+@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.
+
+-->
+
+# truncateCodePoints
+
+> Truncate the code points of a provided string in order to return a string having a specified length.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var truncateCodePoints = require( '@stdlib/string/base/truncate-code-points' );
+```
+
+#### truncateCodePoints( str, len, ending )
+
+Truncates the code points of a provided string in order to return a string having a specified length.
+
+```javascript
+var out = truncateCodePoints( 'beep boop', 7, '...' );
+// returns 'beep...'
+```
+
+By default, the truncated string is appended with `'...'`. To customize the truncated string, provide an `ending` argument:
+
+```javascript
+var out = truncateCodePoints( 'beep boop', 7, '!' );
+// returns 'beep b!'
+
+out = truncateCodePoints( 'beep boop', 7, '!!!' );
+// returns 'beep!!!'
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var truncateCodePoints = require( '@stdlib/string/base/truncate-code-points' );
+
+var str = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
+var out = truncateCodePoints( str, 14, '...' );
+// returns 'Lorem ipsum...'
+
+str = 'To be or not to be, that is the question';
+out = truncateCodePoints( str, 19, '!' );
+// returns 'To be or not to be!'
+
+str = 'The quick fox jumps over the lazy dog.';
+out = truncateCodePoints( str, 16, '...' );
+// returns 'The quick fox...'
+
+out = truncateCodePoints( 'अनुच्छेद', 7, '...' );
+// returns 'अनुच...'
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/string/base/truncate-code-points/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 truncate = 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 = truncate( values[ i%values.length ], 1, '...' );
+		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();
+});

lib/node_modules/@stdlib/string/base/truncate-code-points/docs/repl.txt

@@ -0,0 +1,33 @@
+
+{{alias}}( str, len, ending )
+    Truncate the code points of a provided string in order to return a string
+    having a specified length.
+
+    Parameters
+    ----------
+    str: string
+        Input string.
+
+    len: integer
+        Output string length.
+
+    ending: string
+        Custom ending.
+
+    Returns
+    -------
+    out: string
+        Output string.
+
+    Examples
+    --------
+    > var str = 'beep boop';
+    > var out = {{alias}}( str, 5, '...' )
+    'be...'
+
+    > out = {{alias}}( str, 5, '|' )
+    'beep|'
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/string/base/truncate-code-points/docs/types/index.d.ts

@@ -0,0 +1,42 @@
+/*
+* @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: 2.0
+
+/**
+* Truncate the code points of a provided string in order to return a string having a specified length.
+*
+* @param str - input string
+* @param len - output string length (including ending)
+* @param ending - custom ending
+* @returns truncated string
+*
+* @example
+* var out = truncate( 'beep boop', 7, '...' );
+* // returns 'beep...'
+*
+* @example
+* var out = truncate( 'beep boop', 7, '|' );
+* // returns 'beep b|'
+*/
+declare function truncate( str: string, len: number, ending: string ): string;
+
+
+// EXPORTS //
+
+export = truncate;

lib/node_modules/@stdlib/string/base/truncate-code-points/docs/types/test.ts

@@ -0,0 +1,68 @@
+/*
+* @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 truncate = require( './index' );
+
+
+// TESTS //
+
+// The function returns a string...
+{
+	truncate( 'abcdefghi', 10, '|' ); // $ExpectType string
+}
+
+// The compiler throws an error if the function is provided a value other than a string as its first argument...
+{
+	truncate( true, 1, '...' ); // $ExpectError
+	truncate( false, 1, '...' ); // $ExpectError
+	truncate( null, 1, '...' ); // $ExpectError
+	truncate( undefined, 1, '...' ); // $ExpectError
+	truncate( 5, 1, '...' ); // $ExpectError
+	truncate( [], 1, '...' ); // $ExpectError
+	truncate( {}, 1, '...' ); // $ExpectError
+	truncate( ( x: number ): number => x, 1, '...' ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument that is not a number...
+{
+	truncate( 'abc', true, '...' ); // $ExpectError
+	truncate( 'abc', false, '...' ); // $ExpectError
+	truncate( 'abc', null, '...' ); // $ExpectError
+	truncate( 'abc', 'abc', '...' ); // $ExpectError
+	truncate( 'abc', [], '...' ); // $ExpectError
+	truncate( 'abc', {}, '...' ); // $ExpectError
+	truncate( 'abc', ( x: number ): number => x, '...' ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a third argument that is not a string...
+{
+	truncate( 'beep boop', 4, true ); // $ExpectError
+	truncate( 'beep boop', 4, false ); // $ExpectError
+	truncate( 'beep boop', 4, null ); // $ExpectError
+	truncate( 'beep boop', 4, 123 ); // $ExpectError
+	truncate( 'beep boop', 4, [], 0 ); // $ExpectError
+	truncate( 'beep boop', 4, {}, 0 ); // $ExpectError
+	truncate( 'beep boop', 4, ( x: number ): number => x, 0 ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	truncate(); // $ExpectError
+	truncate( 'abc' ); // $ExpectError
+	truncate( 'abc', 1, '.', true ); // $ExpectError
+}

lib/node_modules/@stdlib/string/base/truncate-code-points/examples/index.js

@@ -0,0 +1,41 @@
+/**
+* @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 truncate = require( './../lib' );
+
+var str = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
+var out = truncate( str, 14, '...' );
+console.log( out );
+// => 'Lorem ipsum...'
+
+str = 'To be or not to be, that is the question';
+out = truncate( str, 19, '!' );
+console.log( out );
+// => 'To be or not to be!'
+
+str = 'The quick fox jumps over the lazy dog.';
+out = truncate( str, 16, '...' );
+console.log( out );
+// => 'The quick fox...'
+
+str = 'अनुच्छेद';
+out = truncate( str, 7, '...' );
+console.log( out );
+// => 'अनुच...'

lib/node_modules/@stdlib/string/base/truncate-code-points/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 code points of a provided string in order to return a string having a specified length.
+*
+* @module @stdlib/string/base/truncate-code-points
+*
+* @example
+* var truncate = require( '@stdlib/string/base/truncate-code-points' );
+*
+* var out = truncate( 'beep boop', 7, '...' );
+* // returns 'beep...'
+*
+* out = truncate( 'beep boop', 7, '|' );
+* // returns 'beep b|'
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;