npm - @qubit-ltd/json - Versions diffs - 1.1.4 - Mend

@qubit-ltd/json 1.1.4

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

package/LICENSE +201 -0
package/README.md +219 -0
package/README.zh_CN.md +194 -0
package/dist/json.cjs +623 -0
package/dist/json.cjs.map +1 -0
package/dist/json.min.cjs +1 -0
package/dist/json.min.cjs.map +1 -0
package/dist/json.min.mjs +1 -0
package/dist/json.min.mjs.map +1 -0
package/dist/json.mjs +610 -0
package/dist/json.mjs.map +1 -0
package/doc/api/LosslessNumber.html +610 -0
package/doc/api/fonts/OpenSans-Bold-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Bold-webfont.svg +1838 -0
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 +1838 -0
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 +1838 -0
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 +1839 -0
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 +1843 -0
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 +1839 -0
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 +1838 -0
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 +1838 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/doc/api/global.html +1274 -0
package/doc/api/index.html +236 -0
package/doc/api/scripts/linenumber.js +34 -0
package/doc/api/scripts/prettify/Apache-License-2.0.txt +202 -0
package/doc/api/scripts/prettify/lang-css.js +2 -0
package/doc/api/scripts/prettify/prettify.js +28 -0
package/doc/api/styles/jsdoc-default.css +699 -0
package/doc/api/styles/prettify-jsdoc.css +120 -0
package/doc/api/styles/prettify-tomorrow.css +141 -0
package/doc/json.min.visualization.html +4949 -0
package/doc/json.visualization.html +4949 -0
package/package.json +87 -0

package/doc/api/global.html ADDED Viewed

@@ -0,0 +1,1274 @@
+<!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 Sun Jan 05 2025 14:35:14 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>