profectus-docs/assets/api_modules_util_bignum.md.6badd954.js

import{_ as e,c as t,o as a,a as r}from"./app.ab34650d.js";const g=JSON.parse('{"title":"Module: util/bignum","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"References","slug":"references"},{"level":3,"title":"default","slug":"default"},{"level":2,"title":"Type Aliases","slug":"type-aliases"},{"level":3,"title":"DecimalSource","slug":"decimalsource"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"commaFormat","slug":"commaformat"},{"level":3,"title":"exponentialFormat","slug":"exponentialformat"},{"level":3,"title":"format","slug":"format"},{"level":3,"title":"formatSmall","slug":"formatsmall"},{"level":3,"title":"formatTime","slug":"formattime"},{"level":3,"title":"formatWhole","slug":"formatwhole"},{"level":3,"title":"invertOOM","slug":"invertoom"},{"level":3,"title":"regularFormat","slug":"regularformat"},{"level":3,"title":"toPlaces","slug":"toplaces"}],"relativePath":"api/modules/util/bignum.md","lastUpdated":null}'),d={name:"api/modules/util/bignum.md"},l=r('<h1 id="module-util-bignum" tabindex="-1">Module: util/bignum <a class="header-anchor" href="#module-util-bignum" aria-hidden="true">#</a></h1><h2 id="references" tabindex="-1">References <a class="header-anchor" href="#references" aria-hidden="true">#</a></h2><h3 id="default" tabindex="-1">default <a class="header-anchor" href="#default" aria-hidden="true">#</a></h3><p>Re-exports <a href="../../classes/lib/break_eternity.default">default</a></p><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-hidden="true">#</a></h2><h3 id="decimalsource" tabindex="-1">DecimalSource <a class="header-anchor" href="#decimalsource" aria-hidden="true">#</a></h3><p>\u01AC <strong>DecimalSource</strong>: <a href="./../lib/break_eternity.html#decimalsource"><code>DecimalSource</code></a></p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/util/bignum.ts#L18" target="_blank" rel="noopener noreferrer">profectus/src/util/bignum.ts:18</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="commaformat" tabindex="-1">commaFormat <a class="header-anchor" href="#commaformat" aria-hidden="true">#</a></h3><p>\u25B8 <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-hidden="true">#</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.html#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-hidden="true">#</a></h4><p><code>string</code></p><hr><h3 id="exponentialformat" tabindex="-1">exponentialFormat <a class="header-anchor" href="#exponentialformat" aria-hidden="true">#</a></h3><p>\u25B8 <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-hidden="true">#</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.html#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-hidden="true">#</a></h4><p><code>string</code></p><hr><h3 id="format" tabindex="-1">format <a class="header-anchor" href="#format" aria-hidden="true">#</a></h3><p>\u25B8 <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-hidden="true">#</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.html#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-hidden="true">#</a></h4><p><code>string</code></p><hr><h3 id="formatsmall" tabindex="-1">formatSmall <a class="header-anchor" href="#formatsmall" aria-hidden="true">#</a></h3><p>\u25B8 <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-hidden="true">#</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.html#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-hidden="true">#</a></h4><p><code>string</code></p><hr><h3 id="formattime" tabindex="-1">formatTime <a class="header-anchor" href="#formattime" aria-hidden="true">#</a></h3><p>\u25B8 <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-hidden="true">#</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.html#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h4 id="returns-4" tabindex="-1">Returns <a class="header-anchor" href="#returns-4" aria-hidden="true">#</a></h4><p><code>string</code></p><hr><h3 id="formatwhole" tabindex="-1">formatWhole <a class="header-anchor" href="#formatwhole" aria-hidden="true">#</a></h3><p>\u25B8 <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-hidden="true">#</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.html#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h4 id="returns-5" tabindex="-1">Returns <a class="header-anchor" href="#returns-5" aria-hidden="true">#</a></h4><p><code>string</code></p><hr><h3 id="invertoom" tabindex="-1">invertOOM <a class="header-anchor" href="#invertoom" aria-hidden="true">#</a></h3><p>\u25B8 <strong>invertOOM</strong>(<code>x</code>): <a href="../../classes/lib/break_eternity.default"><code>default</code></a></p><h4 id="parameters-6" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-6" aria-hidden="true">#</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.html#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h4 id="returns-6" tabindex="-1">Returns <a class="header-anchor" href="#returns-6" aria-hidden="true">#</a></h4><p><a href="../../classes/lib/break_eternity.default"><code>default</code></a></p><hr><h3 id="regularformat" tabindex="-1">regularFormat <a class="header-anchor" href="#regularformat" aria-hidden="true">#</a></h3><p>\u25B8 <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-hidden="true">#</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.html#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-hidden="true">#</a></h4><p><code>string</code></p><hr><h3 id="toplaces" tabindex="-1">toPlaces <a class="header-anchor" href="#toplaces" aria-hidden="true">#</a></h3><p>\u25B8 <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-hidden="true">#</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.html#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.html#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h4 id="returns-8" tabindex="-1">Returns <a class="header-anchor" href="#returns-8" aria-hidden="true">#</a></h4><p><code>string</code></p>',72),o=[l];function i(n,c,s,h,m,u){return a(),t("div",null,o)}var b=e(d,[["render",i]]);export{g as __pageData,b as default};