voca

To use Voca directly in a web page, load the UMD builds via a <script> tag. This exposes a global variable v containing the entire library.

<script src="voca.js" type="text/javascript"></script>
<script type="text/javascript">
  v.last('wonderful world', 5); // => 'world'
</script>

To use Voca in Node.js, Rollup, Webpack, or Browserify environments, install the package using npm into your local modules directory.

npm install voca

In a CommonJS environment, you can require the entire library to access all functions via a single object, or require individual functions to minimize your bundle size.

// Require the entire library
const v = require('voca');
v.trim(' Hello World! ');            // => 'Hello World'
v.sprintf('%d red %s', 3, 'apples'); // => '3 red apples'

// Require individual functions
const words = require('voca/words');
const slugify = require('voca/slugify');
words('welcome to Earth'); // => ['welcome', 'to', 'Earth']
slugify('caffé latté');    // => 'caffe-latte'

Voca is compatible with ES2015 modules. You can import the entire library as a default export or import specific functions directly.

// Import the entire library
import voca from 'voca';
voca.kebabCase('goodbye blue sky'); // => 'goodbye-blue-sky'

// Import individual functions
import last from 'voca/last';
last('sun rises', 5); // => 'rises'

To start a string manipulation sequence, call the default export v(subject). This creates a ChainWrapper object that allows for implicit method chaining.

If a method in the chain returns a number, boolean, or array, the chain terminates and returns that value. For all other cases (when the result is still a wrapper), use the .value() method to unwrap the final string result.