safe-strings

A collection of unicode-safe string functions inspired by other programming languages.

Installation

Install using NPM:

``shell
$ npm i safe-strings
`

Usage

Import specific functions:

`js
const { center, capwords } = require('safe-strings');

center('my string', 20);
capwords('this is a test');
`

Import the entire library:

`js
const stringUtil = require('safe-strings');

stringUtil.center('my string', 20);
stringUtil.capwords('this is a test');
``

Functions

length(string) ⇒ number

Get string length with unicode support

split(string, [separator]) ⇒ Array.<string>

Return an array of strings split by the separator.

ljust(string, width, [fillChar]) ⇒ string

Left-justify a string in a field of given width.

rjust(string, width, [fillChar]) ⇒ string

Right-justify a string in a field of given width.

center(string, width, [fillChar]) ⇒ string

Center a string in a field of given width.

strip(string, [trimChar]) ⇒ string

Return a copy of the string with leading and trailing characters removed.

lstrip(string, [trimChar]) ⇒ string

Return a copy of the string with leading characters removed.

rstrip(string, [trimChar]) ⇒ string

Return a copy of the string with trailing characters removed.

swapcase(string) ⇒ string

Return a copy of the string with lower case letters converted to upper case and vice versa.

capwords(string, [separator]) ⇒ string

Return a copy of the string with the first char of each separated word converted to upper case.

ucfirst(string) ⇒ string

Return a copy of the string with the first char converted to upper case.

lcfirst(string) ⇒ string

Return a copy of the string with the first char converted to lower case.

nl2br(string, [breakElement]) ⇒ string

Return a copy of the string with HTML line breaks (
) inserted before all newlines.

expandtabs(string, [tabsize]) ⇒ string

Return a copy of the string with tab chars (\t) replaced by spaces.

length(string) ⇒ number

Get string length with unicode support

Kind: global function
Returns: number - The length of the string.

| Param | Description |
| --- | --- |
| string | The input string. |

split(string, [separator]) ⇒ Array.<string>

Return an array of strings split by the separator.

Kind: global function
Returns: Array.<string> - An array of split strings.

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| [separator] | string | "" | The separator char. |

ljust(string, width, [fillChar]) ⇒ string

Left-justify a string in a field of given width.

Kind: global function
Returns: string - The padded string.

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| width | number | | The length of the resulting string once. |
| [fillChar] | string | " " | The character used to pad the string. |

rjust(string, width, [fillChar]) ⇒ string

Right-justify a string in a field of given width.

Kind: global function
Returns: string - The padded string.

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| width | number | | The length of the resulting string once. |
| [fillChar] | string | " " | The character used to pad the string. |

center(string, width, [fillChar]) ⇒ string

Center a string in a field of given width.

Kind: global function
Returns: string - The padded string.

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| width | number | | The length of the resulting string once. |
| [fillChar] | string | " " | The character used to pad the string. |

strip(string, [trimChar]) ⇒ string

Return a copy of the string with leading and trailing characters removed.

Kind: global function
Returns: string - The string with characters removed.

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| [trimChar] | string | " " | The character to be removed. |

lstrip(string, [trimChar]) ⇒ string

Return a copy of the string with leading characters removed.

Kind: global function
Returns: string - The string with characters removed.

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| [trimChar] | string | " " | The character to be removed. |

rstrip(string, [trimChar]) ⇒ string

Return a copy of the string with trailing characters removed.

Kind: global function
Returns: string - The string with characters removed.

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| [trimChar] | string | " " | The character to be removed. |

swapcase(string) ⇒ string

Return a copy of the string with lower case letters converted to upper case and vice versa.

Kind: global function
Returns: string - The swapped string

| Param | Type | Description |
| --- | --- | --- |
| string | string | The input string. |

capwords(string, [separator]) ⇒ string

Return a copy of the string with the first char of each separated word converted to upper case.

Kind: global function
Returns: string - The converted string

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| [separator] | string | " " | The separator char. |

ucfirst(string) ⇒ string

Return a copy of the string with the first char converted to upper case.

Kind: global function
Returns: string - The converted string

| Param | Type | Description |
| --- | --- | --- |
| string | string | The input string. |

lcfirst(string) ⇒ string

Return a copy of the string with the first char converted to lower case.

Kind: global function
Returns: string - The converted string

| Param | Type | Description |
| --- | --- | --- |
| string | string | The input string. |

nl2br(string, [breakElement]) ⇒ string

Return a copy of the string with HTML line breaks (
) inserted before all newlines.

Kind: global function
Returns: string - The converted string

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| [breakElement] | string | "<br>" | The HTML line break string. |

expandtabs(string, [tabsize]) ⇒ string

Return a copy of the string with tab chars (\t) replaced by spaces.

Kind: global function
Returns: string - The swapped string

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| string | string | | The input string. |
| [tabsize] | number | 8 | The input string. |