isSnakecase

Test if a value is a string in snake case.

Installation

npm install @stdlib/assert-is-snakecase

Usage

var isSnakecase = require( '@stdlib/assert-is-snakecase' );

isSnakecase( value )

Tests if a value is a string in snake case.

var bool = isSnakecase( 'hello_world' );
// returns true

bool = isSnakecase( 'Hello World' );
// returns false

Notes

• The function validates that a value is a string. For all other types, the function returns false.

Examples

var isSnakecase = require( '@stdlib/assert-is-snakecase' );

var bool = isSnakecase( 'foo_bar_baz' );
// returns true

bool = isSnakecase( 'FOO_BAR' );
// returns false

bool = isSnakecase( 'fooBar' );
// returns false

bool = isSnakecase( 'beep-boop' );
// returns false

bool = isSnakecase( null );
// returns false

See Also

• @stdlib/assert-is-snakecase-cli: CLI package for use as a command-line utility.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.