49a5a4c1ad
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
543 lines
18 KiB
HTML
543 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<base data-ice="baseUrl" href="../">
|
|
<title data-ice="title">Function | 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"><h1 data-ice="title">Function</h1>
|
|
<div data-ice="summaries"><table class="summary" data-ice="summary">
|
|
<thead><tr><td data-ice="title" colspan="3">Static Public Summary</td></tr></thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="function/index.html#static-function-getCountries">getCountries</a></span></span><span data-ice="signature">(lang: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Returns the ISO 3166-1 list of countries translated in the language passed as a parameter</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="function/index.html#static-function-getCountry">getCountry</a></span></span><span data-ice="signature">(lang: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, countryCode: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Returns the translation for the country code passed as a parameter in the language passed as a parameter</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="function/index.html#static-function-getLanguage">getLanguage</a></span></span><span data-ice="signature">(lang: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, langCode: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Returns the translation for the language code passed as a parameter in the language passed as a parameter</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="function/index.html#static-function-getLanguages">getLanguages</a></span></span><span data-ice="signature">(lang: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Returns the ISO 639-1 list of languages translated in the language passed as a parameter</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="target">
|
|
<td>
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
<span class="override" data-ice="override"></span>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>
|
|
<span data-ice="name"><span><a href="function/index.html#static-function-getSupportedLangs">getSupportedLangs</a></span></span><span data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></span>
|
|
</p>
|
|
</div>
|
|
<div>
|
|
|
|
|
|
<div data-ice="description"><p>Returns the list of supported languages</p>
|
|
</div>
|
|
</div>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div data-ice="details"><h2 data-ice="title">Static Public </h2>
|
|
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-getCountries">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">getCountries</span><span data-ice="signature">(lang: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/index.js.html#lineNumber17">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div data-ice="description"><p>Returns the ISO 3166-1 list of countries translated in the language passed as a parameter</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" data-depth="0">lang</td>
|
|
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The desired language for the translation</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tr>
|
|
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The countries list</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-getCountry">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">getCountry</span><span data-ice="signature">(lang: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, countryCode: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/index.js.html#lineNumber27">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div data-ice="description"><p>Returns the translation for the country code passed as a parameter in the language passed as a parameter</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" data-depth="0">lang</td>
|
|
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The languages desired for the translation</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" data-depth="0">countryCode</td>
|
|
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The country code for which to return the country name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tr>
|
|
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The translated country name</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-getLanguage">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">getLanguage</span><span data-ice="signature">(lang: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, langCode: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/index.js.html#lineNumber46">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div data-ice="description"><p>Returns the translation for the language code passed as a parameter in the language passed as a parameter</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" data-depth="0">lang</td>
|
|
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The languages desired for the translation</p>
|
|
</td>
|
|
</tr>
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" data-depth="0">langCode</td>
|
|
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The language code for which to return the cuntry name</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tr>
|
|
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The translated country name</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-getLanguages">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">getLanguages</span><span data-ice="signature">(lang: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/index.js.html#lineNumber36">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div data-ice="description"><p>Returns the ISO 639-1 list of languages translated in the language passed as a parameter</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties"><div data-ice="properties">
|
|
<h4 data-ice="title">Params:</h4>
|
|
<table class="params">
|
|
<thead>
|
|
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr data-ice="property" data-depth="0">
|
|
<td data-ice="name" data-depth="0">lang</td>
|
|
<td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
|
|
<td data-ice="appendix"></td>
|
|
<td data-ice="description"><p>The desired language for the translation</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tr>
|
|
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The language list</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="detail" data-ice="detail">
|
|
<h3 data-ice="anchor" id="static-function-getSupportedLangs">
|
|
<span class="access" data-ice="access">public</span>
|
|
|
|
|
|
|
|
|
|
<span data-ice="name">getSupportedLangs</span><span data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></span>
|
|
<span class="right-info">
|
|
|
|
|
|
<span data-ice="source"><span><a href="file/src/index.js.html#lineNumber8">source</a></span></span>
|
|
</span>
|
|
</h3>
|
|
|
|
|
|
|
|
|
|
<div data-ice="description"><p>Returns the list of supported languages</p>
|
|
</div>
|
|
|
|
|
|
|
|
<div data-ice="properties">
|
|
</div>
|
|
|
|
<div class="return-params" data-ice="returnParams">
|
|
<h4>Return:</h4>
|
|
<table>
|
|
<tr>
|
|
<td class="return-type" data-ice="returnType"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a></span></td>
|
|
<td class="return-desc" data-ice="returnDescription"><p>The list of all the supported languages</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<div data-ice="returnProperties">
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</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>
|