Test if a value is a string in snake case.
var isSnakecase = require( '@stdlib/assert/is-snakecase' );Tests if a value is a string in snake case.
var bool = isSnakecase( 'hello_world' );
// returns true
bool = isSnakecase( 'Hello World' );
// returns false- The function validates that a
valueis astring. For all other types, the function returnsfalse.
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 falseUsage: is-snakecase [options] [<string>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
-
If the split separator is a regular expression, ensure that the
splitoption is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n $'beEp booP\nfoo_bar' | is-snakecase --split /\r?\n/ # Escaped... $ echo -n $'beEp booP\nfoo_bar' | is-snakecase --split /\\r?\\n/
-
The implementation ignores trailing delimiters.
$ is-snakecase foo_bar
trueTo use as a standard stream,
$ echo -n 'fooBar' | is-snakecase
falseBy default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.
$ echo -n 'fooBar\tbeep_boop' | is-snakecase --split '\t'
false
true