https://github.com/lestoni/unvowel

Remove vowels from a string
https://github.com/lestoni/unvowel

Last synced: 7 months ago
JSON representation

Remove vowels from a string

• Host: GitHub
• URL: https://github.com/lestoni/unvowel
• Owner: lestoni
• License: other
• Created: 2015-03-31T10:54:03.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2016-03-30T21:19:16.000Z (about 10 years ago)
• Last Synced: 2024-04-24T19:48:15.708Z (about 2 years ago)
• Language: JavaScript
• Size: 7.81 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# unvowel

[![NPM](https://nodei.co/npm/unvowel.png?downloads=true&stars=true)](https://nodei.co/npm/unvowel/)

[![build status](https://travis-ci.org/lestoni/unvowel.png)](http://travis-ci.org/lestoni/unvowel)

Works by removing vowels from a string.

Good for generating rememberable passwords.

## example

```javascript

  // on the command line

  $ unvowel -s 'good yuki' -j

  $ gdyk

  $ unvowel -s 'good yuki'

  $ gd yk

```

```javascript

  // 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

```javascript

  $ npm install unvowel

  // globally

  $ npm install -g unvowel

```

## license

MIT.