humanize-list

humanize-list

Comma delimit an array for human readability, the Oxford comma is optional.

Installation

npm install --save humanize-list

Usage

var humanizeList = require('humanize-list')

humanizeList(['apples', 'tomatoes', 'unicorns']) // => 'apples, tomatoes and unicorns'
humanizeList(['apples', 'tomatoes', 'unicorns'], { oxfordComma: true }) // => 'apples, tomatoes, and unicorns'
humanizeList(['apples', 'tomatoes', 'unicorns'], { conjunction: 'or' }) // => 'apples, tomatoes or unicorns'
humanizeList(['apples', 'tomatoes', 'unicorns'], { skipConjunction: true }) // => 'apples, tomatoes, unicorns'

Options

• oxfordComma Boolean - Specify whether the Oxford comma should be included. Default: false
• conjunction String - Specify a conjunction. Default: 'and'
• skipConjunction Boolean - Skip the conjunction altogether. Default: false

License

MIT

Contributing

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request

Crafted with <3 by John Otander (@4lpine).

This package was initially generated with yeoman and the p generator.

Similar packages

Other packages similar to humanize-list

oxford-comma

The oxford-comma package provides similar functionality by converting arrays into human-readable strings with an emphasis on the Oxford comma. It offers customization options for conjunctions and serial commas, similar to humanize-list.

listify

The listify package also converts arrays into human-readable strings. It is highly customizable, allowing for different conjunctions, separators, and formatting options. It is comparable to humanize-list in terms of flexibility and ease of use.

array-to-sentence

The array-to-sentence package focuses on converting arrays into readable sentences. It provides options for conjunctions and serial commas, making it a good alternative to humanize-list for creating natural language lists.