pronounceable

1.0.1 • Public • Published

pronounceable

Build Status Dependency Status npm npm npm

Pronounceable is a small module that allows you to test a word for pronounceability.

To use it, simple install via NPM and include it in your project file.

    var pronounceable = require('pronounceable');

Then, to test a word for pronounceability, use the test method.

    console.log(pronounceable.test('samosa')); // true
    console.log(pronounceable.test('xghsii')); // false

You can also use the module to score a word on its pronounceability, using the score method. The higher the output value the more pronouncable the word.

    console.log(pronouncable.score('peonies')); // 0.10176356810708122
    console.log(pronouncable.score('sshh')); // 0.0008556941146173743

To generate your own dataset use the train method.

    pronouncable.train('dictionary.txt', function(probabilities) {
        // The data set has been returned
        console.log(probabilities);
    });

Dependents (0)

Package Sidebar

Install

npm i pronounceable

Weekly Downloads

92

Version

1.0.1

License

MIT

Last publish

Collaborators

  • lukem512