wordnik-api
Version:
Community API for https://wordnik.com with types
45 lines (38 loc) • 7.93 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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"><h1>wordnik-api </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
<a href="#wordnik-api-client" id="wordnik-api-client" style="color: inherit; text-decoration: none;">
<h1>Wordnik API Client</h1>
</a>
<a href="#note-this-is-a-community-made-project-it-is-not-affiliated-with-wordnik" id="note-this-is-a-community-made-project-it-is-not-affiliated-with-wordnik" style="color: inherit; text-decoration: none;">
<h4>Note: this is a community made project, it is not affiliated with Wordnik.</h4>
</a>
<a href="#why-another-wordnik-api" id="why-another-wordnik-api" style="color: inherit; text-decoration: none;">
<h2>Why another Wordnik API?</h2>
</a>
<p>The simple answer is that the other Wordnik APIs are older, and do not have built-in types, making it difficult to use
for TypeScript developers.</p>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h2>Usage</h2>
</a>
<a href="#obtain-an-api-key" id="obtain-an-api-key" style="color: inherit; text-decoration: none;">
<h3>Obtain an API key</h3>
</a>
<p>To get an API key, visit <a href="https://developer.wordnik.com/gettingstarted">https://developer.wordnik.com/gettingstarted</a> to create an account and request an API key.</p>
<a href="#download" id="download" style="color: inherit; text-decoration: none;">
<h3>Download</h3>
</a>
<pre><code class="language-bash"><span class="hl-0"># use npm to install</span><br/><span class="hl-1">npm i wordnik-api</span><br/><span class="hl-0"># or use yarn if you prefer</span><br/><span class="hl-1">yarn add wordnik-api</span>
</code></pre>
<a href="#initializing-the-api" id="initializing-the-api" style="color: inherit; text-decoration: none;">
<h3>Initializing the API</h3>
</a>
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-1"> {</span><span class="hl-3">WordnikAPI</span><span class="hl-1">} = </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-5">"wordnik-api"</span><span class="hl-1">);</span><br/><br/><span class="hl-2">const</span><span class="hl-1"> </span><span class="hl-3">api</span><span class="hl-1"> = </span><span class="hl-2">new</span><span class="hl-1"> </span><span class="hl-4">WordnikAPI</span><span class="hl-1">(</span><span class="hl-5">"your_api_key"</span><span class="hl-1">);</span>
</code></pre>
<p>You can then use the methods described <a href="https://alexanderepolite.github.io/wordnik-javascript-api/classes/WordnikAPI.html">in the docs</a>
to use on the <code>api</code> object you created. Have fun!</p>
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
<h3>Contributing</h3>
</a>
<p>Want to contribute? Contributions are always welcome! Please visit the
<a href="https://github.com/alexanderepolite/wordnik-javascript-api/">GitHub repo</a> and make a
pull request with your contributions.</p>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/PartOfSpeech.html" class="tsd-kind-icon">Part<wbr/>Of<wbr/>Speech</a></li><li class="tsd-kind-enum"><a href="enums/RelationshipType.html" class="tsd-kind-icon">Relationship<wbr/>Type</a></li><li class="tsd-kind-class"><a href="classes/AudioMetadata.html" class="tsd-kind-icon">Audio<wbr/>Metadata</a></li><li class="tsd-kind-class"><a href="classes/Citation.html" class="tsd-kind-icon">Citation</a></li><li class="tsd-kind-class"><a href="classes/Example.html" class="tsd-kind-icon">Example</a></li><li class="tsd-kind-class"><a href="classes/ExampleUse.html" class="tsd-kind-icon">Example<wbr/>Use</a></li><li class="tsd-kind-class"><a href="classes/Frequency.html" class="tsd-kind-icon">Frequency</a></li><li class="tsd-kind-class"><a href="classes/Label.html" class="tsd-kind-icon">Label</a></li><li class="tsd-kind-class"><a href="classes/Phrase.html" class="tsd-kind-icon">Phrase</a></li><li class="tsd-kind-class"><a href="classes/Pronunciation.html" class="tsd-kind-icon">Pronunciation</a></li><li class="tsd-kind-class"><a href="classes/RandomWord.html" class="tsd-kind-icon">Random<wbr/>Word</a></li><li class="tsd-kind-class"><a href="classes/RelatedWord.html" class="tsd-kind-icon">Related<wbr/>Word</a></li><li class="tsd-kind-class"><a href="classes/Syllable.html" class="tsd-kind-icon">Syllable</a></li><li class="tsd-kind-class"><a href="classes/Word.html" class="tsd-kind-icon">Word</a></li><li class="tsd-kind-class"><a href="classes/WordOfTheDay.html" class="tsd-kind-icon">Word<wbr/>Of<wbr/>The<wbr/>Day</a></li><li class="tsd-kind-class"><a href="classes/WordnikAPI.html" class="tsd-kind-icon">WordnikAPI</a></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>