Locked-down Games / node_modules / toidentifier / README.md
toidentifier
Convert a string of words to a JavaScript identifier
Install
This is a Node.js module available through the
npm registry. Installation is done using the
npm install
command:
$ npm install toidentifier
Example
var toIdentifier = require('toidentifier')
console.log(toIdentifier('Bad Request'))
// => "BadRequest"
API
This CommonJS module exports a single default function: toIdentifier
.
toIdentifier(string)
Given a string as the argument, it will be transformed according to the following rules and the new string will be returned:
- Split into words separated by space characters (
0x20
). - Upper case the first character of each word.
- Join the words together with no separator.
- Remove all non-word (
[0-9a-z_]
) characters.