Class Decimal

Arbitrary-precision decimal representation, comparison, and formatting. Import the arithmetic or scientific tier when calculations are required.

Hierarchy (View Summary)

DecimalLike
- Decimal
  - Decimal

Index

Constructors

Accessors

Constructors

constructor

new Decimal(value: DecimalValue): Decimal
Create a Decimal from an exact numeric input.
Parameters
- value: DecimalValue
Returns Decimal
Overrides DecimalBase.constructor
- Defined in src/CoreDecimal.ts:116

Accessors

`Static`config

get config(): Readonly<DecimalConfig>
Read a frozen snapshot of this constructor's active configuration.

Returns Readonly<DecimalConfig>
- Defined in src/CoreDecimal.ts:75
set config(params: DecimalConfigInput): void
Apply a validated partial configuration update to this constructor.
Parameters
- params: DecimalConfigInput
Returns void
- Defined in src/CoreDecimal.ts:80

`Static`limits

get limits(): DecimalLimits
Hard validation limits shared by every Decimal tier.

Returns DecimalLimits
- Defined in src/CoreDecimal.ts:73

Methods

[toPrimitive]

"[toPrimitive]"(hint: "string" | "number" | "default"): string | number
Convert according to JavaScript's primitive hint.
Parameters
- hint: "string" | "number" | "default"
Returns string | number
- Defined in src/CoreDecimal.ts:220

cmp

cmp(value: DecimalValue): number
Compare this value with another value.
Parameters
- value: DecimalValue
Returns number
- Defined in src/CoreDecimal.ts:151

dp

dp(): number
Returns number
The number of digits after the decimal point, or NaN for a non-finite value.
- Defined in src/CoreDecimal.ts:139

eq

eq(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value compares equal to value.
- Defined in src/CoreDecimal.ts:159

gt

gt(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value is greater than value.
- Defined in src/CoreDecimal.ts:162

gte

gte(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value is greater than or equal to value.
- Defined in src/CoreDecimal.ts:165

isEven

isEven(): boolean
Returns boolean
Whether this value is a finite even integer.
- Defined in src/CoreDecimal.ts:199

isFinite

isFinite(): boolean
Returns boolean
Whether this value is finite.
- Defined in src/CoreDecimal.ts:178

isInt

isInt(): boolean
Returns boolean
Whether this value is a finite integer.
- Defined in src/CoreDecimal.ts:181

isNaN

isNaN(): boolean
Returns boolean
Whether this value is NaN.
- Defined in src/CoreDecimal.ts:184

isNeg

isNeg(): boolean
Returns boolean
Whether this value has a negative sign.
- Defined in src/CoreDecimal.ts:187

isOdd

isOdd(): boolean
Returns boolean
Whether this value is a finite odd integer.
- Defined in src/CoreDecimal.ts:196

isPos

isPos(): boolean
Returns boolean
Whether this value has a positive sign.
- Defined in src/CoreDecimal.ts:190

isZero

isZero(): boolean
Returns boolean
Whether this value is positive or negative zero.
- Defined in src/CoreDecimal.ts:193

lt

lt(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value is less than value.
- Defined in src/CoreDecimal.ts:172

lte

lte(value: DecimalValue): boolean
Parameters
- value: DecimalValue
Returns boolean
Whether this value is less than or equal to value.
- Defined in src/CoreDecimal.ts:175

precision

precision(includeTrailingIntegerZeros?: boolean): number
Count this value's significant digits.
Parameters
- OptionalincludeTrailingIntegerZeros: boolean
Returns number
- Defined in src/CoreDecimal.ts:142

sign

sign(): number
Returns number
-1, -0, 0, 1, or NaN according to this value's state.
- Defined in src/CoreDecimal.ts:148

toExponential

toExponential(dp?: number, rm?: RoundingMode): string
Format this value in exponential notation.
Parameters
- Optionaldp: number
- Optionalrm: RoundingMode
Returns string
- Defined in src/CoreDecimal.ts:242

toFixed

toFixed(dp?: number, rm?: RoundingMode): string
Format this value in fixed-point notation.
Parameters
- Optionaldp: number
- Optionalrm: RoundingMode
Returns string
- Defined in src/CoreDecimal.ts:228

toJSON

toJSON(): string
Return the exact string serialized by JSON.

Returns string
- Defined in src/CoreDecimal.ts:217

toNumber

toNumber(): number
Convert to the nearest JavaScript number.

Returns number
- Defined in src/CoreDecimal.ts:239

toPrecision

toPrecision(sd?: number, rm?: RoundingMode): string
Format this value to a specified number of significant digits.
Parameters
- Optionalsd: number
- Optionalrm: RoundingMode
Returns string
- Defined in src/CoreDecimal.ts:253

toString

toString(): string
Format this value in canonical fixed or exponential notation.

Returns string
- Defined in src/CoreDecimal.ts:202

toValue

toValue(): string
Return the exact primitive string value, preserving negative zero.

Returns string
- Defined in src/CoreDecimal.ts:208

valueOf

valueOf(): string
Return the exact string used by default JavaScript coercion.

Returns string
- Defined in src/CoreDecimal.ts:214

`Static`clone

clone(config?: DecimalConfigInput): DecimalConstructor
Create an independently configurable constructor for this tier.
Parameters
- config: DecimalConfigInput = {}
Returns DecimalConstructor
- Defined in src/CoreDecimal.ts:101

`Static`max

max(value: DecimalValueIterable): Decimal
Select the greatest value from a non-empty iterable.
Parameters
- value: DecimalValueIterable
Returns Decimal
- Defined in src/CoreDecimal.ts:93
max(value: DecimalValue, ...values: DecimalValue[]): Decimal
Select the greatest of one or more scalar values.
Parameters
- value: DecimalValue
- ...values: DecimalValue[]
Returns Decimal
- Defined in src/CoreDecimal.ts:95

`Static`min

min(value: DecimalValueIterable): Decimal
Select the least value from a non-empty iterable.
Parameters
- value: DecimalValueIterable
Returns Decimal
- Defined in src/CoreDecimal.ts:85
min(value: DecimalValue, ...values: DecimalValue[]): Decimal
Select the least of one or more scalar values.
Parameters
- value: DecimalValue
- ...values: DecimalValue[]
Returns Decimal
- Defined in src/CoreDecimal.ts:87