npm - ilib-tools-common - Versions diffs - 1.0.0 - Mend

ilib-tools-common 1.0.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 (49) hide show

package/LICENSE +201 -0
package/README.md +30 -0
package/docs/Resource.html +3645 -0
package/docs/Resource.js.html +522 -0
package/docs/ResourceArray.html +5960 -0
package/docs/ResourceArray.js.html +447 -0
package/docs/ResourcePlural.html +6094 -0
package/docs/ResourcePlural.js.html +424 -0
package/docs/ResourceString.html +5532 -0
package/docs/ResourceString.js.html +295 -0
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 +978 -0
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 +1049 -0
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/global.html +311 -0
package/docs/ilibToolsCommon.md +0 -0
package/docs/index.html +81 -0
package/docs/scripts/collapse.js +20 -0
package/docs/scripts/linenumber.js +25 -0
package/docs/scripts/nav.js +12 -0
package/docs/scripts/polyfill.js +4 -0
package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
package/docs/scripts/prettify/lang-css.js +2 -0
package/docs/scripts/prettify/prettify.js +28 -0
package/docs/scripts/search.js +83 -0
package/docs/styles/jsdoc.css +765 -0
package/docs/styles/prettify.css +79 -0
package/docs/utils.js.html +113 -0
package/package.json +77 -0
package/src/Resource.js +453 -0
package/src/ResourceArray.js +378 -0
package/src/ResourcePlural.js +355 -0
package/src/ResourceString.js +226 -0
package/src/index.js +25 -0
package/src/utils.js +44 -0

package/docs/Resource.html ADDED Viewed

