modified

2026-06-09 09:11:56 +02:00 · 2023-11-24 22:35:41 +01:00
parent 3c0b507a93
commit 7644b2a0f7
45165 changed files with 4803356 additions and 3 deletions
@@ -0,0 +1,33 @@
+#listify <sup>[![Version Badge][npm-version-svg]][npm-url]</sup>
+
+[![Build Status][travis-svg]][travis-url]
+[![dependency status][deps-svg]][deps-url]
+[![dev dependency status][dev-deps-svg]][dev-deps-url]
+
+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`
+
+[npm-url]: https://npmjs.org/package/listify
+[npm-version-svg]: http://versionbadg.es/ljharb/listify.svg
+[travis-svg]: https://travis-ci.org/ljharb/listify.svg
+[travis-url]: https://travis-ci.org/ljharb/listify
+[deps-svg]: https://david-dm.org/ljharb/listify.svg
+[deps-url]: https://david-dm.org/ljharb/listify
+[dev-deps-svg]: https://david-dm.org/ljharb/listify/dev-status.svg
+[dev-deps-url]: https://david-dm.org/ljharb/listify#info=devDependencies
+