Package Exports

pronounceable

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 (pronounceable) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

pronounceable

Dependency Status

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);
    });