ethers.js/docs.wrm/api/utils/fixednumber.wrm

_title: Fixed Number

_section: FixedNumber @<fixednumber>

_subsection: FixedFormat @<fixedformat>

A **FixedFormat** is a simple object which represents a decimal
(base-10) Fixed-Point data representation. Usually using this
class directly is uneccessary, as passing in a [[fixedformatstring]]
directly into the [[fixednumber]] will automatically create this.

_heading: Format Strings  @<fixedformatstring>

A format string is composed of three components, including signed-ness,
bit-width and number of decimals.

A signed format string begins with ``fixed``, which an unsigned format
string begins with ``ufixed``, followed by the width (in bits) and the
number of decimals.

The width must be conguent to 0 mod 8 (i.e. ``(width % 8) == 0``) and no
larger than 256 bits and the number of decimals must be no larger than 80.

For example:

- **fixed128x18** is signed, 128 bits wide and has 18 decimals; this is useful for most purposes
- **fixed32x0** is signed, 32 bits wide and has 0 decimals; this would be the same as a ``int32_t` in C
- **ufixed32x0** is unsigned, 32 bits wide and has 0 decimals; this would be the same as a ``uint32_t` in C
- **fixed** is shorthand for ``fixed128x18`
- **ufixed** is shorthand for ``ufixed128x18`

_heading: Creating Instances

_property: FixedFormat.from(value = "fixed128x18") => [[fixedformat]]  @<fixednumber-from> @SRC<bignumber/fixednumber:FixedFormat.from>

Returns a new instance of a **FixedFormat** defined by //value//. Any valid [[fixedformatstring]]
may be passed in as well as any object which has any of ``signed``, ``width`` and ``decimals``
defined, including a [[fixedformat]] object.

_heading: Properties

_property: fixedFormat.signed => boolean

_property: fixedFormat.width => number

_property: fixedFormat.decimals => number

_property: fixedFormat.name => string


_definition: **//"fixed"//**
A shorthand for ``fixed128x80``.

_subsection: Creating Instances

The FixedNumber constructor cannot be called directly. There are several
static methods for creating a FixedNumber.

_property: FixedNumber.from(value [ , format = "fixed" ] ) => [[fixednumber]]  @SRC<bignumber:FixedNumber.from>
Returns an instance of a **FixedNumber** for //value// as a //format//.

_property: FixedNumber.fromBytes(aBytesLike [ , format = "fixed" ] ) => [[fixednumber]]  @SRC<bignumber>
Returns an instance of a **FixedNumber** for //value// as a //format//.

_property: FixedNumber.fromString(value [ , format = "fixed" ] ) => [[fixednumber]]  @SRC<bignumber:FixedNumber.fromString>
Returns an instance of a **FixedNumber** for //value// as a //format//. The //value// must
not contain more decimals than the //format// permits.

_property: FixedNumber.fromValue(value [ , decimals = 0 [ , format = "fixed" ] ] ) => [[fixednumber]]  @SRC<bignumber:FixedNumber.fromValue>
Returns an instance of a **FixedNumber** for //value// with //decimals// as a //format//.


_subsection: Properties

_property: fixednumber.format
The [FixedFormat](fixedformat) of //fixednumber//.


_subsection: Methods

_heading: Math Operations

_property: fixednumber.addUnsafe(otherValue) => [[fixednumber]]  @SRC<bignumber/fixednumber>
Returns a new FixedNumber with the value of //fixedvalue// **+** //otherValue//.

_property: fixednumber.subUnsafe(otherValue) => [[fixednumber]]  @SRC<bignumber/fixednumber>
Returns a new FixedNumber with the value of //fixedvalue// **&ndash;** //otherValue//.

_property: fixednumber.mulUnsafe(otherValue) => [[fixednumber]]  @SRC<bignumber/fixednumber>
Returns a new FixedNumber with the value of //fixedvalue// **&times;** //otherValue//.

_property: fixednumber.divUnsafe(otherValue) => [[fixednumber]]  @SRC<bignumber/fixednumber>
Returns a new FixedNumber with the value of //fixedvalue// **&#247;** //otherValue//.

_property: fixednumber.round([ decimals = 0 ]) => [[fixednumber]]  @SRC<bignumber/fixednumber>
Returns a new FixedNumber with the value of //fixedvalue// rounded to //decimals//.


_heading: Conversion

_property: fixednumber.toFormat(format) => [[fixednumber]]  @SRC<bignumber/fixednumber>
Returns a new FixedNumber with the value of //fixedvalue// with //format//.

_property: fixednumber.toHexString() => string  @SRC<bignumber/fixednumber>
Returns a [Hexstring](hexstring) representation of //fixednumber//.

_property: fixednumber.toString() => string  @SRC<bignumber/fixednumber>
Returns a string representation of //fixednumber//.

_property: fixednumber.toUnsafeFloat() => float  @SRC<bignumber/fixednumber>
Returns a floating-point JavaScript number value of //fixednumber//.
Due to rounding in JavaScript numbers, the value is only approximate.


_heading: Inspection

_property: FixedNumber.isFixedNumber(value) => boolean  @SRC<bignumber/fixednumber>
Returns true if and only if //value// is a **FixedNumber**.