profectus-docs/assets/api_modules_util_break_eternity.md.251d6fb2.js

2 lines
13 KiB
JavaScript
Raw Normal View History

import{_ as e,c as t,o as r,a}from"./app.e5a3543f.js";const b='{"title":"Module: util/break_eternity","description":"","frontmatter":{},"headers":[{"level":2,"title":"References","slug":"references"},{"level":3,"title":"default","slug":"default"},{"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/break_eternity.md"}',d={},i=a('<h1 id="module-util-break-eternity" tabindex="-1">Module: util/break_eternity <a class="header-anchor" href="#module-util-break-eternity" 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>Renames and re-exports <a href="../../classes/lib/break_eternity.Decimal">Decimal</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><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/2e3f1de/src/util/break_eternity.ts#L27" target="_blank" rel="noopener noreferrer">profectus/src/util/break_eternity.ts:27</a></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><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="http