# delimiter

> Places delimiters between items in an array.

Latest version **1.0.2** (published 2019-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install delimiter
pnpm add delimiter
yarn add delimiter
bun add delimiter
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-02-11 |
| First published | 2018-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Charles Stover |
| Maintainers | charlesstover |

## Links

- npm: https://www.npmjs.com/package/delimiter
- Repository: https://github.com/CharlesStover/delimiter
- Homepage: https://github.com/CharlesStover/delimiter#readme
- Issues: https://github.com/CharlesStover/delimiter/issues
- npm.io page: https://npm.io/package/delimiter

## Recent versions

- 1.0.2 (latest) — 2019-02-11
- 1.0.1 — 2019-02-11
- 1.0.0 — 2018-07-26

## 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 = [
  <CharlesStover />,
  <Quisido />
];

delimiter(myLinks); // [ <CharlesStover />, ' and ', <Quisido /> ]
```

### Arrays with Three or More Items

```JS
import delimiter from 'delimiter';

// JSX
const myLinks = [
  <CharlesStover />,
  <Quisido />,
  <Mtgenius />
];

delimiter(myLinks); // [ <CharlesStover />, ', ', <Quisido />, ', and ', <Mtgenius /> ]
```

---
_Source: https://npm.io/package/delimiter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._