Package Exports

compound-subject

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (compound-subject) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

compound-subject

A tiny JavaScript library for converting arrays of strings to compound subjects

Installation

Node

In your project directory:

npm install --save compound-subject

At the top of your module:

var compoundSubject = require('compound-subject');

Bower

In your project directory:

bower install --save compound-subject

In your HTML:

<script src="bower_components/compound-subject/compound-subject.min.js"></script>

Or if you want the dev version:

<script src="bower_components/compound-subject/compound-subject.js"></script>

compoundSubject will be defined in the global scope (i.e. window).

Usage

compoundSubject(['apple', 'banana', 'cherry']).make();

// 'apple, banana and cherry'


compoundSubject(['apple', 'banana', 'cherry'])
    .endWith('or')
    .make();

// 'apple, banana or cherry'


compoundSubject(['apple', 'banana', 'cherry'])
    .delimitAll()
    .endWith('and maybe')
    .make();

// 'apple, banana, and maybe cherry'


compoundSubject([
    'a very crunchy Honeycrisp apple',
    'bananas at the pinnacle of ripeness',
    'delectable halved Rainier cherries'
]).delimitWith(';')
    .delimitAll()
    .make();

// 'a very crunchy Honeycrisp apple; bananas at the pinnacle of ripeness; and delectable halved Rainier cherries'