Added type checking comment

cyberphone · Sep 28, 2024 · 5840943 · 5840943
1 parent a952b2e
commit 5840943
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/build/document-template.html b/build/document-template.html
@@ -133,6 +133,13 @@ <h3 id='toc'>Table of Contents</h3>
     Note that this implementation does not support CBOR &quot;simple&quot; values beyond
     <kbd>true</kbd>, <kbd>false</kbd>, <kbd>null</kbd>, and the three floating point variants.
   </p>
+  <p>
+    The wrapper concept adds strict <i>type checking</i> to the API.
+    That is, if an application expects a CBOR integer and calls 
+    <a href='#cbor.int.getint32'>getInt32()</a>, an exception will
+    be thrown if the referenced object is not an instance of
+    <a href='#wrapper.cbor.int'>CBOR.Int</a>.
+  </p>
   See also <a href='#main.common'>Common Wrapper Methods</a>.
   ${CBOR_WRAPPERS}
   ${COMMON_INTRO}
@@ -511,6 +518,6 @@ <h3 id='toc'>Table of Contents</h3>
   ${VERSION_INFO}
   API version: 1.0.8.  Note that the current API version is accessible through
   the static property <code>CBOR.version</code>.<br>
-  Document version: 2024-09-27
+  Document version: 2024-09-28
 </body>
 </html>
diff --git a/doc/index.html b/doc/index.html
@@ -247,6 +247,13 @@ <h3 id='main.wrappers'>2.&nbsp;&nbsp;CBOR Wrapper Objects</h3>
     Note that this implementation does not support CBOR &quot;simple&quot; values beyond
     <kbd>true</kbd>, <kbd>false</kbd>, <kbd>null</kbd>, and the three floating point variants.
   </p>
+  <p>
+    The wrapper concept adds strict <i>type checking</i> to the API.
+    That is, if an application expects a CBOR integer and calls 
+    <a href='#cbor.int.getint32'>getInt32()</a>, an exception will
+    be thrown if the referenced object is not an instance of
+    <a href='#wrapper.cbor.int'>CBOR.Int</a>.
+  </p>
   See also <a href='#main.common'>Common Wrapper Methods</a>.
   <h5 id='wrapper.cbor.int'>2.1.&nbsp;&nbsp;CBOR.Int</h5>
 <div class='webpkifloat'>
@@ -1520,6 +1527,6 @@ <h3 id='main.version'>10.&nbsp;&nbsp;Version</h3>
 
   API version: 1.0.8.  Note that the current API version is accessible through
   the static property <code>CBOR.version</code>.<br>
-  Document version: 2024-09-27
+  Document version: 2024-09-28
 </body>
 </html>