Package Exports
- array-to-sentence
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (array-to-sentence) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
array-to-sentence
Join all elements of an array and create a human-readable string
arrayToSentence(['foo', 'bar', 'baz', 'qux']); //=> 'foo, bar, baz and qux'Installation
npm
npm install array-to-sentenceAPI
import arrayToSentence from 'array-to-sentence';arrayToSentence(array [, options])
array: Array<any>
options: Object
Return: string
It joins all elements of an array, and returns a string in the form A, B, ... and X.
arrayToSentence(['one', 'two', 3]); //=> 'one, two and 3'
arrayToSentence(['one', 'two']); //=> 'one and two'
arrayToSentence(['one']); //=> 'one'
arrayToSentence([]); //=> ''options.separator
Type: string
Default: ', '
Set the separator string of each word.
options.lastSeparator
Type: string
Default: ' and '
Set the separator string before the last word.
arrayToSentence(['A', 'B', 'C'], {
separator: '-',
lastSeparator: '-'
}); //=> 'A-B-C'
arrayToSentence(['Earth', 'Wind', 'Fire'], {
lastSeparator: ' & '
}); //=> 'Earth, Wind & Fire'Acknowledgement
I used .toSentence() method of underscore.string as API design reference. Thanks, Esa-Matti Suuronen and the contributors.
License
ISC License © 2018 Shinnosuke Watanabe