ilib-tools-common 1.2.0 → 1.4.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 (30) hide show
  1. package/README.md +16 -1
  2. package/docs/Resource.html +260 -279
  3. package/docs/Resource.js.html +5 -2
  4. package/docs/ResourceArray.html +488 -512
  5. package/docs/ResourceArray.js.html +5 -2
  6. package/docs/ResourcePlural.html +518 -545
  7. package/docs/ResourcePlural.js.html +5 -2
  8. package/docs/ResourceString.html +1066 -1077
  9. package/docs/ResourceString.js.html +5 -2
  10. package/docs/ResourceXliff.html +34 -30
  11. package/docs/ResourceXliff.js.html +5 -2
  12. package/docs/TranslationSet.html +157 -160
  13. package/docs/TranslationSet.js.html +5 -2
  14. package/docs/TranslationUnit.html +1132 -0
  15. package/docs/TranslationUnit.js.html +249 -0
  16. package/docs/TranslationVariant.html +363 -0
  17. package/docs/TranslationVariant.js.html +122 -0
  18. package/docs/global.html +545 -36
  19. package/docs/index.html +5 -2
  20. package/docs/scripts/collapse.js +19 -0
  21. package/docs/scripts/commonNav.js +28 -0
  22. package/docs/scripts/search.js +16 -0
  23. package/docs/styles/jsdoc.css +13 -2
  24. package/docs/styles/prettify.css +1 -0
  25. package/docs/utils.js.html +96 -3
  26. package/package.json +5 -4
  27. package/src/TranslationUnit.js +178 -0
  28. package/src/TranslationVariant.js +51 -0
  29. package/src/index.js +19 -2
  30. package/src/utils.js +91 -1
package/docs/TranslationSet.html CHANGED
@@ -14,6 +14,7 @@
14
14
  <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
15
  <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
16
  <script src="scripts/nav.js" defer></script>
17
+
17
18
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
19
  </head>
19
20
  <body>
@@ -27,7 +28,9 @@
27
28
 
28
29
  <nav >
29
30
 
