rticommunity
diff --git a/‎.eslintrc.json‎
Lines changed: 15 additions & 0 deletions b/‎.eslintrc.json‎
Lines changed: 15 additions & 0 deletions
diff --git a/‎docs/conf.py‎
Lines changed: 71 additions & 1 deletion b/‎docs/conf.py‎
Lines changed: 71 additions & 1 deletion
diff --git a/‎docs/copyright_license.rst‎
Lines changed: 1 addition & 1 deletion b/‎docs/copyright_license.rst‎
Lines changed: 1 addition & 1 deletion
diff --git a/‎docs/data.rst‎
Lines changed: 51 additions & 17 deletions b/‎docs/data.rst‎
Lines changed: 51 additions & 17 deletions
diff --git a/‎docs/index.rst‎
Lines changed: 4 additions & 5 deletions b/‎docs/index.rst‎
Lines changed: 4 additions & 5 deletions
@@ -0,0 +1,15 @@
+{
+    "env": {
+        "node": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": [
+        "standard"
+    ],
+    "parserOptions": {
+        "ecmaVersion": 12
+    },
+    "rules": {
+    }
+}
@@ -83,4 +83,74 @@ def setup(app):
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or
 # 32x32 pixels large.
 #
-html_favicon = "static/favicon.ico"
+html_favicon = "static/favicon.ico"
+
+# -- Options for LaTeX output -------------------------------------------------------------------------------------------
+latex_engine = 'lualatex'
+latex_use_xindy = False
+
+# latex config taken from connextdds repo
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt')
+    'pointsize': '11pt',
+    'preamble': '''\
+\\sphinxsetup{TitleColor={named}{black},InnerLinkColor={named}{black},OuterLinkColor={named}{blue}}
+\\usepackage[utf8]{inputenc}
+\\usepackage[titles]{tocloft}
+\\usepackage{multirow}
+\\usepackage{newunicodechar}
+\\usepackage{hyperref}
+\\usepackage{fontspec}
+\\usepackage{graphicx}
+\\setkeys{Gin}{width=.85\\textwidth}
+\\hypersetup{bookmarksnumbered}
+\\setcounter{tocdepth}{3}
+\\usepackage{fancyhdr}
+\\setlength{\headheight}{14pt}
+\\usepackage[draft]{minted}\\fvset{breaklines=true, breakanywhere=true}''',
+    'printindex': '\\footnotesize\\raggedright\\printindex',
+    'inputenc': '',
+    'utf8extra': '',
+    'classoptions': ',openany,oneside',
+    'releasename': 'Version',
+    'fncychap': '',
+    'maketitle': '''\
+        \\pagenumbering{Roman} %%% to avoid page 1 conflict with actual page 1
+        \\begin{titlepage}
+            \\centering
+
+            \\vspace{40mm} %%% * is used to give space from top
+
+            \\textbf{\\Huge{''' + project + '''}}
+            \\vspace{17mm}
+
+            \\textbf{\\Large{Version ''' + version + '''}}
+
+            \\vspace{100mm}
+            \\vspace{0mm}
+        \\end{titlepage}
+        '''
+}
+
+latex_use_modindex = True
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        'rticonnectorforjavascript.tex',
+        'RTI Connector for Javascript',
+        '2021, Real-Time Innovations, Inc.',
+        'manual'
+    ),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#
+html_logo = "static/rti-logo-FINALv2-White-OrangeDot.png"
@@ -104,7 +104,7 @@ Website: https://support.rti.com/ |br|
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
 
-    THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+    THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ''AS IS'' AND
     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 
@@ -129,18 +129,6 @@ To set any numeric type, including enumerations:
     output.instance.setNumber('my_double', 2.14)
     output.instance.setNumber('my_enum', 2)
 
-.. warning::
-    The range of values for a numeric field is determined by the type
-    used to define that field in the configuration file. However, 
-    ``setNumber`` and ``getNumber`` can't handle 64-bit integers 
-    (*int64* and *uint64*) whose absolute values are larger than 2^53. 
-    This is a *Connector* limitation due to the use of *double* as an 
-    intermediate representation.
-
-    When ``setNumber`` or ``getNumber`` detect this situation, they will raise
-    an :class:`DDSError`. ``getJson`` and ``setJson`` do not have this
-    limitation and can handle any 64-bit integer.
-
 To set booleans:
 
 .. code-block::
@@ -170,7 +158,7 @@ Similarly, to get a field in a :class:`Input` sample, use the appropriate
 getter: :meth:`SampleIterator.getNumber()`, :meth:`SampleIterator.getBoolean()`,
 :meth:`SampleIterator.getString()`, or the type-independent 
 :meth:`SampleIterator.get()`.
