@fav/text.snake-case

Converts a string into snake case.

"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

Install

To install from npm:

$ npm install --save @fav/text.snake-case

NOTE: npm < 2.7.0 does not support scoped package, but even old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/text.snake-case/ directory manually.

Usage

For Node.js:

var snakeCase = require('@fav/text.snake-case');
snakeCase('foo bar baz');  // => 'foo_bar_baz'
snakeCase('__FOO_BAR_BAZ__');  // => 'foo_bar_baz'
snakeCase('fooBarBaz');  // => 'foo_bar_baz'

For Web browsers:

<script src="fav.text.snake-case.min.js"></script>
<script>
var snakeCase = fav.text.snakeCase;
snakeCase('foo bar baz');  // => 'foo_bar_baz'
snakeCase('__FOO_BAR_BAZ__');  // => 'foo_bar_baz'
snakeCase('fooBarBaz');  // => 'foo_bar_baz'
</script>

API

snakeCase(text) : string

Converts a string into snake case.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

After splitting into words, this function joins them and creates a snake case string.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word. (At a result, this function returns a string converted into lower case, e.g. abc123).

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

| Parameter | Type | Description | |:----------|:------:|:-------------------------------------| | text | string | A string to be converted. |

Returns:

A string converted into snake case.

Type: string

snakeCase.split(text) : Array

Splits a string into alphanumeric words.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

| Parameter | Type | Description | |:----------|:------:|:-------------------------------------| | text | string | A string to be splitted. |

Returns:

An array of splitted words.

Type: Array

snakeCase.join(words) : string

Joins alphanumeric words and creates a snake case string.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

| Parameter | Type | Description | |:----------|:------:|:------------------------------------------------| | words | Array | An array of an alphanumeric words to be joined. |

Returns:

A snake case string.

Type: string

Checked

Node.js (4〜)

| Platform | 4 | 5 | 6 | 7 | 8 | 9 | 10 | |:---------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|◯|◯|

io.js (1〜3)

| Platform | 1 | 2 | 3 | |:---------:|:------:|:------:|:------:| | macOS |◯|◯|◯| | Windows10 |◯|◯|◯| | Linux |◯|◯|◯|

Node.js (〜0.12)

| Platform | 0.8 | 0.9 | 0.10 | 0.11 | 0.12 | |:---------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|

Web browsers

| Platform | Chrome | Firefox | Vivaldi | Safari | Edge | IE11 | |:---------:|:------:|:-------:|:-------:|:------:|:------:|:------:| | macOS |◯|◯ |◯ |◯| -- | -- | | Windows10 |◯|◯ |◯ | -- |◯|◯| | Linux |◯|◯ |◯ | -- | -- | -- |

License

Copyright (C) 2018 Takayuki Sato

This program is free software under MIT License. See the file LICENSE in this distribution for more details.