30
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Resource.html">Resource</a><ul class='methods'><li data-type='method'><a href="Resource.html#addInstance">addInstance</a></li><li data-type='method'><a href="Resource.html#escapeText">escapeText</a></li><li data-type='method'><a href="Resource.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="Resource.html#getComment">getComment</a></li><li data-type='method'><a href="Resource.html#getContext">getContext</a></li><li data-type='method'><a href="Resource.html#getDataType">getDataType</a></li><li data-type='method'><a href="Resource.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="Resource.html#getId">getId</a></li><li data-type='method'><a href="Resource.html#getInstances">getInstances</a></li><li data-type='method'><a href="Resource.html#getKey">getKey</a></li><li data-type='method'><a href="Resource.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="Resource.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="Resource.html#getPath">getPath</a></li><li data-type='method'><a href="Resource.html#getProject">getProject</a></li><li data-type='method'><a href="Resource.html#getSource">getSource</a></li><li data-type='method'><a href="Resource.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="Resource.html#getState">getState</a></li><li data-type='method'><a href="Resource.html#getTarget">getTarget</a></li><li data-type='method'><a href="Resource.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="Resource.html#getType">getType</a></li><li data-type='method'><a href="Resource.html#isInstance">isInstance</a></li><li data-type='method'><a href="Resource.html#same">same</a></li><li data-type='method'><a href="Resource.html#setComment">setComment</a></li><li data-type='method'><a href="Resource.html#setProject">setProject</a></li><li data-type='method'><a href="Resource.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="Resource.html#setState">setState</a></li><li data-type='method'><a href="Resource.html#setTargetLocale">setTargetLocale</a></li></ul></li><li><a href="ResourceArray.html">ResourceArray</a><ul class='methods'><li data-type='method'><a href="ResourceArray.html#.hashKey">hashKey</a></li><li data-type='method'><a href="ResourceArray.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourceArray.html#addSourceItem">addSourceItem</a></li><li data-type='method'><a href="ResourceArray.html#addTargetItem">addTargetItem</a></li><li data-type='method'><a href="ResourceArray.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceArray.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourceArray.html#clone">clone</a></li><li data-type='method'><a href="ResourceArray.html#equals">equals</a></li><li data-type='method'><a href="ResourceArray.html#equals">equals</a></li><li data-type='method'><a href="ResourceArray.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourceArray.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourceArray.html#getComment">getComment</a></li><li data-type='method'><a href="ResourceArray.html#getContext">getContext</a></li><li data-type='method'><a href="ResourceArray.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourceArray.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourceArray.html#getId">getId</a></li><li data-type='method'><a href="ResourceArray.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourceArray.html#getKey">getKey</a></li><li data-type='method'><a href="ResourceArray.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourceArray.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourceArray.html#getPath">getPath</a></li><li data-type='method'><a href="ResourceArray.html#getProject">getProject</a></li><li data-type='method'><a href="ResourceArray.html#getSource">getSource</a></li><li data-type='method'><a href="ResourceArray.html#getSourceArray">getSourceArray</a></li><li data-type='method'><a href="ResourceArray.html#getSourceItem">getSourceItem</a></li><li data-type='method'><a href="ResourceArray.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourceArray.html#getState">getState</a></li><li data-type='method'><a href="ResourceArray.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourceArray.html#getTargetArray">getTargetArray</a></li><li data-type='method'><a href="ResourceArray.html#getTargetItem">getTargetItem</a></li><li data-type='method'><a href="ResourceArray.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourceArray.html#getType">getType</a></li><li data-type='method'><a href="ResourceArray.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourceArray.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourceArray.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourceArray.html#same">same</a></li><li data-type='method'><a href="ResourceArray.html#setComment">setComment</a></li><li data-type='method'><a href="ResourceArray.html#setProject">setProject</a></li><li data-type='method'><a href="ResourceArray.html#setSource">setSource</a></li><li data-type='method'><a href="ResourceArray.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourceArray.html#setState">setState</a></li><li data-type='method'><a href="ResourceArray.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourceArray.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourceArray.html#size">size</a></li></ul></li><li><a href="ResourcePlural.html">ResourcePlural</a><ul class='methods'><li data-type='method'><a href="ResourcePlural.html#.hashKey">hashKey</a></li><li data-type='method'><a href="ResourcePlural.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourcePlural.html#addSourcePlural">addSourcePlural</a></li><li data-type='method'><a href="ResourcePlural.html#addTargetPlural">addTargetPlural</a></li><li data-type='method'><a href="ResourcePlural.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourcePlural.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourcePlural.html#clone">clone</a></li><li data-type='method'><a href="ResourcePlural.html#equals">equals</a></li><li data-type='method'><a href="ResourcePlural.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourcePlural.html#getAllValidCategories">getAllValidCategories</a></li><li data-type='method'><a href="ResourcePlural.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourcePlural.html#getCategories">getCategories</a></li><li data-type='method'><a href="ResourcePlural.html#getClasses">getClasses</a></li><li data-type='method'><a href="ResourcePlural.html#getComment">getComment</a></li><li data-type='method'><a href="ResourcePlural.html#getContext">getContext</a></li><li data-type='method'><a href="ResourcePlural.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourcePlural.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourcePlural.html#getId">getId</a></li><li data-type='method'><a href="ResourcePlural.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourcePlural.html#getKey">getKey</a></li><li data-type='method'><a href="ResourcePlural.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourcePlural.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourcePlural.html#getPath">getPath</a></li><li data-type='method'><a href="ResourcePlural.html#getProject">getProject</a></li><li data-type='method'><a href="ResourcePlural.html#getSource">getSource</a></li><li data-type='method'><a href="ResourcePlural.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourcePlural.html#getSourcePlural">getSourcePlural</a></li><li data-type='method'><a href="ResourcePlural.html#getSourcePlurals">getSourcePlurals</a></li><li data-type='method'><a href="ResourcePlural.html#getSourceStrings">getSourceStrings</a></li><li data-type='method'><a href="ResourcePlural.html#getState">getState</a></li><li data-type='method'><a href="ResourcePlural.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetPlural">getTargetPlural</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetPlurals">getTargetPlurals</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetStrings">getTargetStrings</a></li><li data-type='method'><a href="ResourcePlural.html#getType">getType</a></li><li data-type='method'><a href="ResourcePlural.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourcePlural.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourcePlural.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourcePlural.html#same">same</a></li><li data-type='method'><a href="ResourcePlural.html#setComment">setComment</a></li><li data-type='method'><a href="ResourcePlural.html#setProject">setProject</a></li><li data-type='method'><a href="ResourcePlural.html#setSource">setSource</a></li><li data-type='method'><a href="ResourcePlural.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourcePlural.html#setState">setState</a></li><li data-type='method'><a href="ResourcePlural.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourcePlural.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourcePlural.html#size">size</a></li></ul></li><li><a href="ResourceString.html">ResourceString</a><ul class='methods'><li data-type='method'><a href="ResourceString.html#.cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceString.html#.hashKey">hashKey</a></li><li data-type='method'><a href="ResourceString.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourceString.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceString.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourceString.html#clone">clone</a></li><li data-type='method'><a href="ResourceString.html#equals">equals</a></li><li data-type='method'><a href="ResourceString.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourceString.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourceString.html#getComment">getComment</a></li><li data-type='method'><a href="ResourceString.html#getContext">getContext</a></li><li data-type='method'><a href="ResourceString.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourceString.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourceString.html#getId">getId</a></li><li data-type='method'><a href="ResourceString.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourceString.html#getKey">getKey</a></li><li data-type='method'><a href="ResourceString.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourceString.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourceString.html#getPath">getPath</a></li><li data-type='method'><a href="ResourceString.html#getProject">getProject</a></li><li data-type='method'><a href="ResourceString.html#getSource">getSource</a></li><li data-type='method'><a href="ResourceString.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourceString.html#getState">getState</a></li><li data-type='method'><a href="ResourceString.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourceString.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourceString.html#getType">getType</a></li><li data-type='method'><a href="ResourceString.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourceString.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourceString.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourceString.html#same">same</a></li><li data-type='method'><a href="ResourceString.html#setComment">setComment</a></li><li data-type='method'><a href="ResourceString.html#setProject">setProject</a></li><li data-type='method'><a href="ResourceString.html#setSource">setSource</a></li><li data-type='method'><a href="ResourceString.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourceString.html#setState">setState</a></li><li data-type='method'><a href="ResourceString.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourceString.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourceString.html#size">size</a></li></ul></li><li><a href="ResourceXliff.html">ResourceXliff</a></li><li><a href="TranslationSet.html">TranslationSet</a><ul class='methods'><li data-type='method'><a href="TranslationSet.html#add">add</a></li><li data-type='method'><a href="TranslationSet.html#addAll">addAll</a></li><li data-type='method'><a href="TranslationSet.html#addSet">addSet</a></li><li data-type='method'><a href="TranslationSet.html#clear">clear</a></li><li data-type='method'><a href="TranslationSet.html#diff">diff</a></li><li data-type='method'><a href="TranslationSet.html#get">get</a></li><li data-type='method'><a href="TranslationSet.html#getAll">getAll</a></li><li data-type='method'><a href="TranslationSet.html#getBy">getBy</a></li><li data-type='method'><a href="TranslationSet.html#getBySource">getBySource</a></li><li data-type='method'><a href="TranslationSet.html#getClean">getClean</a></li><li data-type='method'><a href="TranslationSet.html#getContexts">getContexts</a></li><li data-type='method'><a href="TranslationSet.html#getLocales">getLocales</a></li><li data-type='method'><a href="TranslationSet.html#getProjects">getProjects</a></li><li data-type='method'><a href="TranslationSet.html#isDirty">isDirty</a></li><li data-type='method'><a href="TranslationSet.html#remove">remove</a></li><li data-type='method'><a href="TranslationSet.html#setClean">setClean</a></li><li data-type='method'><a href="TranslationSet.html#size">size</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#cleanString">cleanString</a></li><li><a href="global.html#formatPath">formatPath</a></li><li><a href="global.html#getLocaleFromPath">getLocaleFromPath</a></li><li><a href="global.html#isEmpty">isEmpty</a></li></ul>
31
+
32
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Resource.html">Resource</a><ul class='methods'><li data-type='method'><a href="Resource.html#addInstance">addInstance</a></li><li data-type='method'><a href="Resource.html#escapeText">escapeText</a></li><li data-type='method'><a href="Resource.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="Resource.html#getComment">getComment</a></li><li data-type='method'><a href="Resource.html#getContext">getContext</a></li><li data-type='method'><a href="Resource.html#getDataType">getDataType</a></li><li data-type='method'><a href="Resource.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="Resource.html#getId">getId</a></li><li data-type='method'><a href="Resource.html#getInstances">getInstances</a></li><li data-type='method'><a href="Resource.html#getKey">getKey</a></li><li data-type='method'><a href="Resource.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="Resource.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="Resource.html#getPath">getPath</a></li><li data-type='method'><a href="Resource.html#getProject">getProject</a></li><li data-type='method'><a href="Resource.html#getSource">getSource</a></li><li data-type='method'><a href="Resource.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="Resource.html#getState">getState</a></li><li data-type='method'><a href="Resource.html#getTarget">getTarget</a></li><li data-type='method'><a href="Resource.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="Resource.html#getType">getType</a></li><li data-type='method'><a href="Resource.html#isInstance">isInstance</a></li><li data-type='method'><a href="Resource.html#same">same</a></li><li data-type='method'><a href="Resource.html#setComment">setComment</a></li><li data-type='method'><a href="Resource.html#setProject">setProject</a></li><li data-type='method'><a href="Resource.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="Resource.html#setState">setState</a></li><li data-type='method'><a href="Resource.html#setTargetLocale">setTargetLocale</a></li></ul></li><li><a href="ResourceArray.html">ResourceArray</a><ul class='methods'><li data-type='method'><a href="ResourceArray.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourceArray.html#addSourceItem">addSourceItem</a></li><li data-type='method'><a href="ResourceArray.html#addTargetItem">addTargetItem</a></li><li data-type='method'><a href="ResourceArray.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceArray.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourceArray.html#clone">clone</a></li><li data-type='method'><a href="ResourceArray.html#equals">equals</a></li><li data-type='method'><a href="ResourceArray.html#equals">equals</a></li><li data-type='method'><a href="ResourceArray.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourceArray.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourceArray.html#getComment">getComment</a></li><li data-type='method'><a href="ResourceArray.html#getContext">getContext</a></li><li data-type='method'><a href="ResourceArray.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourceArray.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourceArray.html#getId">getId</a></li><li data-type='method'><a href="ResourceArray.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourceArray.html#getKey">getKey</a></li><li data-type='method'><a href="ResourceArray.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourceArray.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourceArray.html#getPath">getPath</a></li><li data-type='method'><a href="ResourceArray.html#getProject">getProject</a></li><li data-type='method'><a href="ResourceArray.html#getSource">getSource</a></li><li data-type='method'><a href="ResourceArray.html#getSourceArray">getSourceArray</a></li><li data-type='method'><a href="ResourceArray.html#getSourceItem">getSourceItem</a></li><li data-type='method'><a href="ResourceArray.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourceArray.html#getState">getState</a></li><li data-type='method'><a href="ResourceArray.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourceArray.html#getTargetArray">getTargetArray</a></li><li data-type='method'><a href="ResourceArray.html#getTargetItem">getTargetItem</a></li><li data-type='method'><a href="ResourceArray.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourceArray.html#getType">getType</a></li><li data-type='method'><a href="ResourceArray.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourceArray.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourceArray.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourceArray.html#same">same</a></li><li data-type='method'><a href="ResourceArray.html#setComment">setComment</a></li><li data-type='method'><a href="ResourceArray.html#setProject">setProject</a></li><li data-type='method'><a href="ResourceArray.html#setSource">setSource</a></li><li data-type='method'><a href="ResourceArray.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourceArray.html#setState">setState</a></li><li data-type='method'><a href="ResourceArray.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourceArray.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourceArray.html#size">size</a></li><li data-type='method'><a href="ResourceArray.html#.hashKey">hashKey</a></li></ul></li><li><a href="ResourcePlural.html">ResourcePlural</a><ul class='methods'><li data-type='method'><a href="ResourcePlural.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourcePlural.html#addSourcePlural">addSourcePlural</a></li><li data-type='method'><a href="ResourcePlural.html#addTargetPlural">addTargetPlural</a></li><li data-type='method'><a href="ResourcePlural.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourcePlural.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourcePlural.html#clone">clone</a></li><li data-type='method'><a href="ResourcePlural.html#equals">equals</a></li><li data-type='method'><a href="ResourcePlural.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourcePlural.html#getAllValidCategories">getAllValidCategories</a></li><li data-type='method'><a href="ResourcePlural.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourcePlural.html#getCategories">getCategories</a></li><li data-type='method'><a href="ResourcePlural.html#getClasses">getClasses</a></li><li data-type='method'><a href="ResourcePlural.html#getComment">getComment</a></li><li data-type='method'><a href="ResourcePlural.html#getContext">getContext</a></li><li data-type='method'><a href="ResourcePlural.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourcePlural.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourcePlural.html#getId">getId</a></li><li data-type='method'><a href="ResourcePlural.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourcePlural.html#getKey">getKey</a></li><li data-type='method'><a href="ResourcePlural.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourcePlural.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourcePlural.html#getPath">getPath</a></li><li data-type='method'><a href="ResourcePlural.html#getProject">getProject</a></li><li data-type='method'><a href="ResourcePlural.html#getSource">getSource</a></li><li data-type='method'><a href="ResourcePlural.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourcePlural.html#getSourcePlural">getSourcePlural</a></li><li data-type='method'><a href="ResourcePlural.html#getSourcePlurals">getSourcePlurals</a></li><li data-type='method'><a href="ResourcePlural.html#getSourceStrings">getSourceStrings</a></li><li data-type='method'><a href="ResourcePlural.html#getState">getState</a></li><li data-type='method'><a href="ResourcePlural.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetPlural">getTargetPlural</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetPlurals">getTargetPlurals</a></li><li data-type='method'><a href="ResourcePlural.html#getTargetStrings">getTargetStrings</a></li><li data-type='method'><a href="ResourcePlural.html#getType">getType</a></li><li data-type='method'><a href="ResourcePlural.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourcePlural.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourcePlural.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourcePlural.html#same">same</a></li><li data-type='method'><a href="ResourcePlural.html#setComment">setComment</a></li><li data-type='method'><a href="ResourcePlural.html#setProject">setProject</a></li><li data-type='method'><a href="ResourcePlural.html#setSource">setSource</a></li><li data-type='method'><a href="ResourcePlural.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourcePlural.html#setState">setState</a></li><li data-type='method'><a href="ResourcePlural.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourcePlural.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourcePlural.html#size">size</a></li><li data-type='method'><a href="ResourcePlural.html#.hashKey">hashKey</a></li></ul></li><li><a href="ResourceString.html">ResourceString</a><ul class='methods'><li data-type='method'><a href="ResourceString.html#addInstance">addInstance</a></li><li data-type='method'><a href="ResourceString.html#cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceString.html#cleanHashKeyForTranslation">cleanHashKeyForTranslation</a></li><li data-type='method'><a href="ResourceString.html#clone">clone</a></li><li data-type='method'><a href="ResourceString.html#equals">equals</a></li><li data-type='method'><a href="ResourceString.html#escapeText">escapeText</a></li><li data-type='method'><a href="ResourceString.html#getAutoKey">getAutoKey</a></li><li data-type='method'><a href="ResourceString.html#getComment">getComment</a></li><li data-type='method'><a href="ResourceString.html#getContext">getContext</a></li><li data-type='method'><a href="ResourceString.html#getDataType">getDataType</a></li><li data-type='method'><a href="ResourceString.html#getFlavor">getFlavor</a></li><li data-type='method'><a href="ResourceString.html#getId">getId</a></li><li data-type='method'><a href="ResourceString.html#getInstances">getInstances</a></li><li data-type='method'><a href="ResourceString.html#getKey">getKey</a></li><li data-type='method'><a href="ResourceString.html#getLocalize">getLocalize</a></li><li data-type='method'><a href="ResourceString.html#getOrigin">getOrigin</a></li><li data-type='method'><a href="ResourceString.html#getPath">getPath</a></li><li data-type='method'><a href="ResourceString.html#getProject">getProject</a></li><li data-type='method'><a href="ResourceString.html#getSource">getSource</a></li><li data-type='method'><a href="ResourceString.html#getSourceLocale">getSourceLocale</a></li><li data-type='method'><a href="ResourceString.html#getState">getState</a></li><li data-type='method'><a href="ResourceString.html#getTarget">getTarget</a></li><li data-type='method'><a href="ResourceString.html#getTargetLocale">getTargetLocale</a></li><li data-type='method'><a href="ResourceString.html#getType">getType</a></li><li data-type='method'><a href="ResourceString.html#hashKey">hashKey</a></li><li data-type='method'><a href="ResourceString.html#hashKeyForTranslation">hashKeyForTranslation</a></li><li data-type='method'><a href="ResourceString.html#isInstance">isInstance</a></li><li data-type='method'><a href="ResourceString.html#same">same</a></li><li data-type='method'><a href="ResourceString.html#setComment">setComment</a></li><li data-type='method'><a href="ResourceString.html#setProject">setProject</a></li><li data-type='method'><a href="ResourceString.html#setSource">setSource</a></li><li data-type='method'><a href="ResourceString.html#setSourceLocale">setSourceLocale</a></li><li data-type='method'><a href="ResourceString.html#setState">setState</a></li><li data-type='method'><a href="ResourceString.html#setTarget">setTarget</a></li><li data-type='method'><a href="ResourceString.html#setTargetLocale">setTargetLocale</a></li><li data-type='method'><a href="ResourceString.html#size">size</a></li><li data-type='method'><a href="ResourceString.html#.cleanHashKey">cleanHashKey</a></li><li data-type='method'><a href="ResourceString.html#.hashKey">hashKey</a></li></ul></li><li><a href="ResourceXliff.html">ResourceXliff</a></li><li><a href="TranslationSet.html">TranslationSet</a><ul class='methods'><li data-type='method'><a href="TranslationSet.html#add">add</a></li><li data-type='method'><a href="TranslationSet.html#addAll">addAll</a></li><li data-type='method'><a href="TranslationSet.html#addSet">addSet</a></li><li data-type='method'><a href="TranslationSet.html#clear">clear</a></li><li data-type='method'><a href="TranslationSet.html#diff">diff</a></li><li data-type='method'><a href="TranslationSet.html#get">get</a></li><li data-type='method'><a href="TranslationSet.html#getAll">getAll</a></li><li data-type='method'><a href="TranslationSet.html#getBy">getBy</a></li><li data-type='method'><a href="TranslationSet.html#getBySource">getBySource</a></li><li data-type='method'><a href="TranslationSet.html#getClean">getClean</a></li><li data-type='method'><a href="TranslationSet.html#getContexts">getContexts</a></li><li data-type='method'><a href="TranslationSet.html#getLocales">getLocales</a></li><li data-type='method'><a href="TranslationSet.html#getProjects">getProjects</a></li><li data-type='method'><a href="TranslationSet.html#isDirty">isDirty</a></li><li data-type='method'><a href="TranslationSet.html#remove">remove</a></li><li data-type='method'><a href="TranslationSet.html#setClean">setClean</a></li><li data-type='method'><a href="TranslationSet.html#size">size</a></li></ul></li><li><a href="TranslationUnit.html">TranslationUnit</a><ul class='methods'><li data-type='method'><a href="TranslationUnit.html#addProperties">addProperties</a></li><li data-type='method'><a href="TranslationUnit.html#addVariant">addVariant</a></li><li data-type='method'><a href="TranslationUnit.html#addVariants">addVariants</a></li><li data-type='method'><a href="TranslationUnit.html#clone">clone</a></li><li data-type='method'><a href="TranslationUnit.html#getProperties">getProperties</a></li><li data-type='method'><a href="TranslationUnit.html#getVariants">getVariants</a></li><li data-type='method'><a href="TranslationUnit.html#hashKey">hashKey</a></li></ul></li><li><a href="TranslationVariant.html">TranslationVariant</a><ul class='methods'><li data-type='method'><a href="TranslationVariant.html#hashKey">hashKey</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#cleanString">cleanString</a></li><li><a href="global.html#containsActualText">containsActualText</a></li><li><a href="global.html#formatPath">formatPath</a></li><li><a href="global.html#getLocaleFromPath">getLocaleFromPath</a></li><li><a href="global.html#hashKey">hashKey</a></li><li><a href="global.html#isEmpty">isEmpty</a></li><li><a href="global.html#objectMap">objectMap</a></li></ul>
33
+
31
34
  </nav>
