@stdlib/assert/is-startcase/lib/main.js

Standard assertion utilities.

/**
* @license Apache-2.0
*
* Copyright (c) 2022 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 isString = require( './../../is-string' ).isPrimitive;
var startcase = require( '@stdlib/string/base/startcase' );


// MAIN //

/**
* Tests if a value is a startcase string (i.e., the first character of each word is uppercase).
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating if a value is a startcase string
*
* @example
* var bool = isStartcase( 'Beep Boop' );
* // returns true
*
* bool = isStartcase( 'beep boop' );
* // returns false
*
* bool = isStartcase( 'beep and boop' );
* // returns false
*/
function isStartcase( value ) {
	return ( isString( value ) && startcase( value ) === value );
}


// EXPORTS //

module.exports = isStartcase;