Need Public Method

    arrford

    2.0.1 • Public • Published

    arrford

    npm version Build Status NPM downloads

    Array to human readable list converter


    Install

    Node

    npm install --save arrford
    

    Web

    arrford is exported for web and usable with the variable arrford

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

    Usage

    // remove require statement if using the web bundle
    const arrford = require('arrford');
     
    arrford(['run', 'climb', 'jump!']);
    //=> 'run, climb, and jump!'

    Fewer than 3 elements in array

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

    Abort the Oxford comma

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

    Replace the word 'and'

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

    Replace the word 'and' and abort the Oxford comma

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

    API

    arrford(target [, oxford, join])


    target

    Type: Array of strings


    oxford

    optional

    Type: boolean

    Default: true

    Description: whether to use the Oxford comma or not


    join

    optional

    Type: string

    Default: 'and'

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


    returns

    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.


    License

    MIT © Dawson Botsford

    Install

    npm i arrford

    DownloadsWeekly Downloads

    78

    Version

    2.0.1

    License

    MIT

    Last publish

    Collaborators

    • dawsonbotsford