32
35
 
33
36
  <div id="main">
@@ -45,7 +48,9 @@
45
48
  <header>
46
49
 
47
50
  <h2>
48
- TranslationSet
51
+
52
+ TranslationSet
53
+
49
54
  </h2>
50
55
 
51
56
  <div class="class-description usertext">A class that represents a set of translations used in
@@ -72,6 +77,7 @@ a project.</div>
72
77
 
73
78
 
74
79
  <dl class="details">
80
+
75
81
 
76
82
 
77
83
  <dt class="tag-source">Source:</dt>
@@ -123,9 +129,7 @@ a project.</div>
123
129
 
124
130
 
125
131
 
126
-
127
-
128
- <h5>Parameters:</h5>
132
+ <h5 class="h5-parameters">Parameters:</h5>
129
133
 
130
134
 
131
135
  <table class="params">
@@ -161,6 +165,7 @@ a project.</div>
161
165
  <span class="param-type">String</span>
162
166
 
163
167
 
168
+
164
169
 
165
170
  </td>
166
171
 
@@ -192,6 +197,7 @@ a project.</div>
192
197
  <span class="param-type">Object</span>
193
198
 
194
199
 
200
+
195
201
 
196
202
  </td>
197
203
 
@@ -268,6 +274,12 @@ a project.</div>
268
274
 
