profectus/profectus-docs
1
0
Fork 0
Code Issues 12 Pull requests 1 Projects 1 Releases Packages Wiki Activity Actions
profectus-docs/assets/api_modules_util_bignum.md.58e641fc.js

1 line
19 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Module: util/bignum","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/util/bignum.md","lastUpdated":null}'),o={name:"api/modules/util/bignum.md"},i=r('<h1 id="module-util-bignum" tabindex="-1">Module: util/bignum <a class="header-anchor" href="#module-util-bignum" aria-label="Permalink to &quot;Module: util/bignum&quot;">​</a></h1><h2 id="references" tabindex="-1">References <a class="header-anchor" href="#references" aria-label="Permalink to &quot;References&quot;">​</a></h2><h3 id="default" tabindex="-1">default <a class="header-anchor" href="#default" aria-label="Permalink to &quot;default&quot;">​</a></h3><p>• <strong>default</strong>: <code>Object</code></p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L46" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:46</a></p><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to &quot;Type Aliases&quot;">​</a></h2><h3 id="decimalsource" tabindex="-1">DecimalSource <a class="header-anchor" href="#decimalsource" aria-label="Permalink to &quot;DecimalSource&quot;">​</a></h3><p>Ƭ <strong>DecimalSource</strong>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L18" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:18</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-label="Permalink to &quot;Functions&quot;">​</a></h2><h3 id="commaformat" tabindex="-1">commaFormat <a class="header-anchor" href="#commaformat" aria-label="Permalink to &quot;commaFormat&quot;">​</a></h3><p>▸ <strong>commaFormat</strong>(<code>num</code>, <code>precision</code>): <code>string</code></p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>num</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr><tr><td style="text-align:left;"><code>precision</code></td><td style="text-align:left;"><code>number</code></td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>string</code></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L28" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:28</a></p><p>• <strong>commaFormat</strong>: (<code>num</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>, <code>precision</code>: <code>number</code>) =&gt; <code>string</code></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L8" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:8</a></p><hr><h3 id="exponentialformat" tabindex="-1">exponentialFormat <a class="header-anchor" href="#exponentialformat" aria-label="Permalink to &quot;exponentialFormat&quot;">​</a></h3><p>▸ <strong>exponentialFormat</strong>(<code>num</code>, <code>precision</code>, <code>mantissa?</code>): <code>string</code></p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th></tr></thead><tbody><tr><td style="text-align:left;"><code>num</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>precision</code></td><td style="text-align:left;"><code>number</code></td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>mantissa</code></td><td style="text-align:left;"><code>boolean</code></td><td style="text-align:left;"><code>true</code></td></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>string</code></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L9" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:9</a></p><p>• <strong>exponentialFormat</strong>: (<code>num</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>, <code>precision</code>: <code>number</code>, <code>mantissa</code>: <code>boolean</code>) =&gt; <code>string</code></p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L7" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:7</a></p><hr><h3 id="format" tabindex="-1">format <a class="header-anchor" href="#format" aria-label="Permalink to &quot;format&quot;">​</a></h3><p>▸ <strong>format</strong>(<code>num</code>, <code>precision?</code>, <code>small?</code>): <code>string</code></p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>num</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr><tr><td style="text-align:left;"><code>precision?</code></td><td style="text-align:left;"><code>number</code></td></tr><tr><td style="text-align:left;"><code>small?</code></td><td style="text-align:left;"><code>boolean</code></td></tr></tbody></table><h4 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>string</code></p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L69" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:69</a></p><p>• <strong>format</strong>: (<code>num</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>, <code>precision?</code>: <code>number</code>, <code>small?</code>: <code>boolean</code>) =&gt; <code>string</code></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L10" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:10</a></p><hr><h3 id="formatsmall" tabindex="-1">formatSmall <a class="header-anchor" href="#formatsmall" aria-label="Permalink to &quot;formatSmall&quot;">​</a></h3><p>▸ <strong>formatSmall</strong>(<code>x</code>, <code>precision?</code>): <code>string</code></p><h4 id="parameters-3" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-3" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>x</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr><tr><td style="text-align:left;"><code>precision?</code></td><td style="text-align:left;"><code>number</code></td></tr></tbody></table><h4 id="returns-3" tabindex="-1">Returns <a class="header-anchor" href="#returns-3" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>string</code></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L185" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:185</a></p><p>• <strong>formatSmall</strong>: (<code>x</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>, <code>precision?</code>: <code>number</code>) =&gt; <code>string</code></p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L14" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:14</a></p><hr><h3 id="formattime" tabindex="-1">formatTime <a class="header-anchor" href="#formattime" aria-label="Permalink to &quot;formatTime&quot;">​</a></h3><p>▸ <strong>formatTime</strong>(<code>seconds</code>): <code>string</code></p><h4 id="parameters-4" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-4" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>seconds</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h4 id="returns-4" tabindex="-1">Returns <a class="header-anchor" href="#returns-4" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>string</code></p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L130" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:130</a></p><p>• <strong>formatTime</strong>: (<code>seconds</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>) =&gt; <code>string</code></p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L12" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:12</a></p><hr><h3 id="formatwhole" tabindex="-1">formatWhole <a class="header-anchor" href="#formatwhole" aria-label="Permalink to &quot;formatWhole&quot;">​</a></h3><p>▸ <strong>formatWhole</strong>(<code>num</code>): <code>string</code></p><h4 id="parameters-5" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-5" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>num</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h4 id="returns-5" tabindex="-1">Returns <a class="header-anchor" href="#returns-5" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>string</code></p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L116" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:116</a></p><p>• <strong>formatWhole</strong>: (<code>num</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>) =&gt; <code>string</code></p><h4 id="defined-in-13" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-13" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L11" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:11</a></p><hr><h3 id="invertoom" tabindex="-1">invertOOM <a class="header-anchor" href="#invertoom" aria-label="Permalink to &quot;invertOOM&quot;">​</a></h3><p>▸ <strong>invertOOM</strong>(<code>x</code>): <a href="./../lib/break_eternity#default"><code>default</code></a></p><h4 id="parameters-6" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-6" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>x</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h4 id="returns-6" tabindex="-1">Returns <a class="header-anchor" href="#returns-6" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><a href="./../lib/break_eternity#default"><code>default</code></a></p><h4 id="defined-in-14" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-14" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L189" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:189</a></p><p>• <strong>invertOOM</strong>: (<code>x</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>) =&gt; <a href="./../lib/break_eternity#default"><code>default</code></a></p><h4 id="defined-in-15" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-15" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L15" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:15</a></p><hr><h3 id="regularformat" tabindex="-1">regularFormat <a class="header-anchor" href="#regularformat" aria-label="Permalink to &quot;regularFormat&quot;">​</a></h3><p>▸ <strong>regularFormat</strong>(<code>num</code>, <code>precision</code>): <code>string</code></p><h4 id="parameters-7" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-7" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>num</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr><tr><td style="text-align:left;"><code>precision</code></td><td style="text-align:left;"><code>number</code></td></tr></tbody></table><h4 id="returns-7" tabindex="-1">Returns <a class="header-anchor" href="#returns-7" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>string</code></p><h4 id="defined-in-16" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-16" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L43" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:43</a></p><p>• <strong>regularFormat</strong>: (<code>num</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>, <code>precision</code>: <code>number</code>) =&gt; <code>string</code></p><h4 id="defined-in-17" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-17" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L9" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:9</a></p><hr><h3 id="toplaces" tabindex="-1">toPlaces <a class="header-anchor" href="#toplaces" aria-label="Permalink to &quot;toPlaces&quot;">​</a></h3><p>▸ <strong>toPlaces</strong>(<code>x</code>, <code>precision</code>, <code>maxAccepted</code>): <code>string</code></p><h4 id="parameters-8" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-8" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>x</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr><tr><td style="text-align:left;"><code>precision</code></td><td style="text-align:left;"><code>number</code></td></tr><tr><td style="text-align:left;"><code>maxAccepted</code></td><td style="text-align:left;"><a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h4 id="returns-8" tabindex="-1">Returns <a class="header-anchor" href="#returns-8" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>string</code></p><h4 id="defined-in-18" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-18" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/break_eternity.ts#L173" target="_blank" rel="noreferrer">profectus/src/util/break_eternity.ts:173</a></p><p>• <strong>toPlaces</strong>: (<code>x</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>, <code>precision</code>: <code>number</code>, <code>maxAccepted</code>: <a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>) =&gt; <code>string</code></p><h4 id="defined-in-19" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-19" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/util/bignum.ts#L13" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:13</a></p>',119),n=[i];function d(c,l,s,h,u,f){return a(),t("div",null,n)}const p=e(o,[["render",d]]);export{m as __pageData,p as default};
Reference in a new issue View git blame Copy permalink