fuse-list
v1.0.1
Published
FuseList provides the ability to fuse an array of items into a readable string.
Downloads
3
Maintainers
Readme
$ npm i fuse-list
const { fuseList } = require('fuse-list');
console.log(fuseList(["a", "b", "c"])); // prints "a, b and c"
console.log(fuseList(["a", "b", "c"], { separator: ":", finalSeparator: "-" })); // prints "a:b-c"
console.log(fuseList(["a", "b", "c"], { finalSeparator: " & " })); // prints "a, b & c"
console.log(fuseList(["a", "b", "c"], { finalSeparator: false })); // prints "a, b, c"
console.log(fuseList(["a", "b", "c"], { prefix: "<p>", suffix: "</p>", separator: false, finalSeparator: false })); // prints "<p>a</p><p>b</p><p>c</p>"
console.log(fuseList([1, 2, 3], { separator: "; " })); // prints "1; 2 and 3"
console.log(fuseList([1, 2, 3], { separator: "; ", finalSeparator: null })); // prints "1; 2; 3"
console.log(fuseList(["a", "b", "c"], { prefix: "<p>", suffix: "</p>", separatorPosition: "beforeSuffix" })); // prints "<p>a, </p><p>b and </p><p>c</p>"
console.log(fuseList(["a", "b", "c"], { prefix: "<p>", suffix: "</p>" })); // prints "<p>a</p>, <p>b</p> and <p>c</p>"
Option | Default | Description
--- | --- | ---
separator | ", "
| The separator is used between each item (except between the 2nd last and last items unless finalSeparator
is set to false
.
prefix | null
| The prefix is displayed prior to each item in the list and is only used when the value is not null
or false
.
suffix | null
| The suffix is displayed after each item in the list and is only used when the value is not null
or false
.
separatorPosition | "default"
| The separator position states the position of the separator used between the items.default
the separator is shown after the suffix.beforeSuffix
the separator is shown before the suffix.
finalSeparator | " and "
| The final separator is the separator used between the 2nd last and last items in the list. If this is set to false
or null
the standard separator will be used.
This project is licensed under the MIT License