269
275
 
270
276
  <dl class="details">
277
+
278
+ <dt class="tag-description">Description:</dt>
279
+ <dd class="tag-description"><ul class="dummy"><li>Add a resource to this set. If this resource has the same key
280
+ as an existing resource, but a different locale, then this
281
+ resource is added a translation instead.</li></ul></dd>
282
+
271
283
 
272
284
 
273
285
  <dt class="tag-source">Source:</dt>
@@ -311,14 +323,6 @@ a project.</div>
311
323
 
312
324
 
313
325
 
314
- <div class="description usertext">
315
- Add a resource to this set. If this resource has the same key
316
- as an existing resource, but a different locale, then this
317
- resource is added a translation instead.
318
- </div>
319
-
320
-
321
-
322
326
 
323
327
 
324
328
 
@@ -327,7 +331,7 @@ resource is added a translation instead.
327
331
 
328
332
 
329
333
 
330
- <h5>Parameters:</h5>
334
+ <h5 class="h5-parameters">Parameters:</h5>
331
335
 
332
336
 
333
337
  <table class="params">
@@ -361,6 +365,7 @@ resource is added a translation instead.
361
365
  <span class="param-type"><a href="Resource.html">Resource</a></span>
362
366
 
363
367
 
368
+
364
369
 
365
370
  </td>
