npm - @qubit-ltd/json - Versions diffs - 1.2.0 → 1.2.2 - Mend

@qubit-ltd/json 1.2.0 → 1.2.2

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

package/doc/api/LosslessNumber.html +3 -610
package/doc/api/data/search.json +1 -0
package/doc/api/fonts/Inconsolata-Regular.ttf +0 -0
package/doc/api/fonts/OpenSans-Regular.ttf +0 -0
package/doc/api/fonts/WorkSans-Bold.ttf +0 -0
package/doc/api/global.html +3 -1274
package/doc/api/index.html +63 -264
package/doc/api/scripts/core.js +726 -0
package/doc/api/scripts/core.min.js +23 -0
package/doc/api/scripts/resize.js +90 -0
package/doc/api/scripts/search.js +265 -0
package/doc/api/scripts/search.min.js +6 -0
package/doc/api/scripts/{prettify → third-party}/Apache-License-2.0.txt +202 -202
package/doc/api/scripts/third-party/fuse.js +9 -0
package/doc/api/scripts/third-party/hljs-line-num-original.js +369 -0
package/doc/api/scripts/third-party/hljs-line-num.js +1 -0
package/doc/api/scripts/third-party/hljs-original.js +5171 -0
package/doc/api/scripts/third-party/hljs.js +1 -0
package/doc/api/scripts/third-party/popper.js +5 -0
package/doc/api/scripts/third-party/tippy.js +1 -0
package/doc/api/scripts/third-party/tocbot.js +672 -0
package/doc/api/scripts/third-party/tocbot.min.js +1 -0
package/doc/api/styles/clean-jsdoc-theme-base.css +1159 -0
package/doc/api/styles/clean-jsdoc-theme-dark.css +412 -0
package/doc/api/styles/clean-jsdoc-theme-light.css +482 -0
package/doc/api/styles/clean-jsdoc-theme-scrollbar.css +30 -0
package/doc/api/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
package/doc/api/styles/clean-jsdoc-theme.min.css +1 -0
package/doc/json.min.visualization.html +1 -1
package/doc/json.visualization.html +1 -1
package/package.json +2 -3
package/doc/api/fonts/OpenSans-Bold-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Bold-webfont.svg +0 -1838
package/doc/api/fonts/OpenSans-Bold-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-BoldItalic-webfont.svg +0 -1838
package/doc/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Italic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Italic-webfont.svg +0 -1838
package/doc/api/fonts/OpenSans-Italic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Light-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Light-webfont.svg +0 -1839
package/doc/api/fonts/OpenSans-Light-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-LightItalic-webfont.svg +0 -1843
package/doc/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Regular-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Regular-webfont.svg +0 -1839
package/doc/api/fonts/OpenSans-Regular-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.svg +0 -1838
package/doc/api/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1838
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/doc/api/scripts/linenumber.js +0 -34
package/doc/api/scripts/prettify/lang-css.js +0 -2
package/doc/api/scripts/prettify/prettify.js +0 -28
package/doc/api/styles/jsdoc-default.css +0 -699
package/doc/api/styles/prettify-jsdoc.css +0 -120
package/doc/api/styles/prettify-tomorrow.css +0 -141

package/doc/api/global.html CHANGED Viewed

