npm - ilib-localematcher - Versions diffs - 1.2.2 → 1.3.0 - Mend

ilib-localematcher 1.2.2 → 1.3.0

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 (15) hide show

package/README.md +4 -0
package/docs/LocaleMatcher.html +146 -147
package/docs/LocaleMatcher.js.html +4 -1
package/docs/index.html +4 -1
package/docs/scripts/collapse.js +19 -0
package/docs/scripts/commonNav.js +28 -0
package/docs/scripts/search.js +16 -0
package/docs/styles/jsdoc.css +13 -2
package/docs/styles/prettify.css +1 -0
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 +17 -17
package/src/localematch.js +19867 -1987

package/README.md CHANGED Viewed

@@ -65,6 +65,10 @@ limitations under the License.
 ## Release Notes
+### v1.3.0
+* Update to CLDR v44.0.0
 ### v1.2.2
 * This module is now a hybrid ESM/CommonJS package that works under node

package/docs/LocaleMatcher.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <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>
@@ -27,7 +28,9 @@
 <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">
@@ -45,7 +48,9 @@
 <header>
         <h2>
-        LocaleMatcher
+            LocaleMatcher
         </h2>
             <div class="class-description usertext">Represent a locale matcher instance, which is used
@@ -73,6 +78,18 @@ various ways.</div>
 <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>
@@ -116,19 +133,6 @@ various ways.</div>
-<div class="description usertext">
-    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>
-</div>
@@ -137,8 +141,7 @@ The options object may contain any of the following properties:
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
 <table class="params">
@@ -172,6 +175,7 @@ The options object may contain any of the following properties:
 <span class="param-type">Object</span>
             </td>
@@ -238,6 +242,18 @@ The options object may contain any of the following properties:
 <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>
@@ -281,20 +297,6 @@ The options object may contain any of the following properties:
-<div class="description usertext">
-    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.
-</div>
@@ -317,7 +319,7 @@ locale matcher instance is returned unchanged.
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -336,6 +338,7 @@ to the constructor of this locale matcher instance
 <span class="param-type">Locale</span>
     </dd>
 </dl>
@@ -356,6 +359,27 @@ to the constructor of this locale matcher instance
 <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>
@@ -399,29 +423,6 @@ to the constructor of this locale matcher instance
-<div class="description usertext">
-    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.
-</div>
@@ -444,7 +445,7 @@ parts left out.
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -464,6 +465,7 @@ parts are left out.
 <span class="param-type">Locale</span>
     </dd>
 </dl>
@@ -484,6 +486,10 @@ parts are left out.
 <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>
@@ -527,12 +533,6 @@ parts are left out.
-<div class="description usertext">
-    Return the locale used to construct this instance.
-</div>
@@ -555,7 +555,7 @@ parts are left out.
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -576,6 +576,7 @@ parts are left out.
 <span class="param-type">undefined</span>
     </dd>
 </dl>
@@ -596,6 +597,12 @@ parts are left out.
 <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>
@@ -639,14 +646,6 @@ parts are left out.
-<div class="description usertext">
-    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.
-</div>
@@ -669,7 +668,7 @@ locale's language is returned as-is.
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -688,6 +687,7 @@ with this locale, or language of the locale
 <span class="param-type">string</span>
     </dd>
 </dl>
@@ -708,6 +708,17 @@ with this locale, or language of the locale
 <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>
@@ -751,17 +762,6 @@ with this locale, or language of the locale
-<div class="description usertext">
-    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.
-</div>
@@ -784,9 +784,7 @@ is returned.
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -804,6 +802,7 @@ is returned.
 <span class="param-type">Array.&lt;string></span>
     </dd>
 </dl>
@@ -824,51 +823,9 @@ is returned.
 <dl class="details">
-    <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>
-<div class="description usertext">
-    Return the degree that the given locale matches the current locale of this
+    <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
@@ -935,8 +892,47 @@ 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>
-</div>
+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>
@@ -948,7 +944,8 @@ than any other supported locale.<p>
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
 <table class="params">
@@ -982,6 +979,7 @@ than any other supported locale.<p>
 <span class="param-type">Locale</span>
             </td>