366
371
 
@@ -406,6 +411,10 @@ resource is added a translation instead.
406
411
 
407
412
 
408
413
  <dl class="details">
414
+
415
+ <dt class="tag-description">Description:</dt>
416
+ <dd class="tag-description"><ul class="dummy"><li>Add every resource in the given array to this set.</li></ul></dd>
417
+
409
418
 
410
419
 
411
420
  <dt class="tag-source">Source:</dt>
@@ -449,10 +458,6 @@ resource is added a translation instead.
449
458
 
450
459
 
451
460
 
452
- <div class="description usertext">
453
- Add every resource in the given array to this set.
454
- </div>
455
-
456
461
 
457
462
 
458
463
 
@@ -461,9 +466,7 @@ resource is added a translation instead.
461
466
 
462
467
 
463
468
 
464
-
465
-
466
- <h5>Parameters:</h5>
469
+ <h5 class="h5-parameters">Parameters:</h5>
467
470
 
468
471
 
469
472
  <table class="params">
@@ -497,6 +500,7 @@ resource is added a translation instead.
497
500
  <span class="param-type">Array.&lt;<a href="Resource.html">Resource</a>></span>
498
501
 
499
502
 
503
+
500
504
 
501
505
  </td>
502
506
 
@@ -543,6 +547,11 @@ to this set</td>
543
547
 
544
548
 
545
549
  <dl class="details">
550
+
551
+ <dt class="tag-description">Description:</dt>
552
+ <dd class="tag-description"><ul class="dummy"><li>Add every resource in the given translation set to this set,
553
+ merging the results together.</li></ul></dd>
554
+
546
555
 
547
556
 
548
557
  <dt class="tag-source">Source:</dt>
@@ -586,10 +595,6 @@ to this set</td>
586
595
 
587
596
 
588
597
 
589
- <div class="description usertext">
590
- Add every resource in the given translation set to this set,
591
- merging the results together.
592
- </div>
593
598
 
594
599
 
595
600
 
@@ -598,10 +603,7 @@ merging the results together.
598
603
 
599
604
 
600
605
 
601
-
602
-
603
-
604
- <h5>Parameters:</h5>
606
+ <h5 class="h5-parameters">Parameters:</h5>
605
607
 
606
608
 
607
609
  <table class="params">
@@ -635,6 +637,7 @@ merging the results together.
635
637
  <span class="param-type"><a href="TranslationSet.html">TranslationSet</a></span>
636
638
 
637
639
 
640
+
638
641
 
639
642
  </td>
640
643
 
@@ -681,6 +684,10 @@ to this set</td>
681
684
 
682
685
 
683
686
  <dl class="details">
687
+
688
+ <dt class="tag-description">Description:</dt>
689
+ <dd class="tag-description"><ul class="dummy"><li>Clear all resources from this set.</li></ul></dd>
690
+
684
691
 
685
692
 
686
693
  <dt class="tag-source">Source:</dt>
@@ -724,12 +731,6 @@ to this set</td>
724
731
 
725
732
 
726
733
 
727
- <div class="description usertext">
728
- Clear all resources from this set.
729
- </div>
730
-
731
-
732
-
733
734
 
734
735
 
735
736
 
@@ -768,6 +769,14 @@ to this set</td>
768
769
 
769
770
 
770
771
  <dl class="details">
772
+
773
+ <dt class="tag-description">Description:</dt>
774
+ <dd class="tag-description"><ul class="dummy"><li>Return a new translation set that contains the differences
775
+ between the current set and the other set. Resources are
776
+ added to the difference set if they exist in the other
777
+ set but not the current one, or if they exist in both
778
+ sets, but contain different fields.</li></ul></dd>
779
+
771
780
 
772
781
 
773
782
  <dt class="tag-source">Source:</dt>
@@ -811,16 +820,6 @@ to this set</td>
811
820
 
812
821
 
813
822
 
814
- <div class="description usertext">
815
- Return a new translation set that contains the differences
816
- between the current set and the other set. Resources are
817
- added to the difference set if they exist in the other
818
- set but not the current one, or if they exist in both
819
- sets, but contain different fields.
820
- </div>
821
-
822
-
823
-
824
823
 
825
824
 
826
825
 
@@ -829,7 +828,7 @@ sets, but contain different fields.
829
828
 
830
829
 
831
830
 
832
- <h5>Parameters:</h5>
831
+ <h5 class="h5-parameters">Parameters:</h5>
833
832
 
834
833
 
835
834
  <table class="params">
@@ -863,6 +862,7 @@ sets, but contain different fields.
863
862
  <span class="param-type"><a href="TranslationSet.html">TranslationSet</a></span>
864
863
 
865
864
 
865
+
866
866
 
867
867
  </td>
868
868
 
@@ -892,7 +892,7 @@ sets, but contain different fields.
892
892
 
893
893
 
894
894
 
895
- <h5>Returns:</h5>
895
+ <h5 class="h5-returns">Returns:</h5>
896
896
 
897
897
 
898
898
  <div class="param-desc">
@@ -911,6 +911,7 @@ set and this one
911
911
  <span class="param-type"><a href="TranslationSet.html">TranslationSet</a></span>
912
912
 
913
913
 
914
+
914
915
  </dd>
915
916
  </dl>
916
917
 
@@ -931,6 +932,10 @@ set and this one
931
932
 
932
933
 
933
934
  <dl class="details">
935
+
936
+ <dt class="tag-description">Description:</dt>
937
+ <dd class="tag-description"><ul class="dummy"><li>Get a resource by its hashkey.</li></ul></dd>
938
+
934
939
 
935
940
 
936
941
  <dt class="tag-source">Source:</dt>
@@ -974,12 +979,6 @@ set and this one
974
979
 
975
980
 
976
981
 
977
- <div class="description usertext">
978
- Get a resource by its hashkey.
979
- </div>
980
-
981
-
982
-
983
982
 
984
983
 
985
984
 
@@ -988,7 +987,7 @@ set and this one
988
987
 
989
988
 
990
989
 
991
- <h5>Parameters:</h5>
990
+ <h5 class="h5-parameters">Parameters:</h5>
992
991
 
993
992
 
994
993
  <table class="params">
@@ -1022,6 +1021,7 @@ set and this one
1022
1021
  <span class="param-type">String</span>
1023
1022
 
1024
1023
 
1024
+
1025
1025
 
1026
1026
  </td>
1027
1027
 
@@ -1051,7 +1051,7 @@ set and this one
1051
1051
 
1052
1052
 
1053
1053
 
1054
- <h5>Returns:</h5>
1054
+ <h5 class="h5-returns">Returns:</h5>
1055
1055
 
1056
1056
 
1057
1057
  <div class="param-desc">
@@ -1073,6 +1073,7 @@ resource with that key
1073
1073
  <span class="param-type">undefined</span>
1074
1074
 
1075
1075
 
