35 lines
16 KiB
HTML
35 lines
16 KiB
HTML
<html><head><title>Fixed Number</title><link rel="stylesheet" type="text/css" href="/static/style.css"></head><body><div class="sidebar"><div class="header"><div class="logo"><a href="/"><div class="image"></div><div class="name">ethers.js</div><div class="version">v5.0</div></a></div></div><div class="toc"><div><div class="link title"><a href="/">Documentation</a></div><div class="base show link depth-1"><a href="/getting-started/">Getting Started</a></div><div class="hide link depth-2"><a href="/getting-started/#installing">Installing</a></div><div class="hide link depth-2"><a href="/getting-started/#importing">Importing</a></div><div class="base show link depth-1"><a href="/concepts/">Concepts</a></div><div class="hide link depth-2"><a href="/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/concepts/gas/">Gas</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-price">Gas Price</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-limit">Gas Limit</a></div><div class="base ancestor show link depth-1"><a href="/api/">Application Programming Interface</a></div><div class="show link depth-2"><a href="/api/contract/">Contracts</a></div><div class="hide link depth-3"><a href="/api/contract/#buckets">Buckets</a></div><div class="show link depth-2"><a href="/api/signer/">Signers</a></div><div class="hide link depth-3"><a href="/api/signer/#signer">Signer</a></div><div class="hide link depth-3"><a href="/api/signer/#wallet-inherits-signer">Wallet inherits Signer</a></div><div class="show link depth-2"><a href="/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/api/providers/provider/">Provider</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#accounts-methods">Accounts Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#blocks-methods">Blocks Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#ethereum-naming-service-(ens)-methods">Ethereum Naming Service (ENS) Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#logs-methods">Logs Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#network-status-methods">Network Status Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#transactions-methods">Transactions Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#event-emitter-methods">Event Emitter Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#inspection-methods">Inspection Methods</a></div><div class="hide link depth-3"><a href="/api/providers/jsonrpc-provider/">JSON-RPC Provider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcprovider">JsonRpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcsigner">JsonRpcSigner</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcuncheckedsigner">JsonRpcUncheckedSigner</a></div><div class="hide link depth-3"><a href="/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#etherscanprovider">EtherscanProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#infuraprovider">InfuraProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#nodesmithprovider">NodesmithProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</a></div><div class="hide link depth-3"><a href="/api/providers/other/">Other Providers</a></div><div class="hide link depth-4"><a href="/api/providers/other/#fallbackprovider">FallbackProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#ipcprovider">IpcProvider</a></div><div class="hide link depth-3"><a href="/api/providers/types/">Types</a></div><div class="hide link depth-4"><a href="/api/providers/types/#blocks">Blocks</a></div><div class="hide link depth-4"><a href="/api/providers/types/#events-and-logs">Events and Logs</a></div><div class="hide link depth-4"><a href="/api/providers/types/#transactions">Transactions</a></div><div class="ancestor show link depth-2"><a href="/api/utils/">Utilities</a></div><div class="show link depth-3"><a href="/api/utils/address/">Addresses</a></div><div class="show link depth-3"><a href="/api/utils/bignumber/">BigNumber</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#creating-instances">Creating Instances</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#methods">Methods</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#notes">Notes</a></div><div class="show link depth-3"><a href="/api/utils/bytes/">Byte Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#inspection">Inspection</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#converting-between-arrays-and-hexstrings">Converting between Arrays and Hexstrings</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#array-manipulation">Array Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#hexstring-manipulation">Hexstring Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#signature-conversion">Signature Conversion</a></div><div class="show link depth-3"><a href="/api/utils/constants/">Constants</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#bytes">Bytes</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#strings">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#bignumber">BigNumber</a></div><div class="show link depth-3"><a href="/api/utils/display-logic/">Display Logic and Input</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#units">Units</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#functions">Functions</a></div><div class="myself ancestor ancestor show link depth-3"><a href="/api/utils/fixednumber/">FixedNumber</a></div><div class="child link depth-4"><a href="/api/utils/fixednumber/#types">Types</a></div><div class="child link depth-4"><a href="/api/utils/fixednumber/#creating-instances">Creating Instances</a></div><div class="child link depth-4"><a href="/api/utils/fixednumber/#properties">Properties</a></div><div class="child link depth-4"><a href="/api/utils/fixednumber/#methods">Methods</a></div><div class="show link depth-3"><a href="/api/utils/hashing/">Hashing Algorithms</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#cryptographic-hashing">Cryptographic Hashing</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#common-hashing-helpers">Common Hashing Helpers</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#solidity-hashing-algorithms">Solidity Hashing Algorithms</a></div><div class="show link depth-3"><a href="/api/utils/strings/">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#bytes32string">Bytes32String</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#utf-8-strings">UTF-8 Strings</a></div><div class="base show link depth-1"><a href="/cookbook/">Cookbook</a></div><div class="base show link depth-1"><a href="/migration/">Migration Guide</a></div><div class="hide link depth-2"><a href="/migration/#from-web3">From Web3</a></div><div class="hide link depth-2"><a href="/migration/#from-ethers-v4">From ethers v4</a></div><div class="base show link depth-1"><a href="/testing/">Testing</a></div><div class="base show link depth-1"><a href="/contributing/">Contributing and Hacking</a></div><div class="hide link depth-2"><a href="/contributing/#building">Building</a></div><div class="base show link depth-1"><a href="/documentation/">Flatworm Docs</a></div><div class="hide link depth-2"><a href="/documentation/#fragments">Fragments</a></div><div class="hide link depth-2"><a href="/documentation/#markdown">Markdown</a></div><div class="base show link depth-1"><a href="/license/">License and Copyright</a></div></div></div></div><div class="content"><div class="breadcrumbs"><a href="/">Documentation</a> » <a href="/api/">Application Programming Interface</a> » <a href="/api/utils/">Utilities</a> » <span class="current">Fixed Number</span></div>
|
|
<a name="fixednumber"></a><a name="fixednumber"></a><h1>FixedNumber</h1>
|
|
|
|
<a name="types"></a><h2>Types</h2>
|
|
|
|
<a name="fixedformat"></a><a name="fixedformat"></a><h3>FixedFormat</h3>
|
|
<p>TODO</p>
|
|
<div class="definition"><div class="term"><b><i>"fixed"</i></b></div><div class="body"><p>A shorthand for <code class="inline">fixed128x80</code>.</p></div></div>
|
|
<a name="creating-instances"></a><h2>Creating Instances</h2>
|
|
<p>The FixedNumber constructor cannot be called directly. There are several static methods for creating a FixedNumber.</p>
|
|
<div class="property"><div class="signature"><span class="path">BigNumber</span> . <span class="method">from</span> ( <span class="param">value</span> [ , <span class="param">format</span> = <span class="default-value">"</span><span class="param">fixed</span>" ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns an instance of a <b>FixedNumber</b> for <i>value</i> as a <i>format</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">BigNumber</span> . <span class="method">fromBytes</span> ( <span class="param">aBytesLike</span> [ , <span class="param">format</span> = <span class="default-value">"</span><span class="param">fixed</span>" ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns an instance of a <b>FixedNumber</b> for <i>value</i> as a <i>format</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">BigNumber</span> . <span class="method">fromString</span> ( <span class="param">value</span> [ , <span class="param">format</span> = <span class="default-value">"</span><span class="param">fixed</span>" ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns an instance of a <b>FixedNumber</b> for <i>value</i> as a <i>format</i>. The <i>value</i> must not contain more decimals than the <i>format</i> permits.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">BigNumber</span> . <span class="method">fromValue</span> ( <span class="param">value</span> [ , <span class="param">decimals</span> = <span class="default-value">0</span> [ , <span class="param">format</span> = <span class="default-value">"</span><span class="param">fixed</span>" ] ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns an instance of a <b>FixedNumber</b> for <i>value</i> with <i>decimals</i> as a <i>format</i>.</p></div></div>
|
|
<a name="properties"></a><h2>Properties</h2>
|
|
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">format</span></div><div class="body"><p>The <a href="/api/utils/fixednumber/#fixedformat">FixedFormat</a> of <i>fixednumber</i>.</p></div></div>
|
|
<a name="methods"></a><h2>Methods</h2>
|
|
|
|
<a name="math-operations"></a><h3>Math Operations</h3>
|
|
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">addUnsafe</span> ( <span class="param">otherValue</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> <b>+</b> <i>otherValue</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">subUnsafe</span> ( <span class="param">otherValue</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> <b>–</b> <i>otherValue</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">mulUnsafe</span> ( <span class="param">otherValue</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> <b>×</b> <i>otherValue</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">divUnsafe</span> ( <span class="param">otherValue</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> <b>÷</b> <i>otherValue</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">round</span> ( [ <span class="param">decimals</span> = <span class="default-value">0</span> ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> rounded to <i>decimals</i>.</p></div></div>
|
|
<a name="conversion"></a><h3>Conversion</h3>
|
|
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">toFormat</span> ( <span class="param">format</span> ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/utils/fixednumber/">FixedNumber</a></span></div><div class="body"><p>Returns a new FixedNumber with the value of <i>fixedvalue</i> with <i>format</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">toHexString</span> ( ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns a <a href="/api/utils/bytes/#hexstring">Hexstring</a> representation of <i>fixednumber</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">toString</span> ( ) <span class="arrow">⇒</span> <span class="returns">string</span></div><div class="body"><p>Returns a string representation of <i>fixednumber</i>.</p></div></div>
|
|
<div class="property"><div class="signature"><span class="path">fixednumber</span> . <span class="method">toUnsafeFloat</span> ( ) <span class="arrow">⇒</span> <span class="returns">float</span></div><div class="body"><p>Returns a floating-point JavaScript number value of <i>fixednumber</i>. Due to rounding in JavaScript numbers, the value is only approximate.</p></div></div>
|
|
<a name="inspection"></a><h3>Inspection</h3>
|
|
|
|
<div class="property"><div class="signature"><span class="path">BigNumber</span> . <span class="method">isFixedNumber</span> ( <span class="param">value</span> ) <span class="arrow">⇒</span> <span class="returns">boolean</span></div><div class="body"><p>Returns true if and only if <i>value</i> is a <b>FixedNumber</b>.</p></div></div><div class="footer"><div class="nav previous"><a href="/api/utils/display-logic/"><span class="arrow">←</span>Display Logic and Input</a></div> <div class="nav next"><a href="/api/utils/hashing/">Hashing Algorithms<span class="arrow">→</span></a></div></div><div class="copyright">The content of this site is licensed under the <a href="https://choosealicense.com/licenses/cc-by-4.0/">Creative Commons Attribution 4.0 International License</a>.</div></div><script src="/script.js" type="text/javascript"></script></body></html><!-- ContentHash:aef4f7f17b9282a7369f6878ba405318fb007b9c6d1c891ecbc598ad8a55d5fd --> |