n/iso-countries-languages
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
iso-countries-languages/esdoc/index.html
pinturic 49a5a4c1ad First commit 
README.md edited online with Bitbucket

Add esdoc

Upgraded dependencies

Fixed dependencies in readme

Fix description

Fixed readme

0.1.0

config.env deleted online with Bitbucket
2016-11-09 11:48:48 +01:00

163 lines
8.1 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl">
<title data-ice="title">API Document</title>
<link type="text/css" rel="stylesheet" href="css/style.css">
<link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
<script src="script/prettify/prettify.js"></script>
<script src="script/manual.js"></script>
</head>
<body class="layout-container" data-ice="rootContainer">
<header>
<a href="./">Home</a>
<a href="identifiers.html">Reference</a>
<a href="source.html">Source</a>
<a data-ice="repoURL" href="https://bitbucket.org/pinturic/iso-countries-languages">Repository</a>
<div class="search-box">
<span>
<img src="./image/search.png">
<span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
</span>
<ul class="search-result"></ul>
</div>
</header>
<nav class="navigation" data-ice="nav"><div>
<ul>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getCountries">getCountries</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getCountry">getCountry</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getLanguage">getLanguage</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getLanguages">getLanguages</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-function">F</span><span data-ice="name"><span><a href="function/index.html#static-function-getSupportedLangs">getSupportedLangs</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-packagedJson">packagedJson</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-supportedLangs">supportedLangs</a></span></span></li>
</ul>
</div>
</nav>
<div class="content" data-ice="content"><div data-ice="index" class="github-markdown"><p><a href="https://www.bithound.io/bitbucket/pinturic/iso-countries-languages"><img src="https://www.bithound.io/bitbucket/pinturic/iso-countries-languages/badges/score.svg" alt="bitHound Overall Score"></a>
<a href="https://www.bithound.io/bitbucket/pinturic/crema/d2f4223edec3a203961fbd7b4f528e5bf15b2921/dependencies/npm"><img src="https://www.bithound.io/bitbucket/pinturic/iso-countries-languages/badges/dependencies.svg" alt="bitHound Dependencies"></a>
<a href="https://www.bithound.io/bitbucket/pinturic/crema/d2f4223edec3a203961fbd7b4f528e5bf15b2921/dependencies/npm"><img src="https://www.bithound.io/bitbucket/pinturic/iso-countries-languages/badges/devDependencies.svg" alt="bitHound Dev Dependencies"></a>
<a href="https://www.bithound.io/bitbucket/pinturic/iso-countries-languages"><img src="https://www.bithound.io/bitbucket/pinturic/iso-countries-languages/badges/code.svg" alt="bitHound Code"></a>
<img src="./esdoc/badge.svg" alt=" Code documentation "></p>
<h1 id="iso-countries-languages">iso-countries-languages</h1>
<p>This library provides the full list of <a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1 languages</a> and the full list of <a href="https://en.wikipedia.org/wiki/ISO_3166-1">ISO 3166-1 countries</a>. The library supports 89 languages (the full list is available by querying the library API itself) and it is designed to be easy to import and use.</p>
<h1 id="code-documentation">Code documentation</h1>
<p><a href="./esdoc/index.html"> Code documentation </a></p>
<h2 id="api-list">API list</h2>
<h3 id="getsupportedlangs">getSupportedLangs</h3>
<p>Returns the list of supported languages.</p>
<pre><code><code class="source-code prettyprint">var isoCountriesLanguages = require(&apos;../lib/iso-countries-languages.js&apos;);
var supportedLangs = isoCountriesLanguages.getSupportedLangs();
console.log(&quot;Supported languages: &quot;);
console.log(supportedLangs);</code>
</code></pre><h4 id="output">Output</h4>
<pre><code><code class="source-code prettyprint">Supported languages:
[ &apos;af&apos;,
&apos;am&apos;,
&apos;ar&apos;,
&apos;az&apos;,
&apos;ba&apos;,
...
&apos;udm&apos;,
&apos;uk&apos;,
&apos;ur&apos;,
&apos;uz&apos;,
&apos;vi&apos;,
&apos;xh&apos;,
&apos;yi&apos;,
&apos;zh&apos; ]</code>
</code></pre><h3 id="getcountries">getCountries</h3>
<p>Returns the ISO 3166-1 list of countries translated in the language passed as a parameter.</p>
<pre><code><code class="source-code prettyprint">var isoCountriesLanguages = require(&apos;../lib/iso-countries-languages.js&apos;);
var countriesInFrench = isoCountriesLanguages.getCountries(&apos;fr&apos;);
console.log(&quot;Countries in french: &quot;);
console.log(countriesInFrench);</code>
</code></pre><h4 id="output">Output</h4>
<pre><code><code class="source-code prettyprint">Countries in french:
{ AF: &apos;Afghanistan&apos;,
AX: &apos;Les &#xCE;les D\&apos;&#xC5;land&apos;,
AL: &apos;L\&apos;albanie&apos;,
DZ: &apos;L\&apos;alg&#xE9;rie&apos;,
AS: &apos;Samoa Am&#xE9;ricaines&apos;,
AD: &apos;Andorre&apos;,
...
WF: &apos;Wallis-et-Futuna&apos;,
EH: &apos;Sahara Occidental&apos;,
YE: &apos;Y&#xE9;men&apos;,
ZM: &apos;La zambie&apos;,
ZW: &apos;Zimbabwe&apos; }</code>
</code></pre><h3 id="getcountry">getCountry</h3>
<p>Returns the translation for the country code passed as a parameter in the language passed as a parameter.</p>
<pre><code><code class="source-code prettyprint">var isoCountriesLanguages = require(&apos;../lib/iso-countries-languages.js&apos;);
var italyInFrench = isoCountriesLanguages.getCountry(&apos;fr&apos;, &apos;IT&apos;);
console.log(&quot;Italy in french: &quot;);
console.log(italyInFrench);</code>
</code></pre><h4 id="output">Output</h4>
<pre><code><code class="source-code prettyprint">Italy in french:
Italie</code>
</code></pre><h3 id="getlanguages">getLanguages</h3>
<p>Returns the ISO 639-1 list of languages translated in the language passed as a parameter</p>
<pre><code><code class="source-code prettyprint">var isoCountriesLanguages = require(&apos;../lib/iso-countries-languages.js&apos;);
var languagesInItalian = isoCountriesLanguages.getLanguages(&apos;it&apos;);
console.log(&quot;Languages in italian: &quot;);
console.log(languagesInItalian);</code>
</code></pre><h4 id="output">Output</h4>
<pre><code><code class="source-code prettyprint">Languages in italian:
{ ab: &apos;Di abcasia&apos;,
aa: &apos;Lontano&apos;,
af: &apos;Afrikaans&apos;,
ak: &apos;Akan&apos;,
sq: &apos;Albanese&apos;,
am: &apos;Amarico&apos;,
ar: &apos;Arabo&apos;,
...
xh: &apos;Xhosa&apos;,
yi: &apos;Yiddish&apos;,
yo: &apos;Yoruba&apos;,
za: &apos;Zhuang, Chuang&apos;,
zu: &apos;Zulu&apos; }</code>
</code></pre><h3 id="getlanguage">getLanguage</h3>
<p>Returns the translation for the language code passed as a parameter in the language passed as a parameter</p>
<pre><code><code class="source-code prettyprint">var isoCountriesLanguages = require(&apos;../lib/iso-countries-languages.js&apos;);
var spanishInItalian = isoCountriesLanguages.getLanguage(&apos;it&apos;, &apos;es&apos;);
console.log(&quot;Spanish in italian: &quot;);
console.log(spanishInItalian);</code>
</code></pre><h4 id="output">Output</h4>
<pre><code><code class="source-code prettyprint">Spanish in italian:
Spagnolo</code>
</code></pre></div>
</div>
<footer class="footer">
Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.4.8)</span></a>
</footer>
<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink