string-formatting
String formatting module for string beautification, splits string optimally over multiple lines. Can be used for formatting addresses.
Installation
npm install --save string-formatting
API
const StringFormatter = ; StringFormatting;
Default configuration, can be overriden with user-defined options:
numLines: 1 // number of lines to format to (numLines and lengthOfLine have overlapping use, please see below) lengthOfLine: 255 // length for each line as a number or length for each specific line in an Array (numLines and lengthOfLine have overlapping use, please see below) firstLineRequired: true // whether the first line in the array must have a value, else fail splitTokenRegex: / / // regex to split the string with mergeToken: ' ' // string to merge the string with in case multiple words join on the same line;
NOTE: When both numLines
defined and lengthOfLine
is defined as an Array (where each line can have multiple lengths).
string-formatting
requires that the numLines
and the length of lengthOfLine
Array be the same.
This is because in the scenario where lengthOfLine
is defined per line, numLines
is an extraneous value and can be omitted.
Usage
const StringFormatter = ; const output = StringFormatting;console;// ['Hello', 'World!'] const output = StringFormatting;console;// ['Hello World!', 'I am Node.js'] const output = StringFormatting;console;// ['', 'Hello World!'] const output = StringFormatting;console;// ['H;ll', 'W;rld!']
For more workable examples, please see fixtures.