1076
+
1076
1077
  </dd>
1077
1078
  </dl>
1078
1079
 
@@ -1093,6 +1094,10 @@ resource with that key
1093
1094
 
1094
1095
 
1095
1096
  <dl class="details">
1097
+
1098
+ <dt class="tag-description">Description:</dt>
1099
+ <dd class="tag-description"><ul class="dummy"><li>Return all resources in this set.</li></ul></dd>
1100
+
1096
1101
 
1097
1102
 
1098
1103
  <dt class="tag-source">Source:</dt>
@@ -1136,12 +1141,6 @@ resource with that key
1136
1141
 
1137
1142
 
1138
1143
 
1139
- <div class="description usertext">
1140
- Return all resources in this set.
1141
- </div>
1142
-
1143
-
1144
-
1145
1144
 
1146
1145
 
1147
1146
 
@@ -1164,7 +1163,7 @@ resource with that key
1164
1163
 
1165
1164
 
1166
1165
 
1167
- <h5>Returns:</h5>
1166
+ <h5 class="h5-returns">Returns:</h5>
1168
1167
 
1169
1168
 
1170
1169
  <div class="param-desc">
@@ -1183,6 +1182,7 @@ possibly empty
1183
1182
  <span class="param-type">Array.&lt;<a href="Resource.html">Resource</a>></span>
1184
1183
 
1185
1184
 
1185
+
1186
1186
  </dd>
1187
1187
  </dl>
1188
1188
 
@@ -1203,6 +1203,10 @@ possibly empty
1203
1203
 
1204
1204
 
1205
1205
  <dl class="details">
1206
+
1207
+ <dt class="tag-description">Description:</dt>
1208
+ <dd class="tag-description"><ul class="dummy"><li>Get a resource by the given criteria.</li></ul></dd>
1209
+
1206
1210
 
1207
1211
 
1208
1212
  <dt class="tag-source">Source:</dt>
@@ -1246,11 +1250,6 @@ possibly empty
1246
1250
 
1247
1251
 
1248
1252
 
1249
- <div class="description usertext">
1250
- Get a resource by the given criteria.
1251
- </div>
1252
-
1253
-
1254
1253
 
1255
1254
 
1256
1255
 
@@ -1259,8 +1258,7 @@ possibly empty
1259
1258
 
1260
1259
 
1261
1260
 
1262
-
1263
- <h5>Parameters:</h5>
1261
+ <h5 class="h5-parameters">Parameters:</h5>
1264
1262
 
1265
1263
 
1266
1264
  <table class="params">
@@ -1294,6 +1292,7 @@ possibly empty
1294
1292
  <span class="param-type">Object</span>
1295
1293
 
1296
1294
 
1295
+
1297
1296
 
1298
1297
  </td>
1299
1298
 
@@ -1323,7 +1322,7 @@ possibly empty
1323
1322
 
1324
1323
 
1325
1324
 
1326
- <h5>Returns:</h5>
1325
+ <h5 class="h5-returns">Returns:</h5>
1327
1326
 
1328
1327
 
1329
1328
  <div class="param-desc">
@@ -1345,6 +1344,7 @@ retrieval did not find any resources that match or there was some error
1345
1344
  <span class="param-type">undefined</span>
1346
1345
 
1347
1346
 
1347
+
1348
1348
  </dd>
1349
1349
  </dl>
1350
1350
 
@@ -1365,6 +1365,17 @@ retrieval did not find any resources that match or there was some error
1365
1365
 
1366
1366
 
1367
1367
  <dl class="details">
1368
+
1369
+ <dt class="tag-description">Description:</dt>
1370
+ <dd class="tag-description"><ul class="dummy"><li>Get a resource by its source string and context. The source string must be written
1371
+ in the language and script of the source locale. For array types, the
1372
+ source string
1373
+ must be one of the values in the string array. For plural types, it
1374
+ must be one of the values of the quantities.<p>
1375
+
1376
+ If the context is undefined,
1377
+ this method will find the base generic resource with no context.</li></ul></dd>
1378
+
1368
1379
 
1369
1380
 
1370
1381
  <dt class="tag-source">Source:</dt>
@@ -1408,17 +1419,6 @@ retrieval did not find any resources that match or there was some error
1408
1419
 
1409
1420
 
1410
1421
 
1411
- <div class="description usertext">
1412
- Get a resource by its source string and context. The source string must be written
1413
- in the language and script of the source locale. For array types, the
1414
- source string
1415
- must be one of the values in the string array. For plural types, it
1416
- must be one of the values of the quantities.<p>
1417
-
1418
- If the context is undefined,
1419
- this method will find the base generic resource with no context.
1420
- </div>
1421
-
1422
1422
 
1423
1423
 
1424
1424
 
@@ -1427,9 +1427,7 @@ this method will find the base generic resource with no context.
1427
1427
 
1428
1428
 
1429
1429
 
1430
-
1431
-
1432
- <h5>Parameters:</h5>
1430
+ <h5 class="h5-parameters">Parameters:</h5>
1433
1431
 
1434
1432
 
1435
1433
  <table class="params">
@@ -1463,6 +1461,7 @@ this method will find the base generic resource with no context.
1463
1461
  <span class="param-type">String</span>
1464
1462
 
1465
1463
 
1464
+
1466
1465
 
1467
1466
  </td>
1468
1467
 
@@ -1489,6 +1488,7 @@ this method will find the base generic resource with no context.
1489
1488
  <span class="param-type">undefined</span>
1490
1489
 
1491
1490
 
1491
+
1492
1492
 
1493
1493
  </td>
1494
1494
 
@@ -1518,7 +1518,7 @@ this method will find the base generic resource with no context.
1518
1518
 
1519
1519
 
1520
1520
 
1521
- <h5>Returns:</h5>
1521
+ <h5 class="h5-returns">Returns:</h5>
1522
1522
 
1523
1523
 
1524
1524
  <div class="param-desc">
@@ -1540,6 +1540,7 @@ undefined if there is no resource with that source
1540
1540
  <span class="param-type">undefined</span>
1541
1541
 
1542
1542
 
1543
+
1543
1544
  </dd>
1544
1545
  </dl>
1545
1546
 
@@ -1560,6 +1561,10 @@ undefined if there is no resource with that source
1560
1561
 
1561
1562
 
1562
1563
  <dl class="details">
1564
+
1565
+ <dt class="tag-description">Description:</dt>
1566
+ <dd class="tag-description"><ul class="dummy"><li>Get a resource by its clean string hashkey.</li></ul></dd>
1567
+
1563
1568
 
1564
1569
 
1565
1570
  <dt class="tag-source">Source:</dt>
@@ -1603,12 +1608,6 @@ undefined if there is no resource with that source
1603
1608
 
1604
1609
 
1605
1610
 
1606
- <div class="description usertext">
1607
- Get a resource by its clean string hashkey.
1608
- </div>
1609
-
1610
-
1611
-
1612
1611
 
1613
1612
 
1614
1613
 
