npm - ilib-localematcher - Versions diffs - 1.3.1 → 1.3.4 - Mend

ilib-localematcher 1.3.1 → 1.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/README.md +2 -41
package/lib/LocaleMatcher.js +1 -1
package/lib/LocaleMatcher.js.map +1 -1
package/lib/localematch.js +1 -1
package/lib/localematch.js.map +1 -1
package/package.json +110 -108
package/src/LocaleMatcher.js +7 -7
package/src/localematch.js +7 -1
package/docs/LocaleMatcher.html +0 -1237
package/docs/LocaleMatcher.js.html +0 -465
package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -978
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -1049
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
package/docs/ilibLocaleMatcher.md +0 -235
package/docs/index.html +0 -84
package/docs/scripts/collapse.js +0 -39
package/docs/scripts/commonNav.js +0 -28
package/docs/scripts/linenumber.js +0 -25
package/docs/scripts/nav.js +0 -12
package/docs/scripts/polyfill.js +0 -4
package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/scripts/prettify/lang-css.js +0 -2
package/docs/scripts/prettify/prettify.js +0 -28
package/docs/scripts/search.js +0 -99
package/docs/styles/jsdoc.css +0 -776
package/docs/styles/prettify.css +0 -80
package/lib/package.json +0 -1

package/docs/LocaleMatcher.html DELETED Viewed

