Array to human readable list converter

npm install --save arrford

arrford is exported for web and usable with the variable arrford

<script src="https://rawgit.com/dawsonbotsford/arrford/master/bundle.js"></script>

// remove require statement if using the web bundle
const arrford = require('arrford');

arrford(['run', 'climb', 'jump!']);
//=> 'run, climb, and jump!'

arrford(['run', 'climb!']);
//=> 'run and climb!'

arrford(['run!']);
//=> 'run!'

arrford(['run', 'climb', 'jump!'], false);
//=> 'run, climb and jump!'

arrford(['spring', 'klättra', 'hoppa!'], true, 'och');
//=> 'spring, klättra, och hoppa!'

arrford(['spring', 'klättra', 'hoppa!'], false, 'och');
//=> 'spring, klättra och hoppa!'

Type: Array of strings

optional

Type: boolean

Default: true

Description: whether to use the Oxford comma or not

optional

Type: string

Default: 'and'

Description: word used to join the list with the last element

Type: string

Description: Take an array of strings and return a string of these items as a list. Insert "," and "and" in a grammatically correct way. Follow the Oxford comma trend unless false is passed in for the second argument. Use the word 'and' to join the list unless some other "join" word is specified for the third argument.

MIT © Dawson Botsford