profectus-docs/assets/api_modules_util_bignum.md.38c15152.js

1 line
11 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"},l=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>Re-exports <a href="./../lib/break_eternity#default">default</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" 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/b5e7e77/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><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="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/b5e7e77/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><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="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/b5e7e77/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><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="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/b5e7e77/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><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="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/b5e7e77/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><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="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/b5e7e77/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><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="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/b5e7e77/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><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="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/b5e7e77/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><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="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/b5e7e77/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><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="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/b5e7e77/src/util/bignum.ts#L13" target="_blank" rel="noreferrer">profectus/src/util/bignum.ts:13</a></p>',63),i=[l];function d(n,c,s,h,f,u){return a(),t("div",null,i)}const g=e(o,[["render",d]]);export{m as __pageData,g as default};