https://github.com/component/join

Join a list as a sentence "foo, bar and baz" etc
https://github.com/component/join

Last synced: 13 days ago
JSON representation

Join a list as a sentence "foo, bar and baz" etc

• Host: GitHub
• URL: https://github.com/component/join
• Owner: component
• Created: 2012-12-18T21:38:43.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-10-09T23:41:55.000Z (about 11 years ago)
• Last Synced: 2024-05-08T17:11:21.133Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 116 KB
• Stars: 6
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        

# join

  Join a list in a nice human friendly way.

## Installation

    $ component install component/join

## API

   - [join(arr)](#joinarr)

   - [join(arr, str)](#joinarr-str)

   - [join(arr, str) with Oxford comma](#joinarr-str-with-oxford-comma)





# join(arr)

should default to "and".

```js

join(['foo', 'bar']).should.equal('foo and bar');

```



# join(arr, str)

should join.

```js

join([], 'and').should.equal('');

join(['foo'], 'and').should.equal('foo');

join(['foo', 'bar'], 'and').should.equal('foo and bar');

join(['foo', 'bar', 'baz'], 'or').should.equal('foo, bar or baz');

```



# join(arr, str) with Oxford comma

should remove comma with less than 3 items.

```js

join([], ', or').should.equal('');

join(['foo'], ', or').should.equal('foo');

join(['foo', 'bar'], ', or').should.equal('foo or bar');

```

should join with 3 or more items.

```js

join(['foo', 'bar', 'baz'], ', and').should.equal('foo, bar, and baz');

```

## License

  MIT