Interface DecimalConstructor

The independently configurable constructor returned by CoreDecimal.clone.

interface DecimalConstructor {
    new DecimalConstructor(value: DecimalValue): Decimal;
    limits: DecimalLimits;
    prototype: Decimal;
    get config(): Readonly<DecimalConfig>;
    set config(params: DecimalConfigInput): void;
    clone(config?: Partial<DecimalConfig>): DecimalConstructor;
    max(value: DecimalValueIterable): Decimal;
    max(value: DecimalValue, ...values: DecimalValue[]): Decimal;
    min(value: DecimalValueIterable): Decimal;
    min(value: DecimalValue, ...values: DecimalValue[]): Decimal;
}

Hierarchy (View Summary)

DecimalConstructor
- DecimalConstructor

Index

Constructors

Properties

limits prototype

Accessors

Methods

Constructors

constructor

new DecimalConstructor(value: DecimalValue): Decimal
Construct a Decimal value.
Parameters
- value: DecimalValue
Returns Decimal
- Defined in src/CoreDecimal.ts:38

Properties

`Readonly`limits

limits: DecimalLimits

Hard validation limits shared by all tiers.

`Readonly`prototype

prototype: Decimal

Prototype shared by instances from this constructor.

Accessors

config

get config(): Readonly<DecimalConfig>
Read the constructor's frozen configuration snapshot.

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

Methods

clone

clone(config?: Partial<DecimalConfig>): DecimalConstructor
Create an independently configurable constructor.
Parameters
- Optionalconfig: Partial<DecimalConfig>
Returns DecimalConstructor
- Defined in src/CoreDecimal.ts:48

max

max(value: DecimalValueIterable): Decimal
Select the greatest value from a non-empty iterable.
Parameters
- value: DecimalValueIterable
Returns Decimal
- Defined in src/CoreDecimal.ts:54
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:56

min

min(value: DecimalValueIterable): Decimal
Select the least value from a non-empty iterable.
Parameters
- value: DecimalValueIterable
Returns Decimal
- Defined in src/CoreDecimal.ts:50
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:52