Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -1 +1 @@
-2022-09-01T00:43:32.321Z
+2022-10-01T01:08:01.047Z

README.md

@@ -58,7 +58,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' );

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' );
 		}
 	}

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
     ----------

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' );

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
 }

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'
 

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;

lib/startcase.js renamed to lib/main.js

@@ -21,8 +21,8 @@
 // MODULES //
 
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
-var reWhitespace = require( '@stdlib/regexp-whitespace' );
 var format = require( '@stdlib/string-format' );
+var base = require( '@stdlib/string-base-startcase' );
 
 
 // MAIN //
@@ -39,28 +39,10 @@ var format = require( '@stdlib/string-format' );
 * // returns 'Beep Boop Foo Bar'
 */
 function startcase( str ) {
-	var cap;
-	var out;
-	var ch;
-	var i;
 	if ( !isString( str ) ) {
 		throw new TypeError( format( 'invalid argument. Must provide a string. Value: `%s`.', str ) );
 	}
-	cap = true;
-	out = '';
-	for ( i = 0; i < str.length; i++ ) {
-		ch = str.charAt( i );
-		if ( reWhitespace.REGEXP.test( ch ) ) {
-			out += ch;
-			cap = true;
-		} else if ( cap ) {
-			out += ch.toUpperCase();
-			cap = false;
-		} else {
-			out += ch;
-		}
-	}
-	return out;
+	return base( str );
 }
 
 

package.json

@@ -44,16 +44,15 @@
     "@stdlib/cli-ctor": "^0.0.x",
     "@stdlib/fs-read-file": "^0.0.x",
     "@stdlib/process-read-stdin": "^0.0.x",
-    "@stdlib/regexp-whitespace": "^0.0.x",
     "@stdlib/streams-node-stdin": "^0.0.x",
+    "@stdlib/string-base-startcase": "^0.0.x",
     "@stdlib/string-format": "^0.0.x"
   },
   "devDependencies": {
     "@stdlib/assert-is-browser": "^0.0.x",
     "@stdlib/assert-is-windows": "^0.0.x",
     "@stdlib/bench": "^0.0.x",
     "@stdlib/process-exec-path": "^0.0.x",
-    "@stdlib/string-from-code-point": "^0.0.x",
     "@stdlib/string-replace": "^0.0.x",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "proxyquire": "^2.0.0",

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() {}