1.2.0 • Published 6 years ago

js-snakecase v1.2.0

Weekly downloads
335
License
ISC
Repository
github
Last release
6 years ago

js-snakecase

NPM version NPM downloads

JavaScript convert string to snake_case - Use for both Node.JS and Browser.

Installation

$ npm install --save js-snakecase

or

$ yarn add js-snakecase

Usage

Node.JS

const toSnakeCase = require('js-snakecase');

console.log(toSnakeCase('string')); // => string
console.log(toSnakeCase('camelCase')); // => camel_case
console.log(toSnakeCase('param-case')); // => param_case
console.log(toSnakeCase('PascalCase')); // => pascal_case
console.log(toSnakeCase('UPPER_CASE')); // => upper_case
console.log(toSnakeCase('snake_case')); // => snake_case
console.log(toSnakeCase('sentence case')); // => sentence_case
console.log(toSnakeCase('Title Case')); // => title_case
console.log(toSnakeCase('dot.case')); // => // dot_case

console.log(toSnakeCase('')); // => ''
console.log(toSnakeCase(null)); // => ''
console.log(toSnakeCase(undefined)); // => ''

console.log(toSnakeCase('Abc ___ 123 ___ xYz')); // => abc_123_x_yz
console.log(toSnakeCase('123__abc  ... ?// {#} def 12')); // => 123_abc_def_12
console.log(toSnakeCase('	tab space ??? ________')); // => tab_space
console.log(toSnakeCase('___?||123  abc|| 123..123')); // => 123_abc_123_123
console.log(toSnakeCase('!@#$%  {}|":;" ABC XyZ G123H')); // => abc_xy_z_g123h
console.log(toSnakeCase(' ^&* #DEFine x: 15 + ==')); // => define_x_15
console.log(toSnakeCase('123456789')); // => 123456789

Browser

1. NPM Package
<script src="./node_modules/js-snakecase/dist/js-snakecase.js"></script>
<!-- Or use minified -->
<script src="./node_modules/js-snakecase/dist/js-snakecase.min.js"></script>
2. Download from source
<script src="path/to/js-snakecase"></script>
Usage
<script>
	console.log(toSnakeCase('string')); // => string
	console.log(toSnakeCase('camelCase')); // => camel_case
	console.log(toSnakeCase('param-case')); // => param_case
	console.log(toSnakeCase('PascalCase')); // => pascal_case
	console.log(toSnakeCase('UPPER_CASE')); // => upper_case
	console.log(toSnakeCase('snake_case')); // => snake_case
	console.log(toSnakeCase('sentence case')); // => sentence_case
	console.log(toSnakeCase('Title Case')); // => title_case
	console.log(toSnakeCase('dot.case')); // => // dot_case

	console.log(toSnakeCase('')); // => ''
	console.log(toSnakeCase(null)); // => ''
	console.log(toSnakeCase(undefined)); // => ''

	console.log(toSnakeCase('Abc ___ 123 ___ xYz')); // => abc_123_x_yz
	console.log(toSnakeCase('123__abc  ... ?// {#} def 12')); // => 123_abc_def_12
	console.log(toSnakeCase('	tab space ??? ________')); // => tab_space
	console.log(toSnakeCase('___?||123  abc|| 123..123')); // => 123_abc_123_123
	console.log(toSnakeCase('!@#$%  {}|":;" ABC XyZ G123H')); // => abc_xy_z_g123h
	console.log(toSnakeCase(' ^&* #DEFine x: 15 + ==')); // => define_x_15
	console.log(toSnakeCase('123456789')); // => 123456789

</script>

API

toSnakeCase(str)

Returns a new string which is snakecase format of str.

Dependencies

No dependencies

Related