https://github.com/charlesstover/delimiter

Places delimiters between items in an array.
https://github.com/charlesstover/delimiter

babel babeljs chai csl csv es6 javascript js mocha npm npm-module npm-package npmjs travis travis-ci travisci webpack

Last synced: about 2 months ago
JSON representation

Places delimiters between items in an array.

• Host: GitHub
• URL: https://github.com/charlesstover/delimiter
• Owner: CharlesStover
• License: mit
• Created: 2018-07-26T17:00:20.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T07:19:58.000Z (almost 3 years ago)
• Last Synced: 2024-12-17T03:55:38.882Z (about 2 months ago)
• Topics: babel, babeljs, chai, csl, csv, es6, javascript, js, mocha, npm, npm-module, npm-package, npmjs, travis, travis-ci, travisci, webpack
• Language: JavaScript
• Size: 275 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Delimiter [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Do%20you%20give%20a%20fRiCk%20about%20an%20Oxford%20comma?%20You%20can%20automatically%20delimit%20your%20arrays%20with%20the%20delimiter%20NPM%20package.&url=https://github.com/CharlesStover/delimiter&via=CharlesStover&hashtags=javascript,programming,webdev,webdeveloper,webdevelopment)

Places delimiters between items in an array.

Defaults to a comma-separated list with an Oxford comma.

[![version](https://img.shields.io/npm/v/delimiter.svg)](http://www.npmjs.com/package/delimiter)

[![minified size](https://img.shields.io/bundlephobia/min/delimiter.svg)](https://www.npmjs.com/package/delimiter)

[![minzipped size](https://img.shields.io/bundlephobia/minzip/delimiter.svg)](https://www.npmjs.com/package/delimiter)

[![downloads](https://img.shields.io/npm/dt/delimiter.svg)](https://www.npmjs.com/package/delimiter)

[![build](https://travis-ci.com/CharlesStover/delimiter.svg)](https://travis-ci.com/CharlesStover/delimiter/)

## Install

* `npm install delimiter --save` or

* `yarn add delimiter`

## Parameters

`delimiter(arr, serial, del)`

#### arr

The array to which you want to add delimiters.

#### serial

The separator for the last item in the array. (default: `and`)

`delimiter([ 1, 2 ], 'or') === [ 1, ' or ', 2 ]);`

`delimiter([ 1, 2, 3 ], 'or') === [ 1, ', ', 2, ', or ', 3 ]`

#### del

The delimiter you want to use. (default: `,`)

```JS

delimiter(

  [ 'Stover, Charles', 'Quisido, Ace', 'Gates, Bill' ],

  'and', ';'

) === [ 'Stover, Charles', '; ', 'Quisido, Ace', '; and ', 'Gates, Bill' ]

```

## Examples

This package was designed to separate React links using an Oxford comma but is extensible to other use cases.

### Arrays with Two Items

```JS

import delimiter from 'delimiter';

// JSX

const myLinks = [

  ,

  

];

delimiter(myLinks); // [ , ' and ',  ]

```

### Arrays with Three or More Items

```JS

import delimiter from 'delimiter';

// JSX

const myLinks = [

  ,

  ,

  

];

delimiter(myLinks); // [ , ', ', , ', and ',  ]

```

## Sponsor 💗

If you are a fan of this project, you may

[become a sponsor](https://github.com/sponsors/CharlesStover)

via GitHub's Sponsors Program.