@@ -1011,7 +1009,7 @@ than any other supported locale.<p>
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -1030,6 +1028,7 @@ which these locales match each other
 <span class="param-type">number</span>
     </dd>
 </dl>
@@ -1050,6 +1049,15 @@ which these locales match each other
 <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>
@@ -1093,17 +1101,6 @@ which these locales match each other
-<div class="description usertext">
-    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.
-</div>
@@ -1112,7 +1109,7 @@ is checked against the other locale's region containment info.
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
 <table class="params">
@@ -1149,6 +1146,7 @@ is checked against the other locale's region containment info.
 <span class="param-type">Locale</span>
             </td>
@@ -1179,7 +1177,7 @@ compare against</td>
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 <div class="param-desc">
@@ -1198,6 +1196,7 @@ current locale and other locale
 <span class="param-type">string</span>
     </dd>
 </dl>
@@ -1225,7 +1224,7 @@ current locale and other locale
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Aug 30 2022 08:15:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Nov 21 2023 19:43:43 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>

package/docs/LocaleMatcher.js.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <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>
@@ -27,7 +28,9 @@
 <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">
@@ -451,7 +454,7 @@ export default LocaleMatcher;
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Aug 30 2022 08:15:13 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Nov 21 2023 19:43:43 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>

package/docs/index.html CHANGED Viewed

@@ -14,6 +14,7 @@
     <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>
@@ -27,7 +28,9 @@
 <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">
@@ -68,7 +71,7 @@
 <br class="clear">
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Aug 30 2022 08:15:14 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Nov 21 2023 19:43:43 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 <script>prettyPrint();</script>

package/docs/scripts/collapse.js CHANGED Viewed

@@ -1,15 +1,34 @@
 function hideAllButCurrent(){
     //by default all submenut items are hidden
     //but we need to rehide them for search
+    document.querySelectorAll("nav > ul").forEach(function(parent) {
+        if (parent.className.indexOf("collapse_top") !== -1) {
+            parent.style.display = "none";
+        }
+    });
     document.querySelectorAll("nav > ul > li > ul li").forEach(function(parent) {
         parent.style.display = "none";
     });
+    document.querySelectorAll("nav > h3").forEach(function(section) {
+        if (section.className.indexOf("collapsed_header") !== -1) {
+            section.addEventListener("click", function(){
+                if (section.nextSibling.style.display === "none") {
+                    section.nextSibling.style.display = "block";
+                } else {
+                    section.nextSibling.style.display = "none";
+                }
+            });
+        }
+    });
     //only current page (if it exists) should be opened
     var file = window.location.pathname.split("/").pop().replace(/\.html/, '');
     document.querySelectorAll("nav > ul > li > a").forEach(function(parent) {
         var href = parent.attributes.href.value.replace(/\.html/, '');
         if (file === href) {
+            if (parent.parentNode.parentNode.className.indexOf("collapse_top") !== -1) {
+                parent.parentNode.parentNode.style.display = "block";
+            }
             parent.parentNode.querySelectorAll("ul li").forEach(function(elem) {
                 elem.style.display = "block";
             });

package/docs/scripts/commonNav.js ADDED Viewed

@@ -0,0 +1,28 @@
+if (typeof fetch === 'function') {
+  const init = () => {
+    if (typeof scrollToNavItem !== 'function') return false
+    scrollToNavItem()
+    // hideAllButCurrent not always loaded
+    if (typeof hideAllButCurrent === 'function') hideAllButCurrent()
+    return true
+  }
+  fetch('./nav.inc.html')
+    .then(response => response.ok ? response.text() : `${response.url} => ${response.status} ${response.statusText}`)
+    .then(body => {
+      document.querySelector('nav').innerHTML += body
+      // nav.js should be quicker to load than nav.inc.html, a fallback just in case
+      return init()
+    })
+    .then(done => {
+      if (done) return
+      let i = 0
+      ;(function waitUntilNavJs () {
+        if (init()) return
+        if (i++ < 100) return setTimeout(waitUntilNavJs, 300)
+        console.error(Error('nav.js not loaded after 30s waiting for it'))
+      })()
+    })
+    .catch(error => console.error(error))
+} else {
+  console.error(Error('Browser too old to display commonNav (remove commonNav docdash option)'))
+}