@@ -1617,7 +1616,7 @@ undefined if there is no resource with that source
1617
1616
 
1618
1617
 
1619
1618
 
1620
- <h5>Parameters:</h5>
1619
+ <h5 class="h5-parameters">Parameters:</h5>
1621
1620
 
1622
1621
 
1623
1622
  <table class="params">
@@ -1651,6 +1650,7 @@ undefined if there is no resource with that source
1651
1650
  <span class="param-type">String</span>
1652
1651
 
1653
1652
 
1653
+
1654
1654
 
1655
1655
  </td>
1656
1656
 
@@ -1680,7 +1680,7 @@ undefined if there is no resource with that source
1680
1680
 
1681
1681
 
1682
1682
 
1683
- <h5>Returns:</h5>
1683
+ <h5 class="h5-returns">Returns:</h5>
1684
1684
 
1685
1685
 
1686
1686
  <div class="param-desc">
@@ -1702,6 +1702,7 @@ resource with that key
1702
1702
  <span class="param-type">undefined</span>
1703
1703
 
1704
1704
 
1705
+
1705
1706
  </dd>
1706
1707
  </dl>
1707
1708
 
@@ -1722,6 +1723,13 @@ resource with that key
1722
1723
 
1723
1724
 
1724
1725
  <dl class="details">
1726
+
1727
+ <dt class="tag-description">Description:</dt>
1728
+ <dd class="tag-description"><ul class="dummy"><li>Return an array of all the contexts within the given project
1729
+ in the set. The root context is just the empty string.
1730
+ The root context is where all strings will go if they are
1731
+ not given an explicit context in the resource file or code.</li></ul></dd>
1732
+
1725
1733
 
1726
1734
 
1727
1735
  <dt class="tag-source">Source:</dt>
@@ -1765,14 +1773,6 @@ resource with that key
1765
1773
 
1766
1774
 
1767
1775
 
1768
- <div class="description usertext">
1769
- Return an array of all the contexts within the given project
1770
- in the set. The root context is just the empty string.
1771
- The root context is where all strings will go if they are
1772
- not given an explicit context in the resource file or code.
1773
- </div>
1774
-
1775
-
1776
1776
 
1777
1777
 
1778
1778
 
@@ -1781,8 +1781,7 @@ not given an explicit context in the resource file or code.
1781
1781
 
1782
1782
 
1783
1783
 
1784
-
1785
- <h5>Parameters:</h5>
1784
+ <h5 class="h5-parameters">Parameters:</h5>
1786
1785
 
1787
1786
 
1788
1787
  <table class="params">
@@ -1819,6 +1818,7 @@ not given an explicit context in the resource file or code.
1819
1818
  <span class="param-type">undefined</span>
1820
1819
 
1821
1820
 
1821
+
1822
1822
 
1823
1823
  </td>
1824
1824
 
@@ -1849,7 +1849,7 @@ the contexts or undefined to mean all projects</td>
1849
1849
 
1850
1850
 
1851
1851
 
1852
- <h5>Returns:</h5>
1852
+ <h5 class="h5-returns">Returns:</h5>
1853
1853
 
1854
1854
 
1855
1855
  <div class="param-desc">
@@ -1871,6 +1871,7 @@ or undefined if there are no contexts in the set
1871
1871
  <span class="param-type">undefined</span>
1872
1872
 
1873
1873
 
1874
+
1874
1875
  </dd>
1875
1876
  </dl>
1876
1877
 
@@ -1891,6 +1892,13 @@ or undefined if there are no contexts in the set
1891
1892
 
1892
1893
 
1893
1894
  <dl class="details">
1895
+
1896
+ <dt class="tag-description">Description:</dt>
1897
+ <dd class="tag-description"><ul class="dummy"><li>Return an array of all the locales available within the given
1898
+ project and context in the set. The root context is just
1899
+ the empty string. The locales are returned as BCP-47 locale
1900
+ specs.</li></ul></dd>
1901
+
1894
1902
 
1895
1903
 
1896
1904
  <dt class="tag-source">Source:</dt>
@@ -1934,13 +1942,6 @@ or undefined if there are no contexts in the set
1934
1942
 
1935
1943
 
1936
1944
 
1937
- <div class="description usertext">
1938
- Return an array of all the locales available within the given
1939
- project and context in the set. The root context is just
1940
- the empty string. The locales are returned as BCP-47 locale
1941
- specs.
1942
- </div>
1943
-
1944
1945
 
1945
1946
 
1946
1947
 
@@ -1949,9 +1950,7 @@ specs.
1949
1950
 
1950
1951
 
1951
1952
 
1952
-
1953
-
1954
- <h5>Parameters:</h5>
1953
+ <h5 class="h5-parameters">Parameters:</h5>
1955
1954
 
1956
1955
 
1957
1956
  <table class="params">
@@ -1988,6 +1987,7 @@ specs.
1988
1987
  <span class="param-type">undefined</span>
1989
1988
 
1990
1989
 
1990
+
1991
1991
 
1992
1992
  </td>
1993
1993
 
@@ -2015,6 +2015,7 @@ the contexts or undefined to mean all projects</td>
2015
2015
  <span class="param-type">undefined</span>
2016
2016
 
2017
2017
 
2018
+
2018
2019
 
2019
2020
  </td>
2020
2021
 
@@ -2046,7 +2047,7 @@ Use the empty string "" for the default/root context.</td>
2046
2047
 
2047
2048
 
2048
2049
 
2049
- <h5>Returns:</h5>
2050
+ <h5 class="h5-returns">Returns:</h5>
2050
2051
 
2051
2052
 
2052
2053
  <div class="param-desc">
@@ -2068,6 +2069,7 @@ or undefined if there are no contexts in the set
2068
2069
  <span class="param-type">undefined</span>
2069
2070
 
2070
2071
 
2072
+
2071
2073
  </dd>
2072
2074
  </dl>
2073
2075
 
@@ -2088,6 +2090,10 @@ or undefined if there are no contexts in the set
2088
2090
 
2089
2091
 
2090
2092
  <dl class="details">
2093
+
2094
+ <dt class="tag-description">Description:</dt>
2095
+ <dd class="tag-description"><ul class="dummy"><li>Return an array of all the project names in the database.</li></ul></dd>
2096
+
2091
2097
 
2092
2098
 
2093
2099
  <dt class="tag-source">Source:</dt>
@@ -2131,12 +2137,6 @@ or undefined if there are no contexts in the set
2131
2137
 
2132
2138
 
2133
2139
 
2134
- <div class="description usertext">
2135
- Return an array of all the project names in the database.
2136
- </div>
2137
-
2138
-
2139
-
2140
2140
 
2141
2141
 
2142
2142
 
@@ -2159,7 +2159,7 @@ or undefined if there are no contexts in the set
2159
2159
 
2160
2160
 
2161
2161
 
2162
- <h5>Returns:</h5>
2162
+ <h5 class="h5-returns">Returns:</h5>
2163
2163
 
2164
2164
 
