https://github.com/suddi/string-formatting
NPM string formatting module for string beautification (https://www.npmjs.com/package/string-formatting)
https://github.com/suddi/string-formatting
functional-programming nodejs string-beautification string-formatter
Last synced: 4 months ago
JSON representation
NPM string formatting module for string beautification (https://www.npmjs.com/package/string-formatting)
- Host: GitHub
- URL: https://github.com/suddi/string-formatting
- Owner: suddi
- License: mit
- Created: 2017-01-17T10:28:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-07T10:45:40.000Z (over 5 years ago)
- Last Synced: 2025-02-12T09:49:32.105Z (5 months ago)
- Topics: functional-programming, nodejs, string-beautification, string-formatter
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/string-formatting
- Size: 192 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# string-formatting
[](https://circleci.com/gh/suddi/string-formatting)
[](https://codecov.io/gh/suddi/string-formatting)
[](https://www.codacy.com/app/Suddi/string-formatting)
[](https://www.npmjs.com/package/string-formatting)
[](https://www.npmjs.com/package/string-formatting)
[](https://david-dm.org/suddi/string-formatting)
[](https://david-dm.org/suddi/string-formatting?type=dev)
[](https://raw.githubusercontent.com/suddi/string-formatting/master/LICENSE)
[](https://codecov.io/gh/suddi/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
````js
const StringFormatter = require('string-formatting');
StringFormatting.apply(, );
````
Default configuration, can be overriden with user-defined options:
````js
{
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
````js
const StringFormatter = require('string-formatting');
const output = StringFormatting.apply('Hello World!', {
lengthOfLine: [5, 6] // the first line is allowed to have a maximum length of 5, the second line, a maximum length of 6
});
console.log(output);
// ['Hello', 'World!']
const output = StringFormatting.apply('Hello World! I am Node.js', {
numLines: 2,
lengthOfLine: 12
});
console.log(output);
// ['Hello World!', 'I am Node.js']
const output = StringFormatting.apply('Hello World!', {
lengthOfLine: [2, 100],
firstLineRequired: false
});
console.log(output);
// ['', 'Hello World!']
const output = StringFormatting.apply('Hello World!', {
lengthOfLine: [4, 6],
splitTokenRegex: /[aeiou]/,
mergeToken: ';'
});
console.log(output);
// ['H;ll', 'W;rld!']
````
For more workable examples, please see [fixtures](test/fixtures).