cmudict-to-sqlite
Version:
A utility for parsing the CMU Pronouncing Dictionary into an sqlite database using Node.js. Also included is a helper class for looking up information in the database and manipulating it.
1,137 lines (674 loc) • 31.2 kB
HTML
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>JsDoc Reference - CmudictDb</title>
<style type="text/css">
/* default.css */
body
{
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
width: 800px;
}
.header
{
clear: both;
background-color: #ccc;
padding: 8px;
}
h1
{
font-size: 150%;
font-weight: bold;
padding: 0;
margin: 1em 0 0 .3em;
}
hr
{
border: none 0;
border-top: 1px solid #7F8FB1;
height: 1px;
}
pre.code
{
display: block;
padding: 8px;
border: 1px dashed #ccc;
}
#index
{
margin-top: 24px;
float: left;
width: 160px;
position: absolute;
left: 8px;
background-color: #F3F3F3;
padding: 8px;
}
#content
{
margin-left: 190px;
width: 600px;
}
.classList
{
list-style-type: none;
padding: 0;
margin: 0 0 0 8px;
font-family: arial, sans-serif;
font-size: 1em;
overflow: auto;
}
.classList li
{
padding: 0;
margin: 0 0 8px 0;
}
.summaryTable { width: 100%; }
h1.classTitle
{
font-size:170%;
line-height:130%;
}
h2 { font-size: 110%; }
caption, div.sectionTitle
{
background-color: #7F8FB1;
color: #fff;
font-size:130%;
text-align: left;
padding: 2px 6px 2px 6px;
border: 1px #7F8FB1 solid;
}
div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }
.summaryTable td
{
vertical-align: top;
padding: 4px;
border-bottom: 1px #7F8FB1 solid;
border-right: 1px #7F8FB1 solid;
}
/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
border-left: 1px #7F8FB1 solid;
width: 140px;
text-align: right;
}
td.attributes, .fixedFont
{
line-height: 15px;
color: #002EBE;
font-family: "Courier New",Courier,monospace;
font-size: 13px;
}
.summaryTable td.nameDescription
{
text-align: left;
font-size: 13px;
line-height: 15px;
}
.summaryTable td.nameDescription, .description
{
line-height: 15px;
padding: 4px;
padding-left: 4px;
}
.summaryTable { margin-bottom: 8px; }
ul.inheritsList
{
list-style: square;
margin-left: 20px;
padding-left: 0;
}
.detailList {
margin-left: 20px;
line-height: 15px;
}
.detailList dt { margin-left: 20px; }
.detailList .heading
{
font-weight: bold;
padding-bottom: 6px;
margin-left: 0;
}
.light, td.attributes, .light a:link, .light a:visited
{
color: #777;
font-style: italic;
}
.fineprint
{
text-align: right;
font-size: 10px;
}
</style>
</head>
<body>
<!-- ============================== header ================================= -->
<!-- begin static/header.html -->
<div id="header">
</div>
<!-- end static/header.html -->
<!-- ============================== classes index ============================ -->
<div id="index">
<!-- begin publish.classesIndex -->
<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
<li><a href="../symbols/CmudictDb.html">CmudictDb</a></li>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Class CmudictDb
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br />Version
20130518.<br />
Represents the cmudict database and provides convenience methods for
common tasks.
<br /><i>Defined in: </i> <src/cmudict-to-sqlite.js>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class CmudictDb.">
<caption>Class Summary</caption>
<thead>
<tr>
<th scope="col">Constructor Attributes</th>
<th scope="col">Constructor Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/CmudictDb.html#constructor">CmudictDb</a></b>(cmudictFile)
</div>
<div class="description">Represents the cmudict database and provides convenience methods for common
tasks.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class CmudictDb.">
<caption>Method Summary</caption>
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#addEntry">addEntry</a></b>(word, code, callback)
</div>
<div class="description">Adds a new record to the cmudict table.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#addMetadata">addMetadata</a></b>(name, data, callback)
</div>
<div class="description">Adds a new record to the metadata table.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#deleteEntry">deleteEntry</a></b>(word, callback)
</div>
<div class="description">Delete a record from the cmudict table.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#deleteMetadata">deleteMetadata</a></b>(name, callback)
</div>
<div class="description">Delete a record from the metadata table.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#fuzzyLookupCode">fuzzyLookupCode</a></b>(code, callback)
</div>
<div class="description">Searches for the given phoneme(s).</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#fuzzyLookupWord">fuzzyLookupWord</a></b>(word, callback)
</div>
<div class="description">Searches words for the given pattern.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#lookupCode">lookupCode</a></b>(code, callback)
</div>
<div class="description">Searches for the given code.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#lookupMetadata">lookupMetadata</a></b>(name, callback)
</div>
<div class="description">Searches for the given metadata.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#lookupWord">lookupWord</a></b>(word, callback)
</div>
<div class="description">Searches for the given word.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#saveAsText">saveAsText</a></b>(fileName, callback)
</div>
<div class="description">Saves the contents of the database as a text file using the same format as the
original cmudict.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#unload">unload</a></b>()
</div>
<div class="description">Finalizes all preparedStatements and closes the database.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#updateCode">updateCode</a></b>(updatedCode, oldCode, callback)
</div>
<div class="description">Fix typos in codes.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#updateMetadata">updateMetadata</a></b>(data, name, callback)
</div>
<div class="description">Update metadata entries.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/CmudictDb.html#updateWord">updateWord</a></b>(updatedWord, oldWord, callback)
</div>
<div class="description">Fix misspelled words or typos in words.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont">
<b>CmudictDb</b>(cmudictFile)
</div>
<div class="description">
Represents the cmudict database and provides convenience methods for common
tasks. When creating a new instance of the
CmudictDb the given database file will be opened and several prepared
statements will be loaded. Be sure to call the unload method when you are
finished using the database so that the database may be closed properly.
The dictionary is stored in the cmudict table and information, including
the license for the CMU Pronunciation Dictionary itself, is stored in the
metadata table.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>cmudictFile</b>
</dt>
<dd>Optional. The name and location of the cmudict
database generated with cmudictToSqliteDb. Defaults to cmudict.0.7a.sqlite.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Requires:</dt>
<dd>sqlite3</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="../symbols/_global_.html#cmudictToSqliteDb">cmudictToSqliteDb</a></dd>
<dd><a href="http://www.speech.cs.cmu.edu/cgi-bin/cmudict">
Carnegie Mellon University's information and download links for cmudict</a></dd>
<dd><a href="http://en.wikipedia.org/wiki/CMU_Pronouncing_Dictionary">
Wikipedia's article on the CMU Pronouncing Dictionary</a></dd>
<dd><a href="http://en.wikipedia.org/wiki/Arpabet">
Wikipedia's ARPAbet article</a></dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="addEntry"> </a>
<div class="fixedFont">
<b>addEntry</b>(word, code, callback)
</div>
<div class="description">
Adds a new record to the cmudict table.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.addEntry('superfakeword', 'xo xo xo1', function (err, rows) {
console.log('addEntry Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>word</b>
</dt>
<dd>The word to add to the word field.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>code</b>
</dt>
<dd>The code to add to the code field.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="addMetadata"> </a>
<div class="fixedFont">
<b>addMetadata</b>(name, data, callback)
</div>
<div class="description">
Adds a new record to the metadata table.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.addMetadata('superfakeword', 'xo xo xo1', function (err, rows) {
console.log('addMetadata Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The name of the metadata</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>data</b>
</dt>
<dd>The data associated with the metadata name.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="deleteEntry"> </a>
<div class="fixedFont">
<b>deleteEntry</b>(word, callback)
</div>
<div class="description">
Delete a record from the cmudict table.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.deleteEntry('superfakewordzzz', function (err, rows) {
console.log('deleteEntry Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>word</b>
</dt>
<dd>The word to remove.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="deleteMetadata"> </a>
<div class="fixedFont">
<b>deleteMetadata</b>(name, callback)
</div>
<div class="description">
Delete a record from the metadata table.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.deleteMetadata('superfakeword', function (err, rows) {
console.log('deleteEntry Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The metadata to remove.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="fuzzyLookupCode"> </a>
<div class="fixedFont">
<b>fuzzyLookupCode</b>(code, callback)
</div>
<div class="description">
Searches for the given phoneme(s). Through creative use of wildcards, this
method may be used to find assonance, consonance, rhyme, etc. Both, the
underscore and percent symbol, will match any character. The underscore
consumes a single character and the percent symbol consumes multiple
characters.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.fuzzyLookupCode('%r ah1 p t%', function (err, rows) {
// finds words containing the sound "rupt" i.e. erupt and corrupt
console.log('fuzzyLookupCode Results for %r ah1 p t%');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>code</b>
</dt>
<dd>The pattern to look for in the code field.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="fuzzyLookupWord"> </a>
<div class="fixedFont">
<b>fuzzyLookupWord</b>(word, callback)
</div>
<div class="description">
Searches words for the given pattern. Both, the underscore and percent
symbol, will match any character. The underscore consumes a single character
and the percent symbol consumes multiple characters.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.fuzzyLookupWord('zeb%', function (err, rows) {
console.log('fuzzyLookupWord Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>word</b>
</dt>
<dd>The pattern to look for in the word field.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="lookupCode"> </a>
<div class="fixedFont">
<b>lookupCode</b>(code, callback)
</div>
<div class="description">
Searches for the given code.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.lookupCode('ah1 p s ay1 z', function (err, rows) {
console.log('lookupCode Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>code</b>
</dt>
<dd>The code to look for in the code field.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="lookupMetadata"> </a>
<div class="fixedFont">
<b>lookupMetadata</b>(name, callback)
</div>
<div class="description">
Searches for the given metadata.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.lookupMetadata('license', function (err, rows) {
console.log('lookupMetadata Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The name of the metadata.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="lookupWord"> </a>
<div class="fixedFont">
<b>lookupWord</b>(word, callback)
</div>
<div class="description">
Searches for the given word.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.lookupWord('zebra', function (err, rows) {
console.log('lookupWord Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>word</b>
</dt>
<dd>The word to look for in the words field.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="saveAsText"> </a>
<div class="fixedFont">
<b>saveAsText</b>(fileName, callback)
</div>
<div class="description">
Saves the contents of the database as a text file using the same format as the
original cmudict. The contents of metadata.license will be prepended to the
beginning of the file, change it if you want to add information to the
license.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code"> var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.saveAsText('cmudict.txt', function(content) {
// if you want to see what was written to the file
// uncomment the next line.
// console.log(content);
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>fileName</b>
</dt>
<dd>The name and location of the output file.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute after the file is
written. The callback will be called with one argument, the string which
was written to file.</dd>
</dl>
<hr />
<a name="unload"> </a>
<div class="fixedFont">
<b>unload</b>()
</div>
<div class="description">
Finalizes all preparedStatements and closes the database.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<hr />
<a name="updateCode"> </a>
<div class="fixedFont">
<b>updateCode</b>(updatedCode, oldCode, callback)
</div>
<div class="description">
Fix typos in codes.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.updateCode('xo1 xo xo', 'xo xo xo1', function (err, rows) {
console.log('updateCode Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>updatedCode</b>
</dt>
<dd>The corrected code.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>oldCode</b>
</dt>
<dd>The misspelled code.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="updateMetadata"> </a>
<div class="fixedFont">
<b>updateMetadata</b>(data, name, callback)
</div>
<div class="description">
Update metadata entries.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.updateMetadata('superfakeword', 'superfakeword', function (err, rows) {
console.log('updateMetadata Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>data</b>
</dt>
<dd>The updated data</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>name</b>
</dt>
<dd>The name of the metadata to update.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<hr />
<a name="updateWord"> </a>
<div class="fixedFont">
<b>updateWord</b>(updatedWord, oldWord, callback)
</div>
<div class="description">
Fix misspelled words or typos in words.
<br /><i>Author: </i><a href="mailto:matthewkastor@gmail.com">Matthew Kastor</a>.
</div>
<pre class="code">var cmu = require('cmudict-to-sqlite');
cmu = new cmu.CmudictDb();
cmu.updateWord('superfakewordzzz', 'superfakeword', function (err, rows) {
console.log('updateWord Results');
if (err) { console.log(err); }
if (rows) { console.log(rows); }
// do other stuff with the database . . .
cmu.unload();
});</pre>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>updatedWord</b>
</dt>
<dd>The corrected word.</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>oldWord</b>
</dt>
<dd>The misspelled word.</dd>
<dt>
<span class="light fixedFont">{Function}</span> <b>callback</b>
</dt>
<dd>The callback to execute when results have been
retreived. Takes two arguments: error and rows, in that order.</dd>
</dl>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu Nov 17 2022 17:29:49 GMT-0500 (Eastern Standard Time)
</div>
</body>
</html>