Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 938 Bytes

README.md

File metadata and controls

50 lines (32 loc) · 938 Bytes

unvowel

NPM

build status

Works by removing vowels from a string.

Good for generating rememberable passwords.

example

  // on the command line
  $ unvowel -s 'good yuki' -j
  $ gdyk
  $ unvowel -s 'good yuki'
  $ gd yk
  // programmatically

  var unvowel = require('unvowel');

  console.log(unvowel.parse('good yuki')); // gd yk
  console.log(unvowel.parse('good yuki', true)); // gdyk

API.

unvowel.parse(str#string, join#bool)

Return a string str with all the vowels removed.

join controls the option to either join the final output or not. By default its value is false.

install

  $ npm install unvowel
  // globally
  $ npm install -g unvowel

license

MIT.