wordnik-api
Version:
Community API for https://wordnik.com with types
195 lines • 84.3 kB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WordnikAPI | wordnik-api</title><meta name="description" content="Documentation for wordnik-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">wordnik-api</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">wordnik-api</a></li><li><a href="WordnikAPI.html">WordnikAPI</a></li></ul><h1>Class WordnikAPI </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Defines the WordnikAPI class.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">WordnikAPI</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WordnikAPI.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WordnikAPI.html#API_KEY" class="tsd-kind-icon">API_<wbr/>KEY</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="WordnikAPI.html#BASE_URL" class="tsd-kind-icon">BASE_<wbr/>URL</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="WordnikAPI.html#WORDS_URL" class="tsd-kind-icon">WORDS_<wbr/>URL</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getAPIKey" class="tsd-kind-icon">getAPIKey</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getAudio" class="tsd-kind-icon">get<wbr/>Audio</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getDefinitions" class="tsd-kind-icon">get<wbr/>Definitions</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getEtymologies" class="tsd-kind-icon">get<wbr/>Etymologies</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getExamples" class="tsd-kind-icon">get<wbr/>Examples</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getFrequency" class="tsd-kind-icon">get<wbr/>Frequency</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getHyphenation" class="tsd-kind-icon">get<wbr/>Hyphenation</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getPhrases" class="tsd-kind-icon">get<wbr/>Phrases</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getPronunciation" class="tsd-kind-icon">get<wbr/>Pronunciation</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getRandomWord" class="tsd-kind-icon">get<wbr/>Random<wbr/>Word</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getRandomWords" class="tsd-kind-icon">get<wbr/>Random<wbr/>Words</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getRelatedWords" class="tsd-kind-icon">get<wbr/>Related<wbr/>Words</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getScrabbleScore" class="tsd-kind-icon">get<wbr/>Scrabble<wbr/>Score</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getTopExample" class="tsd-kind-icon">get<wbr/>Top<wbr/>Example</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getWordOfTheDay" class="tsd-kind-icon">get<wbr/>Word<wbr/>Of<wbr/>The<wbr/>Day</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WordnikAPI.html#makeRequest" class="tsd-kind-icon">make<wbr/>Request</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>WordnikAPI<span class="tsd-signature-symbol">(</span>API_KEY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="WordnikAPI.html" class="tsd-signature-type" data-tsd-kind="Class">WordnikAPI</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L29">WordnikAPI.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Constructs a new WordnikAPI instance.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>API_KEY: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The API key to use.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="WordnikAPI.html" class="tsd-signature-type" data-tsd-kind="Class">WordnikAPI</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="API_KEY" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> API_<wbr/>KEY<a href="#API_KEY" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">API_<wbr/>KEY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L23">WordnikAPI.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a id="BASE_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> BASE_<wbr/>URL<a href="#BASE_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">BASE_<wbr/>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://api.wordnik.com/v4/word.json/"</span><span class="tsd-signature-symbol"> = "https://api.wordnik.com/v4/word.json/"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L20">WordnikAPI.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a id="WORDS_URL" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> WORDS_<wbr/>URL<a href="#WORDS_URL" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">WORDS_<wbr/>URL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://api.wordnik.com/v4/words.json/"</span><span class="tsd-signature-symbol"> = "https://api.wordnik.com/v4/words.json/"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L21">WordnikAPI.ts:21</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAPIKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link">getAPIKey<a href="#getAPIKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">getAPIKey<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L84">WordnikAPI.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets the API key.</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>The API key.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAudio" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Audio<a href="#getAudio" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Audio<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="AudioMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">AudioMetadata</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L143">WordnikAPI.ts:143</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the audio metadata for a word.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getAudio">https://developer.wordnik.com/docs#!/word/getAudio</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get audio metadata for.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit of audio metadata to get.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="AudioMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">AudioMetadata</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The audio metadata for the word, or null if the word is not found.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getDefinitions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Definitions<a href="#getDefinitions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Definitions<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, partOfSpeech<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol">[]</span>, sourceDictionary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ahd-5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"century"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wiktionary"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"webster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wordnet"</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, includeTags<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Word.html" class="tsd-signature-type" data-tsd-kind="Class">Word</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L102">WordnikAPI.ts:102</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get definitions for a word.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getDefinitions">https://developer.wordnik.com/docs#!/word/getDefinitions</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get definitions for.</p>
</div></div></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit of definitions to get.</p>
</div></div></li><li><h5>partOfSpeech: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The part of speech to get definitions for.</p>
</div></div></li><li><h5>sourceDictionary: <span class="tsd-signature-type">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ahd-5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"century"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wiktionary"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"webster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wordnet"</span><span class="tsd-signature-symbol"> = "all"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The source dictionary to get definitions for.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li><li><h5>includeTags: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to include tags in the response.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Word.html" class="tsd-signature-type" data-tsd-kind="Class">Word</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The definitions for the word, or null if the word is not found.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getEtymologies" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Etymologies<a href="#getEtymologies" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Etymologies<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L177">WordnikAPI.ts:177</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the etymologies for a word.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getEtymologies">https://developer.wordnik.com/docs#!/word/getEtymologies</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get etymologies for.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The etymologies for the word, or null if the word is not found.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getExamples" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Examples<a href="#getExamples" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Examples<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, includeDuplicates<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Example.html" class="tsd-signature-type" data-tsd-kind="Class">Example</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L211">WordnikAPI.ts:211</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get examples of a word's usage.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getExamples">https://developer.wordnik.com/docs#!/word/getExamples</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get examples for.</p>
</div></div></li><li><h5>includeDuplicates: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to include duplicate examples.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li><li><h5>skip: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The number of examples to skip.</p>
</div></div></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit of examples to get (max 50).</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Example.html" class="tsd-signature-type" data-tsd-kind="Class">Example</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The examples for the word, or null if the word is not found.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getFrequency" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Frequency<a href="#getFrequency" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Frequency<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, startYear<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, endYear<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Frequency.html" class="tsd-signature-type" data-tsd-kind="Class">Frequency</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L257">WordnikAPI.ts:257</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the frequency of a word.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getWordFrequency">https://developer.wordnik.com/docs#!/word/getWordFrequency</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get the frequency of.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li><li><h5>startYear: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1800</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The start year to get the frequency of.</p>
</div></div></li><li><h5>endYear: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2012</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The end year to get the frequency of.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Frequency.html" class="tsd-signature-type" data-tsd-kind="Class">Frequency</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The frequency of the word, or null if the word is not found.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getHyphenation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Hyphenation<a href="#getHyphenation" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Hyphenation<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, sourceDictionary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ahd-5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"century"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wiktionary"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"webster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wordnet"</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Syllable.html" class="tsd-signature-type" data-tsd-kind="Class">Syllable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L294">WordnikAPI.ts:294</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the word's hyphenation.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getHyphenation">https://developer.wordnik.com/docs#!/word/getHyphenation</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get the hyphenation of.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li><li><h5>sourceDictionary: <span class="tsd-signature-type">"all"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ahd-5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"century"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wiktionary"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"webster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wordnet"</span><span class="tsd-signature-symbol"> = "all"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The source dictionary to get the hyphenation of.</p>
</div></div></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit of hyphenations to get.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Syllable.html" class="tsd-signature-type" data-tsd-kind="Class">Syllable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The word's hyphenation.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPhrases" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Phrases<a href="#getPhrases" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Phrases<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Phrase.html" class="tsd-signature-type" data-tsd-kind="Class">Phrase</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L333">WordnikAPI.ts:333</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get word phrases</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getPhrases">https://developer.wordnik.com/docs#!/word/getPhrases</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get the phrases of.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit of phrases to get.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Phrase.html" class="tsd-signature-type" data-tsd-kind="Class">Phrase</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The word's phrases.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPronunciation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Pronunciation<a href="#getPronunciation" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Pronunciation<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, sourceDictionary<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ahd-5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"century"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wiktionary"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"webster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wordnet"</span>, typeFormat<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ahd-5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"arpabet"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"gcide-diacritical"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"IPA"</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Pronunciation.html" class="tsd-signature-type" data-tsd-kind="Class">Pronunciation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L370">WordnikAPI.ts:370</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the word's Pronunciation.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getTextPronunciations">https://developer.wordnik.com/docs#!/word/getTextPronunciations</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get the pronunciation of.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li><li><h5>sourceDictionary: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ahd-5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"century"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wiktionary"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"webster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wordnet"</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The source dictionary to get the pronunciation of.</p>
</div></div></li><li><h5>typeFormat: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ahd-5"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"arpabet"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"gcide-diacritical"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"IPA"</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The type of pronunciation to get.</p>
</div></div></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit of pronunciations to get.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Pronunciation.html" class="tsd-signature-type" data-tsd-kind="Class">Pronunciation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The word's Pronunciation.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRandomWord" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Random<wbr/>Word<a href="#getRandomWord" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Random<wbr/>Word<span class="tsd-signature-symbol">(</span>hasDictionaryDef<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"true"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"false"</span>, includePartOfSpeech<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a>, excludePartOfSpeech<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a>, minCorpusCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, maxCorpusCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, minDictionaryCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, maxDictionaryCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, minLength<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, maxLength<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="RandomWord.html" class="tsd-signature-type" data-tsd-kind="Class">RandomWord</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L495">WordnikAPI.ts:495</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get a random word.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/words/getRandomWord">https://developer.wordnik.com/docs#!/words/getRandomWord</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hasDictionaryDef: <span class="tsd-signature-type">"true"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"false"</span><span class="tsd-signature-symbol"> = "true"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Only return words with dictionary definitions</p>
</div></div></li><li><h5>includePartOfSpeech: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Only return words with the specified part of speech.</p>
</div></div></li><li><h5>excludePartOfSpeech: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Only return words without the specified part of speech.</p>
</div></div></li><li><h5>minCorpusCount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Minimum corpus frequency for terms</p>
</div></div></li><li><h5>maxCorpusCount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maximum corpus frequency for terms</p>
</div></div></li><li><h5>minDictionaryCount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Minimum dictionary count</p>
</div></div></li><li><h5>maxDictionaryCount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maximum dictionary count</p>
</div></div></li><li><h5>minLength: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Minimum word length</p>
</div></div></li><li><h5>maxLength: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maximum word length</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="RandomWord.html" class="tsd-signature-type" data-tsd-kind="Class">RandomWord</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRandomWords" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Random<wbr/>Words<a href="#getRandomWords" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Random<wbr/>Words<span class="tsd-signature-symbol">(</span>hasDictionaryDef<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"true"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"false"</span>, includePartOfSpeech<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol">[]</span>, excludePartOfSpeech<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol">[]</span>, minCorpusCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, maxCorpusCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, minDictionaryCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, maxDictionaryCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, minLength<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, maxLength<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, sortBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"alpha"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"count"</span>, sortOrder<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"asc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"desc"</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="RandomWord.html" class="tsd-signature-type" data-tsd-kind="Class">RandomWord</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L541">WordnikAPI.ts:541</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get random words.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/words/getRandomWords">https://developer.wordnik.com/docs#!/words/getRandomWords</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hasDictionaryDef: <span class="tsd-signature-type">"true"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"false"</span><span class="tsd-signature-symbol"> = "true"</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Only return words with dictionary definitions</p>
</div></div></li><li><h5>includePartOfSpeech: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Only return words with the specified part of speech.</p>
</div></div></li><li><h5>excludePartOfSpeech: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/PartOfSpeech.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PartOfSpeech</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Only return words without the specified part of speech.</p>
</div></div></li><li><h5>minCorpusCount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Minimum corpus frequency for terms</p>
</div></div></li><li><h5>maxCorpusCount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maximum corpus frequency for terms</p>
</div></div></li><li><h5>minDictionaryCount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Minimum dictionary count</p>
</div></div></li><li><h5>maxDictionaryCount: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maximum dictionary count</p>
</div></div></li><li><h5>minLength: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Minimum word length</p>
</div></div></li><li><h5>maxLength: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Maximum word length</p>
</div></div></li><li><h5>sortBy: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"alpha"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"count"</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sort by</p>
</div></div></li><li><h5>sortOrder: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"asc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"desc"</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sort order</p>
</div></div></li><li><h5>limit: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Limit</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="RandomWord.html" class="tsd-signature-type" data-tsd-kind="Class">RandomWord</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>Random words, or an empty array if no words were found.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getRelatedWords" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Related<wbr/>Words<a href="#getRelatedWords" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Related<wbr/>Words<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, relationshipTypes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/RelationshipType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RelationshipType</a>, limitPerRelationshipType<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="RelatedWord.html" class="tsd-signature-type" data-tsd-kind="Class">RelatedWord</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L411">WordnikAPI.ts:411</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get related words.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getRelatedWords">https://developer.wordnik.com/docs#!/word/getRelatedWords</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get related words for.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li><li><h5>relationshipTypes: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/RelationshipType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RelationshipType</a><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The relationship types to get.</p>
</div></div></li><li><h5>limitPerRelationshipType: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The limit of related words to get per relationship type.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="RelatedWord.html" class="tsd-signature-type" data-tsd-kind="Class">RelatedWord</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div><p>The related words or null if an error occurred.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getScrabbleScore" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Scrabble<wbr/>Score<a href="#getScrabbleScore" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Scrabble<wbr/>Score<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L449">WordnikAPI.ts:449</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the scrabble score of a word.
You may want to lowercase the word before passing it in.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getScrabbleScore">https://developer.wordnik.com/docs#!/word/getScrabbleScore</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get the scrabble score of.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><div><p>The scrabble score of the word, or null if the word is not found.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTopExample" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Top<wbr/>Example<a href="#getTopExample" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Top<wbr/>Example<span class="tsd-signature-symbol">(</span>word<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, useCanonical<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Example.html" class="tsd-signature-type" data-tsd-kind="Class">Example</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L470">WordnikAPI.ts:470</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the top example of a word.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/word/getTopExample">https://developer.wordnik.com/docs#!/word/getTopExample</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>word: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The word to get the top example of.</p>
</div></div></li><li><h5>useCanonical: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether to use the canonical form of the word (e.g. "cats" -> "cat").</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Example.html" class="tsd-signature-type" data-tsd-kind="Class">Example</a><span class="tsd-signature-symbol">></span></h4><div><p>The top example of the word, or null if the word is not found.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getWordOfTheDay" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Word<wbr/>Of<wbr/>The<wbr/>Day<a href="#getWordOfTheDay" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Word<wbr/>Of<wbr/>The<wbr/>Day<span class="tsd-signature-symbol">(</span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="WordOfTheDay.html" class="tsd-signature-type" data-tsd-kind="Class">WordOfTheDay</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L582">WordnikAPI.ts:582</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the word of the day.</p>
</div><div><p><a href="https://developer.wordnik.com/docs#!/words/getWordOfTheDay">https://developer.wordnik.com/docs#!/words/getWordOfTheDay</a></p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>date: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> = undefined</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>the Date to get the word of the day for, a string in the format yyyy-MM-dd, or undefined to get the word of the day for today.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="WordOfTheDay.html" class="tsd-signature-type" data-tsd-kind="Class">WordOfTheDay</a><span class="tsd-signature-symbol">></span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="makeRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> make<wbr/>Request<a href="#makeRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">make<wbr/>Request<span class="tsd-signature-symbol">(</span>endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, base_url<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/alexanderepolite/wordnik-javascript-api/blob/fab2c73/src/WordnikAPI.ts#L46">WordnikAPI.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Make an API call to the Wordnik API.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>endpoint: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The endpoint to call.</p>
</div></div></li><li><h5>params: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The parameters to pass to the endpoint.</p>
</div></div></li><li><h5>base_url: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = WordnikAPI.BASE_URL</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The base URL to use (optional).</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="WordnikAPI.html" class="tsd-kind-icon">WordnikAPI</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="WordnikAPI.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="WordnikAPI.html#API_KEY" class="tsd-kind-icon">API_<wbr/>KEY</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="WordnikAPI.html#BASE_URL" class="tsd-kind-icon">BASE_<wbr/>URL</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="WordnikAPI.html#WORDS_URL" class="tsd-kind-icon">WORDS_<wbr/>URL</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getAPIKey" class="tsd-kind-icon">getAPIKey</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getAudio" class="tsd-kind-icon">get<wbr/>Audio</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getDefinitions" class="tsd-kind-icon">get<wbr/>Definitions</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getEtymologies" class="tsd-kind-icon">get<wbr/>Etymologies</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getExamples" class="tsd-kind-icon">get<wbr/>Examples</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getFrequency" class="tsd-kind-icon">get<wbr/>Frequency</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getHyphenation" class="tsd-kind-icon">get<wbr/>Hyphenation</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getPhrases" class="tsd-kind-icon">get<wbr/>Phrases</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getPronunciation" class="tsd-kind-icon">get<wbr/>Pronunciation</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getRandomWord" class="tsd-kind-icon">get<wbr/>Random<wbr/>Word</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getRandomWords" class="tsd-kind-icon">get<wbr/>Random<wbr/>Words</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getRelatedWords" class="tsd-kind-icon">get<wbr/>Related<wbr/>Words</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getScrabbleScore" class="tsd-kind-icon">get<wbr/>Scrabble<wbr/>Score</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getTopExample" class="tsd-kind-icon">get<wbr/>Top<wbr/>Example</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="WordnikAPI.html#getWordOfTheDay" class="tsd-kind-icon">get<wbr/>Word<wbr/>Of<wbr/>The<wbr/>Day</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="WordnikAPI.html#makeRequest" class="tsd-kind-icon">make<wbr/>Request</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>