-
Notifications
You must be signed in to change notification settings - Fork 322
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Commit a checkpoint for API docs/cleanup
Loads of stuff has changed already; best to merge already to avoid conflicts.
- Loading branch information
1 parent
5c979a8
commit 3c592ae
Showing
367 changed files
with
8,111 additions
and
1,228 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-documenter.schema.json", | ||
"newlineKind": "lf", | ||
"outputTarget": "markdown" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [(constructor)](./decimal.decimal._constructor_.md) | ||
|
||
## Decimal.(constructor) | ||
|
||
Constructs a new instance of the `Decimal` class | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
constructor(bigNumber: BigNumber); | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| bigNumber | BigNumber | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [absoluteValue](./decimal.decimal.absolutevalue.md) | ||
|
||
## Decimal.absoluteValue property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get absoluteValue(): this; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [add](./decimal.decimal.add.md) | ||
|
||
## Decimal.add() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
add(addend: Decimalish): Decimal; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| addend | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
[Decimal](./decimal.decimal.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [bigNumber](./decimal.decimal.bignumber.md) | ||
|
||
## Decimal.bigNumber property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly bigNumber: BigNumber; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [bigNumberFrom](./decimal.decimal.bignumberfrom.md) | ||
|
||
## Decimal.bigNumberFrom() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static bigNumberFrom(decimalish: Decimalish): BigNumber; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| decimalish | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
BigNumber | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [DIGITS](./decimal.decimal.digits.md) | ||
|
||
## Decimal.DIGITS property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static readonly DIGITS: BigNumber; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [div](./decimal.decimal.div.md) | ||
|
||
## Decimal.div() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
div(divider: Decimalish): Decimal; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| divider | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
[Decimal](./decimal.decimal.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [eq](./decimal.decimal.eq.md) | ||
|
||
## Decimal.eq() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
eq(that: Decimalish): boolean; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| that | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
boolean | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [finite](./decimal.decimal.finite.md) | ||
|
||
## Decimal.finite property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get finite(): this | undefined; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [from](./decimal.decimal.from.md) | ||
|
||
## Decimal.from() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static from(decimalish: Decimalish): Decimal; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| decimalish | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
[Decimal](./decimal.decimal.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [gt](./decimal.decimal.gt.md) | ||
|
||
## Decimal.gt() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
gt(that: Decimalish): boolean; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| that | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
boolean | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [gte](./decimal.decimal.gte.md) | ||
|
||
## Decimal.gte() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
gte(that: Decimalish): boolean; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| that | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
boolean | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [HALF](./decimal.decimal.half.md) | ||
|
||
## Decimal.HALF property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static readonly HALF: Decimal; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [infinite](./decimal.decimal.infinite.md) | ||
|
||
## Decimal.infinite property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get infinite(): this | undefined; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [INFINITY](./decimal.decimal.infinity.md) | ||
|
||
## Decimal.INFINITY property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
static readonly INFINITY: Decimal; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [isZero](./decimal.decimal.iszero.md) | ||
|
||
## Decimal.isZero property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
get isZero(): boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [lt](./decimal.decimal.lt.md) | ||
|
||
## Decimal.lt() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
lt(that: Decimalish): boolean; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| that | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
boolean | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [lte](./decimal.decimal.lte.md) | ||
|
||
## Decimal.lte() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
lte(that: Decimalish): boolean; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| that | [Decimalish](./decimal.decimalish.md) | | | ||
|
||
<b>Returns:</b> | ||
|
||
boolean | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) | ||
|
||
## Decimal class | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare class Decimal | ||
``` | ||
|
||
## Constructors | ||
|
||
| Constructor | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [(constructor)(bigNumber)](./decimal.decimal._constructor_.md) | | Constructs a new instance of the <code>Decimal</code> class | | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| [absoluteValue](./decimal.decimal.absolutevalue.md) | | this | | | ||
| [bigNumber](./decimal.decimal.bignumber.md) | | BigNumber | | | ||
| [DIGITS](./decimal.decimal.digits.md) | <code>static</code> | BigNumber | | | ||
| [finite](./decimal.decimal.finite.md) | | this \| undefined | | | ||
| [HALF](./decimal.decimal.half.md) | <code>static</code> | [Decimal](./decimal.decimal.md) | | | ||
| [infinite](./decimal.decimal.infinite.md) | | this \| undefined | | | ||
| [INFINITY](./decimal.decimal.infinity.md) | <code>static</code> | [Decimal](./decimal.decimal.md) | | | ||
| [isZero](./decimal.decimal.iszero.md) | | boolean | | | ||
| [nonZero](./decimal.decimal.nonzero.md) | | this \| undefined | | | ||
| [ONE](./decimal.decimal.one.md) | <code>static</code> | [Decimal](./decimal.decimal.md) | | | ||
| [PRECISION](./decimal.decimal.precision.md) | <code>static</code> | (not declared) | | | ||
| [zero](./decimal.decimal.zero.md) | | this \| undefined | | | ||
| [ZERO](./decimal.decimal.zero.md) | <code>static</code> | [Decimal](./decimal.decimal.md) | | | ||
|
||
## Methods | ||
|
||
| Method | Modifiers | Description | | ||
| --- | --- | --- | | ||
| [add(addend)](./decimal.decimal.add.md) | | | | ||
| [bigNumberFrom(decimalish)](./decimal.decimal.bignumberfrom.md) | <code>static</code> | | | ||
| [div(divider)](./decimal.decimal.div.md) | | | | ||
| [eq(that)](./decimal.decimal.eq.md) | | | | ||
| [from(decimalish)](./decimal.decimal.from.md) | <code>static</code> | | | ||
| [gt(that)](./decimal.decimal.gt.md) | | | | ||
| [gte(that)](./decimal.decimal.gte.md) | | | | ||
| [lt(that)](./decimal.decimal.lt.md) | | | | ||
| [lte(that)](./decimal.decimal.lte.md) | | | | ||
| [mul(multiplier)](./decimal.decimal.mul.md) | | | | ||
| [mulDiv(multiplier, divider)](./decimal.decimal.muldiv.md) | | | | ||
| [pow(exponent)](./decimal.decimal.pow.md) | | | | ||
| [prettify(precision)](./decimal.decimal.prettify.md) | | | | ||
| [prettify(bigNumberish)](./decimal.decimal.prettify.md) | <code>static</code> | | | ||
| [shorten()](./decimal.decimal.shorten.md) | | | | ||
| [shorten(bigNumber)](./decimal.decimal.shorten.md) | <code>static</code> | | | ||
| [sub(subtrahend)](./decimal.decimal.sub.md) | | | | ||
| [toString(precision)](./decimal.decimal.tostring.md) | | | | ||
|
Oops, something went wrong.