@stdlib/assert/is-constantcase/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 constantcase = require( '@stdlib/string/base/constantcase' );


// MAIN //

/**
* Tests if a value is a constantcase string.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating whether a value is a constantcase string
*
* @example
* var bool = isConstantcase( 'BEEP_BOOP' );
* // returns true
*
* bool = isConstantcase( 'beep_boop' );
* // returns false
*
* bool = isConstantcase( 'BEEP-BOOP' );
* // returns true
*
* bool = isConstantcase( 'beep boop' );
* // returns false
*
* bool = isConstantcase( 'beep' );
* // returns false
*
* bool = isConstantcase( '' );
* // returns true
*
* bool = isConstantcase( null );
* // returns false
*/
function isConstantcase( value ) {
	return (
		isString( value ) &&
		value === constantcase( value )
	);
}


// EXPORTS //

module.exports = isConstantcase;