@@ -1,1237 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>LocaleMatcher - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
-    <script src="scripts/nav.js" defer></script>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-</head>
-<body>
-<input type="checkbox" id="nav-trigger" class="nav-trigger" />
-<label for="nav-trigger" class="navicon-button x">
-  <div class="navicon"></div>
-</label>
-<label for="nav-trigger" class="overlay"></label>
-<nav >
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="LocaleMatcher.html">LocaleMatcher</a><ul class='methods'><li data-type='method'><a href="LocaleMatcher.html#getLikelyLocale">getLikelyLocale</a></li><li data-type='method'><a href="LocaleMatcher.html#getLikelyLocaleMinimal">getLikelyLocaleMinimal</a></li><li data-type='method'><a href="LocaleMatcher.html#getLocale">getLocale</a></li><li data-type='method'><a href="LocaleMatcher.html#getMacroLanguage">getMacroLanguage</a></li><li data-type='method'><a href="LocaleMatcher.html#getRegionContainment">getRegionContainment</a></li><li data-type='method'><a href="LocaleMatcher.html#match">match</a></li><li data-type='method'><a href="LocaleMatcher.html#smallestCommonRegion">smallestCommonRegion</a></li></ul></li></ul>
-</nav>
-<div id="main">
-    <h1 class="page-title">LocaleMatcher</h1>
-<section>
-<header>
-        <h2>
-            LocaleMatcher
-        </h2>
-            <div class="class-description usertext">Represent a locale matcher instance, which is used
-to see which locales can be matched with each other in
-various ways.</div>
-</header>
-<article>
-        <div class="container-overview">
-    <h2>Constructor</h2>
-    <h4 class="name" id="LocaleMatcher"><span class="type-signature"></span>new LocaleMatcher<span class="signature">(options)</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Create a new locale matcher instance. This is used
-to see which locales can be matched with each other in
-various ways.<p>
-The options object may contain any of the following properties:
-<ul>
-<li><i>locale</i> - the locale instance or locale spec to match
-</ul></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="LocaleMatcher.js.html">LocaleMatcher.js</a>, <a href="LocaleMatcher.js.html#line53">line 53</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-parameters">Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type">Object</span>
-            </td>
-            <td class="description last">parameters to initialize this matcher</td>
-        </tr>
-    </tbody>
-</table>
-        </div>
-        <h3 class="subsection-title">Methods</h3>
-    <h4 class="name" id="getLikelyLocale"><span class="type-signature"></span>getLikelyLocale<span class="signature">()</span><span class="type-signature"> &rarr; {Locale}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Return an Locale instance that is fully specified based on partial information
-given to the constructor of this locale matcher instance. For example, if the locale
-spec given to this locale matcher instance is simply "ru" (for the Russian language),
-then it will fill in the missing region and script tags and return a locale with
-the specifier "ru-Cyrl-RU". (ie. Russian language, Cyrillic, Russian Federation).
-Any one or two of the language, script, or region parts may be left unspecified,
-and the other one or two parts will be filled in automatically. If this
-class has no information about the given locale, then the locale of this
-locale matcher instance is returned unchanged.</li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="LocaleMatcher.js.html">LocaleMatcher.js</a>, <a href="LocaleMatcher.js.html#line132">line 132</a>
-    </li></ul></dd>
-</dl>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    the most likely completion of the partial locale given
-to the constructor of this locale matcher instance
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Locale</span>
-    </dd>
-</dl>
-    <h4 class="name" id="getLikelyLocaleMinimal"><span class="type-signature"></span>getLikelyLocaleMinimal<span class="signature">()</span><span class="type-signature"> &rarr; {Locale}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Return an Locale instance that is specified based on partial information
-given to the constructor of this locale matcher instance but which leaves out any
-part of the locale specifier that is so common that it is understood. For example,
-if the locale
-spec given to this locale matcher instance is simply "ru" (for the Russian language),
-then it will fill in the missing region and/or script tags and return a locale with
-the specifier "ru-RU". (ie. Russian language, Russian Federation). Note that the
-default script "Cyrl" is left out because the vast majority of text written in
-Russian is written with the Cyrllic script, so that part of the locale is understood
-and is commonly left out.<p>
-Any one or two of the language, script, or region parts may be left unspecified,
-and the other one or two parts will be filled in automatically. If this
-class has no information about the given locale, then the locale of this
-locale matcher instance is returned unchanged.<p>
-This method returns the same information as getLikelyLocale but with the very common
-parts left out.</li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="LocaleMatcher.js.html">LocaleMatcher.js</a>, <a href="LocaleMatcher.js.html#line160">line 160</a>
-    </li></ul></dd>
-</dl>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    the most likely "minimal" completion of the partial locale given
-to the constructor of this locale matcher instance where the commonly understood
-parts are left out.
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Locale</span>
-    </dd>
-</dl>
-    <h4 class="name" id="getLocale"><span class="type-signature"></span>getLocale<span class="signature">()</span><span class="type-signature"> &rarr; {Locale|undefined}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Return the locale used to construct this instance.</li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="LocaleMatcher.js.html">LocaleMatcher.js</a>, <a href="LocaleMatcher.js.html#line80">line 80</a>
-    </li></ul></dd>
-</dl>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    the locale for this matcher
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Locale</span>
-|
-<span class="param-type">undefined</span>
-    </dd>
-</dl>
-    <h4 class="name" id="getMacroLanguage"><span class="type-signature"></span>getMacroLanguage<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Return the macrolanguage associated with this locale. If the
-locale's language is not part of a macro-language, then the
-locale's language is returned as-is.</li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="LocaleMatcher.js.html">LocaleMatcher.js</a>, <a href="LocaleMatcher.js.html#line330">line 330</a>
-    </li></ul></dd>
-</dl>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    the ISO code for the macrolanguage associated
-with this locale, or language of the locale
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">string</span>
-    </dd>
-</dl>
-    <h4 class="name" id="getRegionContainment"><span class="type-signature"></span>getRegionContainment<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Return the list of regions that this locale is contained within. Regions are
-nested, so locales can be in multiple regions. (eg. US is in Northern North
-America, North America, the Americas, the World.) Most regions are specified
-using UN.49 region numbers, though some, like "EU", are letters. If the
-locale is underspecified, this method will use the most likely locale method
-to get the region first. For example, the locale "ja" (Japanese) is most
-likely "ja-JP" (Japanese for Japan), and the region containment info for Japan
-is returned.</li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="LocaleMatcher.js.html">LocaleMatcher.js</a>, <a href="LocaleMatcher.js.html#line354">line 354</a>
-    </li></ul></dd>
-</dl>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    an array of region specifiers that this locale is within
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">Array.&lt;string></span>
-    </dd>
-</dl>
-    <h4 class="name" id="match"><span class="type-signature"></span>match<span class="signature">(locale)</span><span class="type-signature"> &rarr; {number}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Return the degree that the given locale matches the current locale of this
-matcher. This method returns an integer from 0 to 100. A value of 100 is
-a 100% match, meaning that the two locales are exactly equivalent to each
-other. (eg. "ja-JP" and "ja-JP") A value of 0 means that there 0% match or
-that the two locales have nothing in common. (eg. "en-US" and "ja-JP") <p>
-Locale matching is not the same as equivalence, as the degree of matching
-is returned. (See Locale.equals for equivalence.)<p>
-The match score is calculated based on matching the 4 locale components,
-weighted by importance:
-<ul>
-<li> language - this accounts for 50% of the match score
-<li> region - accounts for 25% of the match score
-<li> script - accounts for 20% of the match score
-<li> variant - accounts for 5% of the match score
-</ul>
-The score is affected by the following things:
-<ul>
-<li> A large language score is given when the language components of the locales
-match exactly.
-<li> Higher language scores are given when the languages are linguistically
-close to each other, such as dialects.
-<li> A small score is given when two languages are in the same
-linguistic family, but one is not a dialect of the other, such as German
-and Dutch.
-<li> A large region score is given when two locales share the same region.
-<li> A smaller region score is given when one region is contained within
-another. For example, Hong Kong is part of China, so a moderate score is
-given instead of a full score.
-<li> A small score is given if two regions are geographically close to
-each other or are tied by history. For example, Ireland and Great Britain
-are both adjacent and tied by history, so they receive a moderate score.
-<li> A high script score is given if the two locales share the same script.
-The legibility of a common script means that there is some small kinship of the
-different languages.
-<li> A high variant score is given if the two locales share the same
-variant. Full score is given when both locales have no variant at all.
-<li> Locale components that are unspecified in both locales are given high
-scores.
-<li> Locales where a particular locale component is missing in only one
-locale can still match when the default for that locale component matches
-the component in the other locale. The
-default value for the missing component is determined using the likely locales
-data. (See getLikelyLocale()) For example, "en-US" and "en-Latn-US" receive
-a high script score because the default script for "en" is "Latn".
-</ul>
-The intention of this method is that it can be used to determine
-compatibility of locales. For example, when a user signs up for an
-account on a web site, the locales that the web site supports and
-the locale of the user's browser may differ, and the site needs to
-pick the best locale to show the user. Let's say the
-web site supports a selection of European languages such as "it-IT",
-"fr-FR", "de-DE", and "en-GB". The user's
-browser may be set to "it-CH". The web site code can then match "it-CH"
-against each of the supported locales to find the one with the
-highest score. In
-this case, the best match would be "it-IT" because it shares a
-language and script in common with "it-CH" and differs only in the region
-component. It is not a 100% match, but it is pretty good. The web site
-may decide if the match scores all fall
-below a chosen threshold (perhaps 50%?), it should show the user the
-default language "en-GB", because that is probably a better choice
-than any other supported locale.<p></li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="LocaleMatcher.js.html">LocaleMatcher.js</a>, <a href="LocaleMatcher.js.html#line242">line 242</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-parameters">Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>locale</code></td>
-            <td class="type">
-<span class="param-type">Locale</span>
-            </td>
-            <td class="description last">the other locale to match against the current one</td>
-        </tr>
-    </tbody>
-</table>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    an integer from 0 to 100 that indicates the degree to
-which these locales match each other
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">number</span>
-    </dd>
-</dl>
-    <h4 class="name" id="smallestCommonRegion"><span class="type-signature"></span>smallestCommonRegion<span class="signature">(otherLocale)</span><span class="type-signature"> &rarr; {string}</span></h4>
-<dl class="details">
-    <dt class="tag-description">Description:</dt>
-    <dd class="tag-description"><ul class="dummy"><li>Find the smallest region that contains both the current locale and the other locale.
-If the current or other locales are underspecified, this method will use the most
-likely locale method
-to get their regions first. For example, the locale "ja" (Japanese) is most
-likely "ja-JP" (Japanese for Japan), and the region containment info for Japan
-is checked against the other locale's region containment info.</li></ul></dd>
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="LocaleMatcher.js.html">LocaleMatcher.js</a>, <a href="LocaleMatcher.js.html#line372">line 372</a>
-    </li></ul></dd>
-</dl>
-    <h5 class="h5-parameters">Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>otherLocale</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-|
-<span class="param-type">Locale</span>
-            </td>
-            <td class="description last">a locale specifier or a Locale instance to
-compare against</td>
-        </tr>
-    </tbody>
-</table>
-<h5 class="h5-returns">Returns:</h5>
-<div class="param-desc">
-    the region specifier of the smallest region containing both the
-current locale and other locale
-</div>
-<dl class="param-type">
-    <dt>
-        Type
-    </dt>
-    <dd>
-<span class="param-type">string</span>
-    </dd>
-</dl>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Aug 13 2024 10:25:31 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/polyfill.js"></script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>