Update tests and benchmarks and add note

kgryte · kgryte · commit c78baf8ed299 · 2022-09-07T15:27:31.000-07:00
diff --git a/lib/node_modules/@stdlib/string/ends-with/README.md b/lib/node_modules/@stdlib/string/ends-with/README.md
@@ -86,6 +86,12 @@ var bool = endsWith( str, '' );
     // returns 2
     ```
 
+-   This function differs from [`String.prototype.endsWith`][mdn-string-endswith] in the following ways:
+
+    -   The function requires string values for the first and second arguments and requires that the `len` argument is an integer value.
+    -   The function does **not** clamp positive `len` values to the end of the input string.
+    -   Except when provided an empty `search` string, the function **always** returns `false` is a `len` resolves to a starting search position which exceeds the bounds of the input string.
+
 </section>
 
 <!-- /.notes -->
@@ -222,6 +228,8 @@ true
 
 [mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
 
+[mdn-string-endswith]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith
+
 <!-- <related-links> -->
 
 [@stdlib/string/starts-with]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/starts-with
diff --git a/lib/node_modules/@stdlib/string/ends-with/benchmark/benchmark.js b/lib/node_modules/@stdlib/string/ends-with/benchmark/benchmark.js
@@ -26,6 +26,13 @@ var pkg = require( './../package.json' ).name;
 var endsWith = require( './../lib' );
 
 
+// VARIABLES //
+
+var opts = {
+	'skip': typeof String.prototype.endsWith !== 'function'
+};
+
+
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
@@ -82,3 +89,58 @@ bench( pkg+'::substring', function benchmark( b ) {
 	b.pass( 'benchmark finished' );
 	b.end();
 });
+
+bench( pkg+'::builtin', opts, function benchmark( b ) {
+	var values;
+	var bool;
+	var str;
+	var i;
+
+	values = [
+		'.',
+		'z',
+		'questions'
+	];
+	str = 'To be, or not to be, that is the question.';
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		bool = str.endsWith( values[ i%values.length ] );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( bool ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::builtin,substring', opts, function benchmark( b ) {
+	var values;
+	var bool;
+	var str;
+	var i;
+
+	values = [
+		'.',
+		'z'
+	];
+	str = 'To be, or not to be, that is the question.';
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		bool = str.endsWith( values[ i%values.length ], i%42 );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( bool ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
diff --git a/lib/node_modules/@stdlib/string/ends-with/test/test.js b/lib/node_modules/@stdlib/string/ends-with/test/test.js
@@ -189,6 +189,12 @@ tape( 'the function returns `false` if provided a length parameter equal to `0`'
 	t.end();
 });
 
+tape( 'the function returns `false` if provided a length parameter which exceeds the input string length', function test( t ) {
+	var bool = endsWith( 'abcdef', 'f', 9999 );
+	t.strictEqual( bool, false, 'returns expected value' );
+	t.end();
+});
+
 tape( 'the function returns `false` if provided a search string which exceeds the input string length', function test( t ) {
 	var bool = endsWith( 'abc', 'abcd' );
 	t.strictEqual( bool, false, 'returns expected value' );
