All files / assert/is-snakecase/lib main.js

100% Statements 62/62
100% Branches 3/3
100% Functions 1/1
100% Lines 62/62

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 6310x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 29x 29x 29x 10x 10x 10x 10x 10x  
/**
* @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( '@stdlib/assert/is-string' ).isPrimitive;
var snakecase = require( '@stdlib/string/base/snakecase' );
 
 
// MAIN //
 
/**
* Tests if a value is a string in snake case.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating whether a value is a string in snake case
*
* @example
* var bool = isSnakecase( 'hello_world' );
* // returns true
*
* @example
* var bool = isSnakecase( 'Hello World' );
* // returns false
*
* @example
* var bool = isSnakecase( 'Hello_World' );
* // returns false
*
* @example
* var bool = isSnakecase( '' );
* // returns true
*
* @example
* var bool = isSnakecase( null );
* // returns false
*/
function isSnakecase( value ) {
	return ( isString( value ) && snakecase( value ) === value );
}
 
 
// EXPORTS //
 
module.exports = isSnakecase;