Rename file and clean-up

kgryte · kgryte · commit 45f7fe74fdc7 · 2022-09-07T12:18:11.000-07:00
diff --git a/lib/node_modules/@stdlib/string/startcase/README.md b/lib/node_modules/@stdlib/string/startcase/README.md
@@ -38,7 +38,7 @@ var startcase = require( '@stdlib/string/startcase' );
 
 #### startcase( str )
 
-Capitalizes the first letter of each word in a `string`.
+Capitalizes the first letter of each word in a string.
 
 ```javascript
 var str = startcase( 'beep boop a foo bar' );
diff --git a/lib/node_modules/@stdlib/string/startcase/benchmark/benchmark.js b/lib/node_modules/@stdlib/string/startcase/benchmark/benchmark.js
@@ -22,23 +22,27 @@
 
 var bench = require( '@stdlib/bench' );
 var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
-var fromCodePoint = require( '@stdlib/string/from-code-point' );
 var pkg = require( './../package.json' ).name;
 var startcase = require( './../lib' );
 
 
 // MAIN //
 
 bench( pkg, function benchmark( b ) {
-	var str;
+	var values;
 	var out;
 	var i;
 
+	values = [
+		'beep boop',
+		'foo bar',
+		'xyz abc'
+	];
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		str = fromCodePoint( i%126 ) + 'eep boop foo bar tic toc';
-		out = startcase( str );
-		if ( !isString( out ) ) {
+		out = startcase( values[ i%values.length ] );
+		if ( typeof out !== 'string' ) {
 			b.fail( 'should return a string' );
 		}
 	}
diff --git a/lib/node_modules/@stdlib/string/startcase/docs/repl.txt b/lib/node_modules/@stdlib/string/startcase/docs/repl.txt
@@ -1,6 +1,6 @@
 
 {{alias}}( str )
-    Capitalizes the first letter of each word in an input `string`.
+    Capitalizes the first letter of each word in an input string.
 
     Parameters
     ----------
diff --git a/lib/node_modules/@stdlib/string/startcase/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/startcase/docs/types/index.d.ts
@@ -22,7 +22,7 @@
 * Capitalizes the first letter of each word in an input string.
 *
 * @param str - string to convert
-* @returns start case string
+* @returns start-cased string
 *
 * @example
 * var str = startcase( 'beep boop foo bar' );
diff --git a/lib/node_modules/@stdlib/string/startcase/docs/types/test.ts b/lib/node_modules/@stdlib/string/startcase/docs/types/test.ts
@@ -26,7 +26,7 @@ import startcase = require( './index' );
 	startcase( 'Last man standing' ); // $ExpectType string
 }
 
-// The function does not compile if provided a value other than a string...
+// The compiler throws an error if the function is provided a value other than a string...
 {
 	startcase( true ); // $ExpectError
 	startcase( false ); // $ExpectError
@@ -38,7 +38,7 @@ import startcase = require( './index' );
 	startcase( ( x: number ): number => x ); // $ExpectError
 }
 
-// The function does not compile if provided insufficient arguments...
+// The compiler throws an error if the function is provided insufficient arguments...
 {
 	startcase(); // $ExpectError
 }
diff --git a/lib/node_modules/@stdlib/string/startcase/examples/index.js b/lib/node_modules/@stdlib/string/startcase/examples/index.js
@@ -20,9 +20,7 @@
 
 var startcase = require( './../lib' );
 
-var str;
-
-str = startcase( 'beep boop foo bar' );
+var str = startcase( 'beep boop foo bar' );
 console.log( str );
 // => 'Beep Boop Foo Bar'
 
diff --git a/lib/node_modules/@stdlib/string/startcase/lib/index.js b/lib/node_modules/@stdlib/string/startcase/lib/index.js
@@ -32,9 +32,9 @@
 
 // MODULES //
 
-var startcase = require( './startcase.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = startcase;
+module.exports = main;
diff --git a/lib/node_modules/@stdlib/string/startcase/lib/main.js b/lib/node_modules/@stdlib/string/startcase/lib/main.js
@@ -21,7 +21,7 @@
 // MODULES //
 
 var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
-var reWhitespace = require( '@stdlib/regexp/whitespace' );
+var reWhitespace = require( '@stdlib/regexp/whitespace' ).REGEXP;
 var format = require( '@stdlib/string/format' );
 
 
@@ -50,7 +50,7 @@ function startcase( str ) {
 	out = '';
 	for ( i = 0; i < str.length; i++ ) {
 		ch = str.charAt( i );
-		if ( reWhitespace.REGEXP.test( ch ) ) {
+		if ( reWhitespace.test( ch ) ) {
 			out += ch;
 			cap = true;
 		} else if ( cap ) {
diff --git a/lib/node_modules/@stdlib/string/startcase/test/test.js b/lib/node_modules/@stdlib/string/startcase/test/test.js
@@ -32,7 +32,7 @@ tape( 'main export is a function', function test( t ) {
 	t.end();
 });
 
-tape( 'the function throws an error if not provided a primitive string', function test( t ) {
+tape( 'the function throws an error if not provided a string', function test( t ) {
 	var values;
 	var i;
 
@@ -42,6 +42,7 @@ tape( 'the function throws an error if not provided a primitive string', functio
 		null,
 		void 0,
 		true,
+		false,
 		[],
 		{},
 		function noop() {}

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`* Capitalizes the first letter of each word in an input string.`
`23`	`23`	`*`
`24`	`24`	`* @param str - string to convert`
`25`		`-* @returns start case string`
	`25`	`+* @returns start-cased string`
`26`	`26`	`*`
`27`	`27`	`* @example`
`28`	`28`	`* var str = startcase( 'beep boop foo bar' );`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import startcase = require( './index' );`
`26`	`26`	`startcase( 'Last man standing' ); // $ExpectType string`
`27`	`27`	`}`
`28`	`28`
`29`		`-// The function does not compile if provided a value other than a string...`
	`29`	`+// The compiler throws an error if the function is provided a value other than a string...`
`30`	`30`	`{`
`31`	`31`	`startcase( true ); // $ExpectError`
`32`	`32`	`startcase( false ); // $ExpectError`
`@@ -38,7 +38,7 @@ import startcase = require( './index' );`
`38`	`38`	`startcase( ( x: number ): number => x ); // $ExpectError`
`39`	`39`	`}`
`40`	`40`
`41`		`-// The function does not compile if provided insufficient arguments...`
	`41`	`+// The compiler throws an error if the function is provided insufficient arguments...`
`42`	`42`	`{`
`43`	`43`	`startcase(); // $ExpectError`
`44`	`44`	`}`