GT2/GT2-Android/node_modules/join-component/Readme.md

1.0 KiB

join

Join a list in a nice human friendly way.

Installation

$ component install component/join

API

join(arr)

should default to "and".

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

join(arr, str)

should join.

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.

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.

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

License

MIT