Functions for manipulating the letter case of strings.
\nFunctions for compressing (pack/unpack etc.) strings.
\nFunctions for mutilating strings.
\nFunctions for handle unicode stuff.
\nstringFlip the character bits of a string. The 16 character bits of 'A' are\n00000000 01000001 - if we flip the bits (so every 0 becomes 1 and vice\nversa) they look like this 11111111 10111110. This means that 'A'\n(U+0041) becomes 'ﾾ' (U+FFBE).
stringApplies toMANS to all characters with a random type.\nFor example 'Hello World' turns into '𝐇𝖾𝓵𝗹𝘰 𝔚𝗈𝒓𝔩𝔡'.
stringJumble the letters of all words in a string,\nexcept the first and last one, to keep it readable.
\nstringReverse the character bits of a string. The 16 character bits of 'A' are\n00000000 01000001 - if we reverse the bits they look like this\n10000010 00000000. This means that 'A' (U+0041) becomes '舀'\n(U+8200).
stringReverse a string.
\nstringCreate a heavy metal like rockdot string.
\nstringRotate the character indexes of a string by 13 digits.
\nstringRandomize the order of the characters in a string.
\nstringRotate the character bits of a string. The 16 character bits of 'A' are\n00000000 01000001 - if we shift the bits by -4 n digits they look like\nthis 00010000 00000100. This means that 'A' (U+0041) becomes 'င'\n(U+1004).
stringShift the characters of a string by n digits.
stringConvert A-Z to Mathematical Alphanumeric Symbols.
\nList of type values:
type | \nUnicode name | \n
|---|---|
| 0 | \nMathematical Bold * | \n
| 1 | \nMathematical Italic * | \n
| 2 | \nMathematical Bold Italic * | \n
| 3 | \nMathematical Script Capital * | \n
| 4 | \nMathematical Bold Script * | \n
| 5 | \nMathematical Fraktur * | \n
| 6 | \nMathematical Double-Struck * | \n
| 7 | \nMathematical Bold Fraktur * | \n
| 8 | \nMathematical Sans-Serif * | \n
| 9 | \nMathematical Sans-Serif Bold * | \n
| 10 | \nMathematical Sans-Serif Italic * | \n
| 11 | \nMathematical Sans-Serif Bold Italic * | \n
| 12 | \nMathematical Monospace * | \n
string\n * [~snakeCase(string)](#module_stringMutilator/charCase..snakeCase) ⇒ string\n * [~camelCase(string)](#module_stringMutilator/charCase..camelCase) ⇒ string\n * [~kebabCase(string)](#module_stringMutilator/charCase..kebabCase) ⇒ string\n * [~dotCase(string)](#module_stringMutilator/charCase..dotCase) ⇒ string\n * [~pascalCase(string)](#module_stringMutilator/charCase..pascalCase) ⇒ string\n * [~capitalize(string)](#module_stringMutilator/charCase..capitalize) ⇒ string\n\n\n\n### stringMutilator/charCase~invert(string, [every]) ⇒ string\nInvert the case of letters in a string.\n\n**Kind**: inner method of [stringMutilator/charCase](#module_stringMutilator/charCase) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| string | string | | The string to be case inverted. |\n| [every] | number | 0 | Only invert every `n` letter. |\n\n**Example** \n```js\nstringMutilator.charCase.invert('Hello World!');\n// > 'hELLO wORLD!'\n```\n\n\n### stringMutilator/charCase~snakeCase(string) ⇒ string\nChange the case of given string to \"Snake Case\".\n\n**Kind**: inner method of [stringMutilator/charCase](#module_stringMutilator/charCase) \n\n| Param | Type |\n| --- | --- |\n| string | string | \n\n**Example** \n```js\nstringMutilator.charCase.snakeCase('Hello World');\n// > 'hello_world'\n```\n\n\n### stringMutilator/charCase~camelCase(string) ⇒ string\nChange the case of the given string to \"Camel Case\".\n\n**Kind**: inner method of [stringMutilator/charCase](#module_stringMutilator/charCase) \n\n| Param | Type |\n| --- | --- |\n| string | string | \n\n**Example** \n```js\nstringMutilator.charCase.camelCase('Hello World');\n// > 'helloWorld'\n```\n\n\n### stringMutilator/charCase~kebabCase(string) ⇒ string\nChange the case of the given string to \"Kebap Case\".\n\n**Kind**: inner method of [stringMutilator/charCase](#module_stringMutilator/charCase) \n\n| Param | Type |\n| --- | --- |\n| string | string | \n\n**Example** \n```js\nstringMutilator.charCase.kebabCase('Hello World');\n// > 'hello-world'\n```\n\n\n### stringMutilator/charCase~dotCase(string) ⇒ string\nChange the case of the given string to \"Dot Case\".\n\n**Kind**: inner method of [stringMutilator/charCase](#module_stringMutilator/charCase) \n\n| Param | Type |\n| --- | --- |\n| string | string | \n\n**Example** \n```js\nstringMutilator.charCase.dotCase('Hello World');\n// > 'hello.world'\n```\n\n\n### stringMutilator/charCase~pascalCase(string) ⇒ string\nChange the case of the given string to \"Pascal Case\".\n\n**Kind**: inner method of [stringMutilator/charCase](#module_stringMutilator/charCase) \n\n| Param | Type |\n| --- | --- |\n| string | string | \n\n**Example** \n```js\nstringMutilator.charCase.pascalCase('Hello World');\n// > 'HelloWorld'\n```\n\n\n### stringMutilator/charCase~capitalize(string) ⇒ string\nChange the case of the given string to \"Capitalized\".\n\n**Kind**: inner method of [stringMutilator/charCase](#module_stringMutilator/charCase) \n\n| Param | Type |\n| --- | --- |\n| string | string | \n\n**Example** \n```js\nstringMutilator.charCase.capitalize('hello world');\n// > 'Hello World'\n```\n\n\n## stringMutilator/compressor\nFunctions for compressing (pack/unpack etc.) strings.\n\n\n* [stringMutilator/compressor](#module_stringMutilator/compressor)\n * [~pack(string)](#module_stringMutilator/compressor..pack) ⇒ string\n * [~unpack(string)](#module_stringMutilator/compressor..unpack) ⇒ string\n * [~signature(string, [withEval])](#module_stringMutilator/compressor..signature) ⇒ string\n\n\n\n### stringMutilator/compressor~pack(string) ⇒ string\nPack all characters of a 8-bit string.\n\n**Kind**: inner method of [stringMutilator/compressor](#module_stringMutilator/compressor) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | A 8-bit string to pack. |\n\n**Example** \n```js\nstringMutilator.compressor.pack('Hello World!');\n// > '䡥汬漠坯牬搡'\n```\n\n\n### stringMutilator/compressor~unpack(string) ⇒ string\nUnpack a packed string.\n\n**Kind**: inner method of [stringMutilator/compressor](#module_stringMutilator/compressor) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | The packed string to unpack. |\n\n**Example** \n```js\nstringMutilator.compressor.unpack('䡥汬漠坯牬搡');\n// > 'Hello World!'\n```\n\n\n### stringMutilator/compressor~signature(string, [withEval]) ⇒ string\nReturn the given, packed string with the unpack signature.\n\n**Kind**: inner method of [stringMutilator/compressor](#module_stringMutilator/compressor) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| string | string | | The packed string to signature. |\n| [withEval] | boolean | false | Determine if the result includes a `eval` command for executing code. |\n\n**Example** \n```js\nstringMutilator.compressor.signature('䡥汬漠坯牬搡');\n// > 'unescape(escape(\"䡥汬漠坯牬搡\").replace(/u(..)/g, \"$1%\");'\n```\n\n\n## stringMutilator\nFunctions for mutilating strings.\n\n\n\n## stringMutilator/unicode\nFunctions for handle unicode stuff.\n\n\n* [stringMutilator/unicode](#module_stringMutilator/unicode)\n * [~fixSurrogates(string)](#module_stringMutilator/unicode..fixSurrogates) ⇒ string\n * [~unfixSurrogates(string)](#module_stringMutilator/unicode..unfixSurrogates) ⇒ string\n\n\n\n### stringMutilator/unicode~fixSurrogates(string) ⇒ string\nFix unpaired high/low surrogates by adding a blank high/low surrogate\n(`U+D800` or `U+DC00`) to the designated location. An unpaired surrogate can\nlead to problems, for example by copying it to the clipboard could result in\na Replacement Character � (`U+FFFD`). For example if the string is\n`'\\uD801'` it will be altered to `'\\uD801\\uDC00'` (`'𐐀'`) or `'\\uDE80'` to\n`'\\uD800\\uDE80'` (`'𐊀'`).\n\n**Kind**: inner method of [stringMutilator/unicode](#module_stringMutilator/unicode) \n**See**: https://en.wikipedia.org/wiki/UTF-16#U+D800_to_U+DFFF \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | The input string |\n\n**Example** \n```js\nstringMutilator.unicode.fixSurrogates('Test: \\uD801 \\uDE80');\n// > 'Test: 𐐀 𐊀'\n```\n\n\n### stringMutilator/unicode~unfixSurrogates(string) ⇒ string\nRemove the by `fixSurrogates` added blank high/low surrogates.\n\n**Kind**: inner method of [stringMutilator/unicode](#module_stringMutilator/unicode) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | The input string |\n\n**Example** \n```js\nstringMutilator.unfixSurrogates('Test: 𐐀 𐊀');\n// > 'Test: \\uD801 \\uDE80'\n```\n\n\n## flipBits(string) ⇒ string\nFlip the character bits of a string. The 16 character bits of `'A'` are\n`00000000 01000001` - if we flip the bits (so every 0 becomes 1 and vice\nversa) they look like this `11111111 10111110`. This means that `'A'`\n(`U+0041`) becomes `'ﾾ'` (`U+FFBE`).\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | The input string. |\n\n**Example** \n```js\nstringMutilator.flipBits('Hello World!');\n// > 'ﾷﾚﾓﾓﾐﾨﾐﾍﾓﾛ'\n```\n\n\n## gobbledygook(string, [exclude]) ⇒ string\nApplies `toMANS` to all characters with a random `type`.\nFor example `'Hello World'` turns into `'𝐇𝖾𝓵𝗹𝘰 𝔚𝗈𝒓𝔩𝔡'`.\n\n**Kind**: global function \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| string | string | | The input string |\n| [exclude] | array | [ 1, 2 ] | Exclude specific `type` of `toMANS` |\n\n**Example** \n```js\nstringMutilator.gobbledygook('Hello World');\n// > 𝐇𝖾𝓵𝗹𝘰 𝔚𝗈𝒓𝔩𝔡\n```\n\n\n## jumble(string, [runs]) ⇒ string\nJumble the letters of all words in a string,\nexcept the first and last one, to keep it readable.\n\n**Kind**: global function \n**See**: https://www.mnn.com/lifestyle/arts-culture/stories/why-your-brain-can-read-jumbled-letters \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| string | string | | The input string. |\n| [runs] | number | 3 | The number of attempts to get a real randomized word string. |\n\n**Example** \n```js\nstringMutilator.jumble('Hello World!');\n// > 'Hlelo Wrlod!'\n```\n\n\n## reverseBits(string) ⇒ string\nReverse the character bits of a string. The 16 character bits of `'A'` are\n`00000000 01000001` - if we reverse the bits they look like this\n`10000010 00000000`. This means that `'A'` (`U+0041`) becomes `'舀'`\n(`U+8200`).\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | The input string. |\n\n**Example** \n```js\nstringMutilator.reverseBits('Hello World!');\n// > 'ሀꘀ㘀㘀Ѐ一㘀☀萀'\n```\n\n\n## reverse(string) ⇒ string\nReverse a string.\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | The input string. |\n\n**Example** \n```js\nstringMutilator.reverse('Hello World!');\n// > '!dlroW olleH'\n```\n\n\n## rockdotize(string, [regexp]) ⇒ string\nCreate a heavy metal like rockdot string.\n\n**Kind**: global function \n**See**\n\n- https://en.wikipedia.org/wiki/Metal_umlaut\n- https://github.com/bullgit/rockdotizer\n\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| string | string | | The string to rockdotize. |\n| [regexp] | RegExp | <RegExp /\\w/gi> | A RegExp to select every character that should get rockdotized. |\n\n**Example** \n```js\nstringMutilator.rockdotize('Hello World!');\n// > 'Ḧël̈l̈ö Ẅör̈l̈d̈!'\n```\n\n\n## rot13(string) ⇒ string\nRotate the character indexes of a string by 13 digits.\n\n**Kind**: global function \n**See**: https://en.wikipedia.org/wiki/ROT13 \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | The input string. |\n\n**Example** \n```js\nstringMutilator.rot13('Hello World!');\n// > 'Uryyb Jbeyq!'\n```\n\n\n## scramble(string) ⇒ string\nRandomize the order of the characters in a string.\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| string | string | The string to scramble. |\n\n**Example** \n```js\nstringMutilator.scramble('Hello World!');\n// > 'WorH!llo led'\n```\n\n\n## shiftBits(string, [n]) ⇒ string\nRotate the character bits of a string. The 16 character bits of `'A'` are\n`00000000 01000001` - if we shift the bits by -4 `n` digits they look like\nthis `00010000 00000100`. This means that `'A'` (`U+0041`) becomes `'င'`\n(`U+1004`).\n\n**Kind**: global function \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| string | string | | The input string. |\n| [n] | number | 1 | Number of digits to rotate the character bit. Positive for right rotation, negative for left rotation. |\n\n\n\n## shift(string, [n]) ⇒ string\nShift the characters of a string by `n` digits.\n\n**Kind**: global function \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| string | string | | The string to shift. |\n| [n] | number | 1 | Number of digits to rotate the characters. Positive for right rotation, negative for left rotation. |\n\n**Example** \n```js\nstringMutilator.shift('Hello World!', 3);\n// > 'lo World!Hel'\n```\n\n\n## toMANS(string, [type]) ⇒ string\nConvert A-Z to **M**athematical **A**lpha**n**umeric **S**ymbols.\n\nList of `type` values:\n\n| `type` | Unicode name |\n| --- | --- |\n| 0 | Mathematical Bold * |\n| 1 | Mathematical Italic * |\n| 2 | Mathematical Bold Italic * |\n| 3 | Mathematical Script Capital * |\n| 4 | Mathematical Bold Script * |\n| 5 | Mathematical Fraktur * |\n| 6 | Mathematical Double-Struck * |\n| 7 | Mathematical Bold Fraktur * |\n| 8 | Mathematical Sans-Serif * |\n| 9 | Mathematical Sans-Serif Bold * |\n| 10 | Mathematical Sans-Serif Italic * |\n| 11 | Mathematical Sans-Serif Bold Italic * |\n| 12 | Mathematical Monospace * |\n\n**Kind**: global function \n**See**: https://unicode-table.com/en/blocks/mathematical-alphanumeric-symbols \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| string | string | | The input string. |\n| [type] | number | 0 | A number between 0 and 12. |\n\n**Example** \n```js\nstringMutilator.toMANS('Hello World!', 1);\n// > '𝐻𝑒𝑙𝑙𝑜 𝑊𝑜𝑟𝑙𝑑.'\n```\n\n\n## Involutory functions\n\n> An [involutory function][involution], is a function f that is its own inverse.\n\n### List of involutory functions\n\n* [`flipBits`](#flipBits)\n* [`reverse`](#reverse)\n* [`reverseBits`](#reverseBits)\n* [`rot13`](#rot13)\n\n**Example**\n\n```js\nimport { rot13 } from '@0x04/string-mutilator';\n\nrot13(rot13('Hello World!')) === 'Hello World!';\n// > true\n```\n\n### List of involutory functions with negated arguments\n\n* [`charCase.invert`](#module_stringMutilator/charCase..invert)\n* [`shift`](#shift)\n* [`shiftBits`](#shiftBits)\n\n**Example**\n\n```js\nimport { shift } from '@0x04/string-mutilator';\n\nshift(shift('Hello World!', 5), -5) === 'Hello World!';\n// > true\n```\n\n### List of involutory functions with counter function\n\n* [`compressor.pack`](#module_stringMutilator/compressor..pack) / [`compressor.unpack`](#module_stringMutilator/compressor..unpack)\n* [`unicode.fixSurrogates`](#module_stringMutilator/unicode..fixSurrogates) / [`unicode.unfixSurrogates`](#module_stringMutilator/unicode..unfixSurrogates)\n\n**Examples**\n\n```js\nimport { compressor } from '@0x04/string-mutilator';\n\ncompressor.unpack(compressor.pack('Hello World!')) === 'Hello World!';\n// > true\n```\n\n### List of non involutory functions\n\n* [`compressor.signature`](#module_stringMutilator/compressor..signature)\n* [`gobbledygook`](#gobbledygook)\n* [`jumble`](#jumble)\n* [`rockdotize`](#rockdotize)\n* [`scramble`](#scramble)\n* [`toMANS`](#toMANS)\n\n```js\nimport { jumble } from '@0x04/string-mutilator';\n\njumble(jumble('Hello World!')) === 'Hello World!';\n// > false\n```\n\n\n## Using the CLI\n\n### Install\n\n**To use it in your project**\n\n```bash\n$ npm install --save @0x04/string-mutilator\n```\n\n**To use it globally**\n\n```bash\n$ npm install --global @0x04/string-mutilator\n```\n\n### General usage\n\n```plain\n$ string-mutilator --help\n\n Functions for mutilating strings.\n\n Usage\n $ string-mutilator