@@ -1,1274 +1,3 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <title>Global - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="https://cdn.bootcdn.net/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/ionicons/2.0.1/css/ionicons.min.css">
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</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>
-    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="LosslessNumber.html">LosslessNumber</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="LosslessNumber.html#toString">toString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="LosslessNumber.html#valueOf">valueOf</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getUnsafeReason">getUnsafeReason</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isBigInt">isBigInt</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isInteger">isInteger</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isNumber">isNumber</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isSafeNumber">isSafeNumber</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#json">json</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#toSafeNumberOrThrow">toSafeNumberOrThrow</a></span></li>
-</nav>
-<div id="main">
-    <h1 class="page-title">Global</h1>
-<section>
-<header>
-        <h2>
-        </h2>
-</header>
-<article>
-    <div class="container-overview">
-<dl class="details">
-</dl>
-    </div>
-        <h3 class="subsection-title">Members</h3>
-<div class="section-members">
-<h4 class="name" id="json"><span class="type-signature">(constant) </span>json<span class="type-signature"> :object</span></h4>
-<div class="description">
-    <p>A customized JSON object which supports lossless number parsing and stringifying.</p>
-<p>This object provides two methods: <code>parse</code> and <code>stringify</code>, which are the same as the
-<code>JSON.parse</code> and <code>JSON.stringify</code> methods, except that they support lossless number
-parsing and stringifying.</p>
-</div>
-<dl class="details">
-</dl>
-    <h5>Type:</h5>
-    <ul>
-        <li>
-<span class="param-type"><code>object</code></span>
-        </li>
-    </ul>
-</div>
-        <h3 class="subsection-title">Methods</h3>
-<div class="section-method">
-    <h4 class="name" id="getUnsafeReason"><span class="type-signature"></span>getUnsafeReason<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
-<div class="description">
-    <p>When the provided value is an unsafe number, describe what the reason is</p>
-<ul>
-<li><code>'overflow'</code></li>
-<li><code>'underflow'</code></li>
-<li><code>'truncate_integer'</code></li>
-<li><code>'truncate_float'</code></li>
-<li><code>'none'</code> (when the value is safe)</li>
-</ul>
-</div>
-<dl class="details">
-</dl>
-    <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>value</code></td>
-            <td class="type">
-<span class="param-type"><code>string</code></span>
-            </td>
-            <td class="description last">
-                <p>The string represents a number to test.</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>string</code></span>
-    </dd>
-</dl>
-<div class="param-desc">
-    <p>The reason why the value is unsafe. Returns <code>'none'</code> when the value is safe.</p>
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="isBigInt"><span class="type-signature"></span>isBigInt<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
-<div class="description">
-    <p>Test whether a string represents a BigInt.</p>
-</div>
-<dl class="details">
-</dl>
-    <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>value</code></td>
-            <td class="type">
-            </td>
-            <td class="description last">
-                <p>The string to test.</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>boolean</code></span>
-    </dd>
-</dl>
-<div class="param-desc">
-    <p>true if the string contains a BigInt; false otherwise.</p>
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="isInteger"><span class="type-signature"></span>isInteger<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
-<div class="description">
-    <p>Test whether a string represents an integer.</p>
-</div>
-<dl class="details">
-</dl>
-    <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>value</code></td>
-            <td class="type">
-            </td>
-            <td class="description last">
-                <p>The string to test.</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>boolean</code></span>
-    </dd>
-</dl>
-<div class="param-desc">
-    <p>true if the string contains an integer; false otherwise.</p>
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="isNumber"><span class="type-signature"></span>isNumber<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
-<div class="description">
-    <p>Test whether a string represents a number</p>
-</div>
-<dl class="details">
-</dl>
-    <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>value</code></td>
-            <td class="type">
-<span class="param-type"><code>string</code></span>
-            </td>
-            <td class="description last">
-                <p>The string to test.</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>boolean</code></span>
-    </dd>
-</dl>
-<div class="param-desc">
-    <p>true if the string contains a number; false otherwise.</p>
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="isSafeNumber"><span class="type-signature"></span>isSafeNumber<span class="signature">(value, options)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
-<div class="description">
-    <p>Test whether a string can be safely represented with a number without
-information loss.</p>
-<p>When the argument <code>approx</code> is true, floating point numbers that lose a few
-digits but are still approximately equal in value are considered safe too.
-Integer numbers must still be exactly equal.</p>
-</div>
-<dl class="details">
-</dl>
-    <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>value</code></td>
-            <td class="type">
-<span class="param-type"><code>string</code></span>
-            </td>
-            <td class="description last">
-                <p>The string to test.</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>object</code></span>
-            </td>
-            <td class="description last">
-                <p>The options of the test. It may contain the following properties:
-- <code>approx: boolean</code>: indicates whether to consider approximately equal
-floating point numbers as safe. Default is <code>false</code>.
-- <code>requiredDigits: number</code>: the number of significant digits required for
-a floating point number to be considered approximately equal. Default
-is <code>14</code>.</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>boolean</code></span>
-    </dd>
-</dl>
-<div class="param-desc">
-    <p>true if the string can be safely represented with a number; false
-otherwise.</p>
-</div>
-</div>
-</div>
-<div class="section-method">
-    <h4 class="name" id="toSafeNumberOrThrow"><span class="type-signature"></span>toSafeNumberOrThrow<span class="signature">(value, options)</span><span class="type-signature"> &rarr; {number}</span></h4>
-<div class="description">
-    <p>Convert a string into a number when it is safe to do so.
-Throws an error otherwise, explaining the reason.</p>
-</div>
-<dl class="details">
-</dl>
-    <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>value</code></td>
-            <td class="type">
-<span class="param-type"><code>string</code></span>
-            </td>
-            <td class="description last">
-                <p>The string to convert into a number.</p>
-            </td>
-        </tr>
-        <tr>
-                <td class="name"><code>options</code></td>
-            <td class="type">
-<span class="param-type"><code>object</code></span>
-            </td>
-            <td class="description last">
-                <p>The options for conversion.</p>
-            </td>
-        </tr>
-    </tbody>
-</table>
-<div class="section-throws">
-<h5>Throws:</h5>
-<dl>
-    <dt>
-        <div class="param-desc">
-        <p>When the value is not safe to convert.</p>
-        </div>
-    </dt>
-    <dd></dd>
-    <dt>
-        <dl>
-            <dt>
-                Type
-            </dt>
-            <dd>
-<span class="param-type"><code>Error</code></span>
-            </dd>
-        </dl>
-    </dt>
-    <dd></dd>
-</dl>
-</div>
-<div class="section-returns">
-<h5>Returns:</h5>
-<dl class="param-type">
-    <dt>
-        Type:
-    </dt>
-    <dd>
-<span class="param-type"><code>number</code></span>
-    </dd>
-</dl>
-<div class="param-desc">
-    <p>The converted safe number.</p>
-</div>
-</div>
-</div>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
-     on Wed Apr 16 2025 18:02:33 GMT+0800 (China Standard Time)
-    using the <a href="https://github.com/Haixing-Hu/jsdoc-minami">customized Minami theme</a>.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>
+<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Global</title><!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LosslessNumber.html">LosslessNumber</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#getUnsafeReason">getUnsafeReason</a></div><div class="sidebar-section-children"><a href="global.html#isBigInt">isBigInt</a></div><div class="sidebar-section-children"><a href="global.html#isInteger">isInteger</a></div><div class="sidebar-section-children"><a href="global.html#isNumber">isNumber</a></div><div class="sidebar-section-children"><a href="global.html#isSafeNumber">isSafeNumber</a></div><div class="sidebar-section-children"><a href="global.html#json">json</a></div><div class="sidebar-section-children"><a href="global.html#toSafeNumberOrThrow">toSafeNumberOrThrow</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><article><div class="container-overview"></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="json"><span class="type-signature">(constant) </span>json<span class="type-signature"> :object</span></h3><div class="description"><p>A customized JSON object which supports lossless number parsing and stringifying.</p><p>This object provides two methods: <code>parse</code> and <code>stringify</code>, which are the same as the <code>JSON.parse</code> and <code>JSON.stringify</code> methods, except that they support lossless number parsing and stringifying.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">object</span></li></ul></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="getUnsafeReason"><span class="type-signature"></span>getUnsafeReason<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h3><div class="description"><p>When the provided value is an unsafe number, describe what the reason is</p><ul><li><code>'overflow'</code></li><li><code>'underflow'</code></li><li><code>'truncate_integer'</code></li><li><code>'truncate_float'</code></li><li><code>'none'</code> (when the value is safe)</li></ul></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The string represents a number to test.</p></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The reason why the value is unsafe. Returns <code>'none'</code> when the value is safe.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id="isBigInt"><span class="type-signature"></span>isBigInt<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h3><div class="description"><p>Test whether a string represents a BigInt.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"></td><td class="description last"><p>The string to test.</p></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>true if the string contains a BigInt; false otherwise.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isInteger"><span class="type-signature"></span>isInteger<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h3><div class="description"><p>Test whether a string represents an integer.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"></td><td class="description last"><p>The string to test.</p></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>true if the string contains an integer; false otherwise.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isNumber"><span class="type-signature"></span>isNumber<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h3><div class="description"><p>Test whether a string represents a number</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The string to test.</p></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>true if the string contains a number; false otherwise.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="isSafeNumber"><span class="type-signature"></span>isSafeNumber<span class="signature">(value, options)</span><span class="type-signature"> &rarr; {boolean}</span></h3><div class="description"><p>Test whether a string can be safely represented with a number without information loss.</p><p>When the argument <code>approx</code> is true, floating point numbers that lose a few digits but are still approximately equal in value are considered safe too. Integer numbers must still be exactly equal.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The string to test.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The options of the test. It may contain the following properties: - <code>approx: boolean</code>: indicates whether to consider approximately equal floating point numbers as safe. Default is <code>false</code>. - <code>requiredDigits: number</code>: the number of significant digits required for a floating point number to be considered approximately equal. Default is <code>14</code>.</p></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>true if the string can be safely represented with a number; false otherwise.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id="toSafeNumberOrThrow"><span class="type-signature"></span>toSafeNumberOrThrow<span class="signature">(value, options)</span><span class="type-signature"> &rarr; {number}</span></h3><div class="description"><p>Convert a string into a number when it is safe to do so. Throws an error otherwise, explaining the reason.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">string</span></td><td class="description last"><p>The string to convert into a number.</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The options for conversion.</p></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Throws:</strong><dl><dt><div class="param-desc"><p>When the value is not safe to convert.</p></div></dt><dd></dd><dt><dl><dt>Type</dt><dd><span class="param-type">Error</span></dd></dl></dt><dd></dd></dl></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The converted safe number.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">number</span></dd></dl></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LosslessNumber.html">LosslessNumber</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#getUnsafeReason">getUnsafeReason</a></div><div class="sidebar-section-children"><a href="global.html#isBigInt">isBigInt</a></div><div class="sidebar-section-children"><a href="global.html#isInteger">isInteger</a></div><div class="sidebar-section-children"><a href="global.html#isNumber">isNumber</a></div><div class="sidebar-section-children"><a href="global.html#isSafeNumber">isSafeNumber</a></div><div class="sidebar-section-children"><a href="global.html#json">json</a></div><div class="sidebar-section-children"><a href="global.html#toSafeNumberOrThrow">toSafeNumberOrThrow</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>