2165
2165
  <div class="param-desc">
@@ -2181,6 +2181,7 @@ or undefined if there are no projects in the set
2181
2181
  <span class="param-type">undefined</span>
2182
2182
 
2183
2183
 
2184
+
2184
2185
  </dd>
2185
2186
  </dl>
2186
2187
 
@@ -2201,6 +2202,13 @@ or undefined if there are no projects in the set
2201
2202
 
2202
2203
 
2203
2204
  <dl class="details">
2205
+
2206
+ <dt class="tag-description">Description:</dt>
2207
+ <dd class="tag-description"><ul class="dummy"><li>Return whether or not this set is dirty. The dirty flag is set
2208
+ whenever a new resource was added to or removed from the set
2209
+ after it was created or since the last time the setClean method
2210
+ was called.</li></ul></dd>
2211
+
2204
2212
 
2205
2213
 
2206
2214
  <dt class="tag-source">Source:</dt>
@@ -2244,15 +2252,6 @@ or undefined if there are no projects in the set
2244
2252
 
2245
2253
 
2246
2254
 
2247
- <div class="description usertext">
2248
- Return whether or not this set is dirty. The dirty flag is set
2249
- whenever a new resource was added to or removed from the set
2250
- after it was created or since the last time the setClean method
2251
- was called.
2252
- </div>
2253
-
2254
-
2255
-
2256
2255
 
2257
2256
 
2258
2257
 
@@ -2275,7 +2274,7 @@ was called.
2275
2274
 
2276
2275
 
2277
2276
 
2278
- <h5>Returns:</h5>
2277
+ <h5 class="h5-returns">Returns:</h5>
2279
2278
 
2280
2279
 
2281
2280
  <div class="param-desc">
@@ -2293,6 +2292,7 @@ was called.
2293
2292
  <span class="param-type">boolean</span>
2294
2293
 
2295
2294
 
2295
+
2296
2296
  </dd>
2297
2297
  </dl>
2298
2298
 
@@ -2313,6 +2313,13 @@ was called.
2313
2313
 
2314
2314
 
2315
2315
  <dl class="details">
2316
+
2317
+ <dt class="tag-description">Description:</dt>
2318
+ <dd class="tag-description"><ul class="dummy"><li>Remove a resource from the set. The resource must have at
2319
+ least enough fields specified to uniquely identify the
2320
+ resource to remove. These are: project, context, locale,
2321
+ resType, and reskey.</li></ul></dd>
2322
+
2316
2323
 
2317
2324
 
2318
2325
  <dt class="tag-source">Source:</dt>
@@ -2356,15 +2363,6 @@ was called.
2356
2363
 
2357
2364
 
2358
2365
 
2359
- <div class="description usertext">
2360
- Remove a resource from the set. The resource must have at
2361
- least enough fields specified to uniquely identify the
2362
- resource to remove. These are: project, context, locale,
2363
- resType, and reskey.
2364
- </div>
2365
-
2366
-
2367
-
2368
2366
 
2369
2367
 
2370
2368
 
@@ -2373,7 +2371,7 @@ resType, and reskey.
2373
2371
 
2374
2372
 
2375
2373
 
2376
- <h5>Parameters:</h5>
2374
+ <h5 class="h5-parameters">Parameters:</h5>
2377
2375
 
2378
2376
 
2379
2377
  <table class="params">
@@ -2407,6 +2405,7 @@ resType, and reskey.
2407
2405
  <span class="param-type"><a href="Resource.html">Resource</a></span>
2408
2406
 
2409
2407
 
2408
+
2410
2409
 
2411
2410
  </td>
2412
2411
 
@@ -2436,7 +2435,7 @@ resType, and reskey.
2436
2435
 
2437
2436
 
2438
2437
 
2439
- <h5>Returns:</h5>
2438
+ <h5 class="h5-returns">Returns:</h5>
2440
2439
 
2441
2440
 
2442
2441
  <div class="param-desc">
@@ -2455,6 +2454,7 @@ and false otherwise
2455
2454
  <span class="param-type">boolean</span>
2456
2455
 
2457
2456
 
2457
+
2458
2458
  </dd>
2459
2459
  </dl>
2460
2460
 
@@ -2475,6 +2475,13 @@ and false otherwise
2475
2475
 
2476
2476
 
2477
2477
  <dl class="details">
2478
+
2479
+ <dt class="tag-description">Description:</dt>
2480
+ <dd class="tag-description"><ul class="dummy"><li>Reset the dirty flag to false, meaning the set is clean. This will
2481
+ allow callers to tell if any more resources were added after
2482
+ this call was made because adding those resources will set
2483
+ the dirty flag to true again.</li></ul></dd>
2484
+
2478
2485
 
2479
2486
 
2480
2487
  <dt class="tag-source">Source:</dt>
@@ -2518,15 +2525,6 @@ and false otherwise
2518
2525
 
2519
2526
 
2520
2527
 
2521
- <div class="description usertext">
2522
- Reset the dirty flag to false, meaning the set is clean. This will
2523
- allow callers to tell if any more resources were added after
2524
- this call was made because adding those resources will set
2525
- the dirty flag to true again.
2526
- </div>
2527
-
2528
-
2529
-
2530
2528
 
2531
2529
 
2532
2530
 
@@ -2565,6 +2563,10 @@ the dirty flag to true again.
2565
2563
 
2566
2564
 
2567
2565
  <dl class="details">
2566
+
2567
+ <dt class="tag-description">Description:</dt>
2568
+ <dd class="tag-description"><ul class="dummy"><li>Return the number of unique resources in this set.</li></ul></dd>
2569
+
2568
2570
 
2569
2571
 
2570
2572
  <dt class="tag-source">Source:</dt>
@@ -2608,11 +2610,6 @@ the dirty flag to true again.
2608
2610
 
2609
2611
 
2610
2612
 
2611
- <div class="description usertext">
2612
- Return the number of unique resources in this set.
2613
- </div>
2614
-
2615
-
2616
2613
 
2617
2614
 
2618
2615
 
@@ -2635,8 +2632,7 @@ the dirty flag to true again.
2635
2632
 
2636
2633
 
2637
2634
 
2638
-
2639
- <h5>Returns:</h5>
2635
+ <h5 class="h5-returns">Returns:</h5>
2640
2636
 
2641
2637
 
2642
2638
  <div class="param-desc">
@@ -2654,6 +2650,7 @@ the dirty flag to true again.
2654
2650
  <span class="param-type">number</span>
2655
2651
 
2656
2652
 
2653
+
2657
2654
  </dd>
2658
2655
  </dl>
2659
2656
 
@@ -2681,7 +2678,7 @@ the dirty flag to true again.
2681
2678
  <br class="clear">
2682
2679
 
2683
2680
  <footer>
2684
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sun Dec 11 2022 21:08:55 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2681
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.0</a> on Tue Jan 24 2023 22:21:49 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2685
2682
  </footer>
2686
2683
 
2687
2684
  <script>prettyPrint();</script>