@@ -0,0 +1,3645 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Resource - 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="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#addSource">addSource</a></li><li data-type='method'><a href="ResourceArray.html#addTarget">addTarget</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#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#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#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#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></ul><h3>Global</h3><ul><li><a href="global.html#cleanString">cleanString</a></li></ul>
+</nav>
+<div id="main">
+    <h1 class="page-title">Resource</h1>
+<section>
+<header>
+        <h2>
+        Resource
+        </h2>
+            <div class="class-description usertext">Represents a resource from a resource file or
+extracted from the code.</div>
+</header>
+<article>
+        <div class="container-overview">
+    <h2>Constructor</h2>
+    <h4 class="name" id="Resource"><span class="type-signature">(abstract) </span>new Resource<span class="signature">(props)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line44">line 44</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Construct a new Resource instance.
+The props may contain any
+of the following properties:
+<ul>
+<li>project {String} - the project that this resource is in
+<li><i>context</i> {String} - The context for this resource,
+such as "landscape mode", or "7200dp", which differentiates it
+from the base resource that has no special context. The default
+if this property is not specified is undefined, meaning no
+context.
+<li>sourceLocale {String} - the locale of the source resource.
+<li>targetLocale {String} - the locale of the target resource.
+<li>key {String} - the unique key of this string, which should include the context
+of the string
+<li>pathName {String} - pathName to the file where the string was extracted from
+<li>autoKey {boolean} - true if the key was generated based on the source text
+<li>state {String} - current state of the resource (ie. "new", "translated", or "accepted")
+</ul>
+</div>
+    <h5>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>props</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">properties of the string, as defined above</td>
+        </tr>
+    </tbody>
+</table>
+        </div>
+        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="addInstance"><span class="type-signature"></span>addInstance<span class="signature">(an)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line408">line 408</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Add an instance of the same resource to the list of
+instances. If the given resource matches the
+current instance in all properties that affect the
+possible translation, and differs from the current
+instance by some property that does not affect
+its translation, it will be added as an instance of
+the same string. The following properties affect the
+translation:
+<ul>
+<li>context</li>
+<li>datatype</li>
+<li>dnt</li>
+<li>flavor</li>
+<li>project</li>
+<li>reskey</li>
+<li>resType</li>
+<li>source</li>
+<li>sourceHash</li>
+<li>sourceArray</li>
+<li>sourceLocale</li>
+<li>targetLocale</li>
+</ul>
+Differences in other properties, such as "comment" or
+"origin" are considered instances of the same resource.
+If this method is given a resource that differs from
+the current one by one of the above translation affecting
+properties, it is not added to the list of instances. This
+can be checked easily by calling the isInstance() method.
+</div>
+    <h5>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>an</code></td>
+            <td class="type">
+<span class="param-type"><a href="Resource.html">Resource</a></span>
+            </td>
+            <td class="description last">instance of the current resource to
+record</td>
+        </tr>
+    </tbody>
+</table>
+<h5>Returns:</h5>
+<div class="param-desc">
+    true if the instance was added, and
+and false otherwise
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">boolean</span>
+    </dd>
+</dl>
+    <h4 class="name" id="escapeText"><span class="type-signature"></span>escapeText<span class="signature">(str)</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line353">line 353</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Escape text for writing to a database in a SQL command. This puts single
+quotes around the string, and makes sure that all single quotes within
+the string are escaped.
+</div>
+    <h5>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>str</code></td>
+            <td class="type">
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">the item to escape</td>
+        </tr>
+    </tbody>
+</table>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the escaped string
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getAutoKey"><span class="type-signature"></span>getAutoKey<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line165">line 165</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return true if the key of this resource was automatically generated,
+and false if it was an explicit key.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    true if the key of this string was auto generated,
+false otherwise
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">boolean</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getComment"><span class="type-signature"></span>getComment<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line264">line 264</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the translator's comment for this resource if there is
+one, or undefined if not.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the translator's comment for this resource
+if the engineer put one in the code
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+|
+<span class="param-type">undefined</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getContext"><span class="type-signature"></span>getContext<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line175">line 175</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the context of this resource, or undefined if there
+is no context.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the context of this resource, or undefined if there
+is no context.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+|
+<span class="param-type">undefined</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getDataType"><span class="type-signature"></span>getDataType<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line154">line 154</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the data type of this resource.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the data type of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getFlavor"><span class="type-signature"></span>getFlavor<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line319">line 319</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the name of the flavor for this resource, or undefined
+for the "main" or default flavor.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the name of the flavor for this
+ resource or undefined for the main or default flavor
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+|
+<span class="param-type">undefined</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> &rarr; {number|undefined}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line285">line 285</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the database id if this resource has previously been saved in the
+database.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the database id if this resource has previously
+been saved in the database, or undefined if it is has not
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">number</span>
+|
+<span class="param-type">undefined</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getInstances"><span class="type-signature"></span>getInstances<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="Resource.html">Resource</a>>}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line448">line 448</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the list of instances of the current resource.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the list of instances of
+the current resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Array.&lt;<a href="Resource.html">Resource</a>></span>
+    </dd>
+</dl>
+    <h4 class="name" id="getKey"><span class="type-signature"></span>getKey<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line115">line 115</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the unique key of this resource.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the unique key of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getLocalize"><span class="type-signature"></span>getLocalize<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line308">line 308</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the localize flag of this resource.
+This flag indicates whether we should look up a translation for this resource.
+When false, we should simply substitute the source back
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the localize flag of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">Boolean</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getOrigin"><span class="type-signature"></span>getOrigin<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line297">line 297</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the origin of this resource. The origin may be either the string
+"source" or "target". Source origin resources are ones that are extracted
+from the source code, whereas target ones are translations from the
+translators.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the origin of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getPath"><span class="type-signature"></span>getPath<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line253">line 253</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the original path to the file from which this resource was
+originally extracted.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the path to the file containing this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getProject"><span class="type-signature"></span>getProject<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line106">line 106</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the project that this resource was found in.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the project of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getSource"><span class="type-signature"></span>getSource<span class="signature">()</span><span class="type-signature"> &rarr; {String|Array.&lt;String>|Object}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line125">line 125</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the source string or strings for this resource.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the source string or
+strings of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+|
+<span class="param-type">Array.&lt;String></span>
+|
+<span class="param-type">Object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getSourceLocale"><span class="type-signature"></span>getSourceLocale<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line185">line 185</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the source locale of this resource, or undefined if there
+is no context or the locale is the same as the project's source locale.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the locale of this resource, or undefined if there
+is no locale.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+|
+<span class="param-type">undefined</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getState"><span class="type-signature"></span>getState<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line222">line 222</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the state of this resource. This is a string that gives the
+stage of life of this resource. Currently, it can be one of "new",
+"translated", or "accepted".
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the state of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getTarget"><span class="type-signature"></span>getTarget<span class="signature">()</span><span class="type-signature"> &rarr; {String|Array.&lt;String>|Object}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line135">line 135</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the target string or strings for this resource.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the source string or
+strings of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+|
+<span class="param-type">Array.&lt;String></span>
+|
+<span class="param-type">Object</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getTargetLocale"><span class="type-signature"></span>getTargetLocale<span class="signature">()</span><span class="type-signature"> &rarr; {String|undefined}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line203">line 203</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the target locale of this resource, or undefined if the resource
+is a source-only resource.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the locale of this resource, or undefined if there
+is no locale.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+|
+<span class="param-type">undefined</span>
+    </dd>
+</dl>
+    <h4 class="name" id="getType"><span class="type-signature"></span>getType<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line145">line 145</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return the resource type of this resource. This is one of
+string, array, or plural.
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    the resource type of this resource
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h4 class="name" id="isInstance"><span class="type-signature"></span>isInstance<span class="signature">(a)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line432">line 432</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Check if the given resource is an instance of the current
+resource. This method returns true if all properties which
+affect the possible translation match between the given and
+the current resource.
+</div>
+    <h5>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>a</code></td>
+            <td class="type">
+<span class="param-type"><a href="Resource.html">Resource</a></span>
+            </td>
+            <td class="description last">resource to check</td>
+        </tr>
+    </tbody>
+</table>
+<h5>Returns:</h5>
+<div class="param-desc">
+    true if this is an instance of
+the current resource, false otherwise.
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">boolean</span>
+    </dd>
+</dl>
+    <h4 class="name" id="same"><span class="type-signature"></span>same<span class="signature">(other)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line332">line 332</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Return true if the other resource represents the same resource as
+the current one. The project, context, locale, key, flavor, and type must
+match. Other fields such as the pathName, state, and comment fields are
+ignored as minor variations.
+</div>
+    <h5>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>other</code></td>
+            <td class="type">
+<span class="param-type"><a href="Resource.html">Resource</a></span>
+            </td>
+            <td class="description last">another resource to test against the current one</td>
+        </tr>
+    </tbody>
+</table>
+<h5>Returns:</h5>
+<div class="param-desc">
+    true if these represent the same resource, false otherwise
+</div>
+<dl class="param-type">
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">boolean</span>
+    </dd>
+</dl>
+    <h4 class="name" id="setComment"><span class="type-signature"></span>setComment<span class="signature">(comment)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line274">line 274</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Set the translator's comment for this resource.
+</div>
+    <h5>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>comment</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+|
+<span class="param-type">undefined</span>
+            </td>
+            <td class="description last">the translator's comment to set. Use
+undefined to clear the comment</td>
+        </tr>
+    </tbody>
+</table>
+    <h4 class="name" id="setProject"><span class="type-signature"></span>setProject<span class="signature">(project)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line232">line 232</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Set the project of this resource. This is a string that gives the
+id of the project for this resource.
+</div>
+    <h5>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>project</code></td>
+            <td class="type">
+<span class="param-type">Project</span>
+            </td>
+            <td class="description last">the project to set for this resource</td>
+        </tr>
+    </tbody>
+</table>
+    <h4 class="name" id="setSourceLocale"><span class="type-signature"></span>setSourceLocale<span class="signature">(locale)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line193">line 193</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Set the source locale of this resource.
+</div>
+    <h5>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">String</span>
+            </td>
+            <td class="description last">the source locale of this resource</td>
+        </tr>
+    </tbody>
+</table>
+    <h4 class="name" id="setState"><span class="type-signature"></span>setState<span class="signature">(state)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line243">line 243</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Set the state of this resource. This is a string that gives the
+stage of life of this resource. Currently, it can be one of "new",
+"translated", or "accepted".
+</div>
+    <h5>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>state</code></td>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">the state of this resource</td>
+        </tr>
+    </tbody>
+</table>
+    <h4 class="name" id="setTargetLocale"><span class="type-signature"></span>setTargetLocale<span class="signature">(locale)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Resource.js.html">Resource.js</a>, <a href="Resource.js.html#line211">line 211</a>
+    </li></ul></dd>
+</dl>
+<div class="description usertext">
+    Set the target locale of this resource.
+</div>
+    <h5>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">String</span>
+            </td>
+            <td class="description last">the target locale of this resource</td>
+        </tr>
+    </tbody>
+</table>
+</article>
+</section>
+</div>
+<br class="clear">
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Thu Nov 17 2022 07:06:52 GMT-0800 (Pacific Standard 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>