33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
|
#listify <sup>[![Version Badge][2]][1]</sup>
|
||
|
|
|
||
|
|
[![Build Status][3]][4] [![dependency status][5]][6] [![dev dependency status][7]][8]
|
||
|
|
|
||
|
|
Turn an array into a list of comma-separated values, appropriate for use in an English sentence.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
```js
|
||
|
|
var listify = require('listify');
|
||
|
|
|
||
|
|
assert(listify([1, 2]) === '1 and 2');
|
||
|
|
assert(listify([1, 2, 3]) === '1, 2, and 3');
|
||
|
|
assert(listify([1, 2, 3, 4]) === '1, 2, 3, and 4');
|
||
|
|
assert(listify([1, 2, 3], { separator: '… ' }) === '1… 2… and 3');
|
||
|
|
assert(listify([1, 2, 3], { finalWord: false }) === '1, 2, 3');
|
||
|
|
assert(listify([1, 2, 3], { separator: '… ', finalWord: 'or' }) === '1… 2… or 3');
|
||
|
|
```
|
||
|
|
|
||
|
|
## Tests
|
||
|
|
Simply clone the repo, `npm install`, and run `npm test`
|
||
|
|
|
||
|
|
[1]: https://npmjs.org/package/listify
|
||
|
|
[2]: http://vb.teelaun.ch/ljharb/listify.svg
|
||
|
|
[3]: https://travis-ci.org/ljharb/listify.png
|
||
|
|
[4]: https://travis-ci.org/ljharb/listify
|
||
|
|
[5]: https://david-dm.org/ljharb/listify.png
|
||
|
|
[6]: https://david-dm.org/ljharb/listify
|
||
|
|
[7]: https://david-dm.org/ljharb/listify/dev-status.png
|
||
|
|
[8]: https://david-dm.org/ljharb/listify#info=devDependencies
|
||
|
|
|
||
|
|
|