-``getString`` also works with numeric fields, returning the number as a string:
+:meth:`SampleIterator.getString` also works with numeric fields, returning the number as a string:
 
 .. code-block::
 
@@ -191,17 +179,63 @@ getter: :meth:`SampleIterator.getNumber()`, :meth:`SampleIterator.getBoolean()`,
 
 
 .. note::
-    The typed getters and setters perform better than ``set``
-    and ``get`` in applications that write or read at high rates.
-    Also prefer ``getJson`` and ``setFromJson`` over ``set``
-    and ``get`` when accessing all or most of the fields of a sample
+    The typed getters and setters perform better than :meth:`Instance.set`
+    and :meth:`SampleIterator.get` in applications that write or read at high rates.
+    Also, prefer :meth:`SampleIterator.getJson` and :meth:`Instance.setFromJson`
+    over :meth:`Instance.set` and :meth:`SampleIterator.get` when accessing all
+    or most of the fields of a sample
     (see previous section).
 
 .. note::
     If a field ``my_string``, defined as a string in the configuration file, contains
     a value that can be interpreted as a number, ``sample.get('my_string')`` returns
     a number, not a string.
 
+Accessing 64-bit integers
+^^^^^^^^^^^^^^^^^^^^^^^^^
+Internally, *Connector* relies on a framework that only contains a single number
+type, an IEEE-754 floating-point number. Additionally, *Connector* does not use 
+JavaScript's BigInt representation for numbers, meaning JavaScript has this same limitation.
+As a result, not all 64-bit integers can be represented with exact precision using all
+APIs.
+If your type contains ``uint64`` or ``int64`` members, and you expect them to be larger
+than ``Number.MAX_SAFE_INTEGER`` (or smaller than ``Number.MIN_SAFE_INTEGER``),
+then you must take the following into account.
+
+64-bit values with an absolute value greater or equal to 2^53 can be set via:
+ - The type-agnostic setter, :meth:`Instance.set`. The values must be supplied
+   as strings, e.g., ``the_output.instance.set('my_uint64', '18446744073709551615')``.
+ - :meth:`Instance.setString`, e.g., ``the_output.instance.setString('my_uint64', '18446744073709551615')``.
+ - :meth:`Instance.setFromJson`, if the values are provided as strings, e.g., ``the_output.instance.setFromJson({my_uint64: '18446744073709551615'})``.
+
+64-bit values with an absolute value greater than 2^53 can be retrieved via:
+ - The type-agnostic getter, :meth:`SampleIterator.get`. If the absolute value of
+   the field is less than ``2^53`` it will be returned as a number; otherwise it will be
+   returned as a string, e.g., ``sample.get(0).get('my_int64') // '9223372036854775807' OR 1234``.
+ - Using :meth:`SampleIterator.getString`. The value will be returned as a string,
+   e.g., ``sample.getString(my_int64') // '9223372036854775807' OR '1234'``.
+
+.. warning::
+
+  If :meth:`SampleIterator.getNumber()` is used to retrieve a value > 2^53 it will
+  throw a :class:`DDSError`.
+
+.. warning::
+
+  If :meth:`Instance.setNumber()` is used to set a value >= 2^53 it will throw a
+  :class:`DDSError`.
+
+.. warning::
+
+  The :meth:`SampleIterator.getJson()` method should not be used to retrieve integer
+  values larger than  ``Number.MAX_SAFE_INTEGER`` (or smaller than ``Number.MIN_SAFE_INTEGER``).
+  The values returned may be corrupted **but no error will be thrown**.
+
+.. note::
+
+  The :meth:`Instance.setNumber()` operation can safely handle ``abs(value) < 2^53``,
+  whereas the :meth:`SampleIterator.getNumber()` operation can safely handle ``abs(value) <= 2^53``.
+
 Accessing structs
 ^^^^^^^^^^^^^^^^^
 
 
@@ -1,8 +1,10 @@
 
 .. highlight:: javascript
 
-.. image:: static/RTI_Launcher_Icon_Connector_JavaScript_100x100_0919_forDocumentation.png
-    :align: left
+.. only:: html
+
+    .. image:: static/RTI_Launcher_Icon_Connector_JavaScript_100x100_0919_forDocumentation.png
+        :align: left
 
 Welcome to RTI Connector for JavaScript!
 ========================================
@@ -19,9 +21,6 @@ You can learn how to use *RTI Connector* by reading the following sections, whic
 include examples and detailed API reference. You can also find a specific type
 or function in the :ref:`genindex`.
 
-Table of Contents
-=================
-
 .. toctree::
    :maxdepth: 2
    :numbered: