Archives/MikeMcl_decimal.js
1
0
Fork 0
mirror of https://github.com/MikeMcl/decimal.js.git synced 2024-10-27 20:34:12 +00:00
Code Issues Projects Releases Wiki Activity

Use TypeScript delarations outside modules

Browse Source
This commit is contained in:
Michael Mclaughlin 2017-12-03 17:42:48 +00:00
parent a0b78b6275
commit d477d566ea
1 changed files with 199 additions and 171 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

370
decimal.d.ts vendored
View File

@ -5,59 +5,87 @@
// //
// Documentation: http://mikemcl.github.io/decimal.js/ // Documentation: http://mikemcl.github.io/decimal.js/
// //
// Exports: // Exports (available globally or when using import):
// //
// class Decimal (default) // class Decimal (default export)
// type Decimal.Constructor // type Decimal.Constructor
// type Decimal.Value // type Decimal.Instance
// type Decimal.Rounding
// type Decimal.Modulo // type Decimal.Modulo
// type Decimal.Rounding
// type Decimal.Value
// interface Decimal.Config // interface Decimal.Config
// interface Decimal.Format // interface Decimal.Format
// //
// Example: // Example (alternative syntax commented-out):
// //
// import Decimal from "decimal.js" // import {Decimal} from "decimal.js"
// //import Decimal from "decimal.js"
// //
// let r: Decimal.Rounding = Decimal.ROUND_UP; // let r: Decimal.Rounding = Decimal.ROUND_UP;
// let c: Decimal.Configuration = {precision: 4, rounding: r}; // let c: Decimal.Configuration = {precision: 4, rounding: r};
// Decimal.set(c); // Decimal.set(c);
// let v: Decimal.Value = '12345.6789'; // let v: Decimal.Value = '12345.6789';
// let d: Decimal = new Decimal(v); // let d: Decimal = new Decimal(v);
// //let d: Decimal.Instance = new Decimal(v);
//
// The use of compiler option `--strictNullChecks` is recommended.
export default Decimal; export default Decimal;
export namespace Decimal { export namespace Decimal {
export type Constructor = typeof Decimal; export type Config = DecimalConfig;
export type Value = string | number | Decimal; export type Constructor = DecimalConstructor;
export type Rounding = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8; export type Format = DecimalFormat;
export type Modulo = Rounding | 9; export type Instance = DecimalInstance;
export type Modulo = DecimalModulo;
export type Rounding = DecimalRounding;
export type Value = DecimalValue;
}
// http://mikemcl.github.io/decimal.js/#constructor-properties declare global {
export interface Configuration { const Decimal: DecimalConstructor;
precision?: number; type Decimal = DecimalInstance;
rounding?: Rounding;
toExpNeg?: number;
toExpPos?: number;
minE?: number;
maxE?: number;
crypto?: boolean;
modulo?: Modulo;
// Requires 'toFormat' <https://github.com/MikeMcl/toFormat>. namespace Decimal {
format?: Format; type Config = DecimalConfig;
type Constructor = DecimalConstructor;
type Format = DecimalFormat;
type Instance = DecimalInstance;
type Modulo = DecimalModulo;
type Rounding = DecimalRounding;
type Value = DecimalValue;
} }
}
// Requires 'toFormat'. type DecimalInstance = Decimal;
export interface Format { type DecimalConstructor = typeof Decimal;
decimalSeparator?: string; type DecimalValue = string | number | Decimal;
groupSeparator?: string; type DecimalRounding = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
groupSize?: number; type DecimalModulo = DecimalRounding | 9;
secondaryGroupSize?: number;
fractionGroupSeparator?: string; // http://mikemcl.github.io/decimal.js/#constructor-properties
fractionGroupSize?: number; interface DecimalConfig {
} precision?: number;
rounding?: DecimalRounding;
toExpNeg?: number;
toExpPos?: number;
minE?: number;
maxE?: number;
crypto?: boolean;
modulo?: DecimalModulo;
// Requires `toFormat` <https://github.com/MikeMcl/toFormat>.
format?: DecimalFormat;
}
// Requires `toFormat`.
interface DecimalFormat {
decimalSeparator?: string;s
groupSeparator?: string;
groupSize?: number;
secondaryGroupSize?: number;
fractionGroupSeparator?: string;
fractionGroupSize?: number;
} }
export declare class Decimal { export declare class Decimal {
@ -65,68 +93,68 @@ export declare class Decimal {
readonly e: number; readonly e: number;
readonly s: number; readonly s: number;
constructor(n: Decimal.Value); constructor(n: DecimalValue);
absoluteValue(): Decimal; absoluteValue(): Decimal
abs(): Decimal; abs(): Decimal
ceil(): Decimal; ceil(): Decimal
comparedTo(n: Decimal.Value): number; comparedTo(n: DecimalValue): number;
cmp(n: Decimal.Value): number; cmp(n: DecimalValue): number;
cosine(): Decimal; cosine(): Decimal
cos(): Decimal; cos(): Decimal
cubeRoot(): Decimal; cubeRoot(): Decimal
cbrt(): Decimal; cbrt(): Decimal
decimalPlaces(): number; decimalPlaces(): number;
dp(): number; dp(): number;
dividedBy(n: Decimal.Value): Decimal; dividedBy(n: DecimalValue): Decimal
div(n: Decimal.Value): Decimal; div(n: DecimalValue): Decimal
dividedToIntegerBy(n: Decimal.Value): Decimal; dividedToIntegerBy(n: DecimalValue): Decimal
divToInt(n: Decimal.Value): Decimal; divToInt(n: DecimalValue): Decimal
equals(n: Decimal.Value): boolean; equals(n: DecimalValue): boolean;
eq(n: Decimal.Value): boolean; eq(n: DecimalValue): boolean;
floor(): Decimal; floor(): Decimal
greaterThan(n: Decimal.Value): boolean; greaterThan(n: DecimalValue): boolean;
gt(n: Decimal.Value): boolean; gt(n: DecimalValue): boolean;
greaterThanOrEqualTo(n: Decimal.Value): boolean; greaterThanOrEqualTo(n: DecimalValue): boolean;
gte(n: Decimal.Value): boolean; gte(n: DecimalValue): boolean;
hyperbolicCosine(): Decimal; hyperbolicCosine(): Decimal
cosh(): Decimal; cosh(): Decimal
hyperbolicSine(): Decimal; hyperbolicSine(): Decimal
sinh(): Decimal; sinh(): Decimal
hyperbolicTangent(): Decimal; hyperbolicTangent(): Decimal
tanh(): Decimal; tanh(): Decimal
inverseCosine(): Decimal; inverseCosine(): Decimal
acos(): Decimal; acos(): Decimal
inverseHyperbolicCosine(): Decimal; inverseHyperbolicCosine(): Decimal
acosh(): Decimal; acosh(): Decimal
inverseHyperbolicSine(): Decimal; inverseHyperbolicSine(): Decimal
asinh(): Decimal; asinh(): Decimal
inverseHyperbolicTangent(): Decimal; inverseHyperbolicTangent(): Decimal
atanh(): Decimal; atanh(): Decimal
inverseSine(): Decimal; inverseSine(): Decimal
asin(): Decimal; asin(): Decimal
inverseTangent(): Decimal; inverseTangent(): Decimal
atan(): Decimal; atan(): Decimal
isFinite(): boolean; isFinite(): boolean;
@ -143,159 +171,159 @@ export declare class Decimal {
isZero(): boolean; isZero(): boolean;
lessThan(n: Decimal.Value): boolean; lessThan(n: DecimalValue): boolean;
lt(n: Decimal.Value): boolean; lt(n: DecimalValue): boolean;
lessThanOrEqualTo(n: Decimal.Value): boolean; lessThanOrEqualTo(n: DecimalValue): boolean;
lte(n: Decimal.Value): boolean; lte(n: DecimalValue): boolean;
logarithm(n?: Decimal.Value): Decimal; logarithm(n?: DecimalValue): Decimal
log(n?: Decimal.Value): Decimal; log(n?: DecimalValue): Decimal
minus(n: Decimal.Value): Decimal; minus(n: DecimalValue): Decimal
sub(n: Decimal.Value): Decimal; sub(n: DecimalValue): Decimal
modulo(n: Decimal.Value): Decimal; modulo(n: DecimalValue): Decimal
mod(n: Decimal.Value): Decimal; mod(n: DecimalValue): Decimal
naturalExponential(): Decimal; naturalExponential(): Decimal
exp(): Decimal; exp(): Decimal
naturalLogarithm(): Decimal; naturalLogarithm(): Decimal
ln(): Decimal; ln(): Decimal
negated(): Decimal; negated(): Decimal
neg(): Decimal; neg(): Decimal
plus(n: Decimal.Value): Decimal; plus(n: DecimalValue): Decimal
add(n: Decimal.Value): Decimal; add(n: DecimalValue): Decimal
precision(includeZeros?: boolean): number; precision(includeZeros?: boolean): number;
sd(includeZeros?: boolean): number; sd(includeZeros?: boolean): number;
round(): Decimal; round(): Decimal
sine() : Decimal; sine() : Decimal
sin() : Decimal; sin() : Decimal
squareRoot(): Decimal; squareRoot(): Decimal
sqrt(): Decimal; sqrt(): Decimal
tangent() : Decimal; tangent() : Decimal
tan() : Decimal; tan() : Decimal
times(n: Decimal.Value): Decimal; times(n: DecimalValue): Decimal
mul(n: Decimal.Value) : Decimal; mul(n: DecimalValue) : Decimal
toBinary(significantDigits?: number): Decimal; toBinary(significantDigits?: number): Decimal
toBinary(significantDigits: number, rounding: Decimal.Rounding): Decimal; toBinary(significantDigits: number, rounding: DecimalRounding): Decimal
toDecimalPlaces(decimalPlaces?: number): Decimal; toDecimalPlaces(decimalPlaces?: number): Decimal
toDecimalPlaces(decimalPlaces: number, rounding: Decimal.Rounding): Decimal; toDecimalPlaces(decimalPlaces: number, rounding: DecimalRounding): Decimal
toDP(decimalPlaces?: number): Decimal; toDP(decimalPlaces?: number): Decimal
toDP(decimalPlaces: number, rounding: Decimal.Rounding): Decimal; toDP(decimalPlaces: number, rounding: DecimalRounding): Decimal
toExponential(decimalPlaces?: number): string; toExponential(decimalPlaces?: number): string;
toExponential(decimalPlaces: number, rounding: Decimal.Rounding): string; toExponential(decimalPlaces: number, rounding: DecimalRounding): string;
toFixed(decimalPlaces?: number): string; toFixed(decimalPlaces?: number): string;
toFixed(decimalPlaces: number, rounding: Decimal.Rounding): string; toFixed(decimalPlaces: number, rounding: DecimalRounding): string;
// Requires 'toFormat'. // Requires `toFormat`.
toFormat?(decimalPlaces: number, rounding: Decimal.Rounding): string; toFormat?(decimalPlaces: number, rounding: DecimalRounding): string;
toFraction(max_denominator?: Decimal.Value): string[]; toFraction(max_denominator?: DecimalValue): string[];
toHexadecimal(significantDigits?: number): Decimal; toHexadecimal(significantDigits?: number): Decimal
toHexadecimal(significantDigits: number, rounding: Decimal.Rounding): Decimal; toHexadecimal(significantDigits: number, rounding: DecimalRounding): Decimal
toHex(significantDigits?: number): Decimal; toHex(significantDigits?: number): Decimal
toHex(significantDigits: number, rounding: Decimal.Rounding): Decimal; toHex(significantDigits: number, rounding?: DecimalRounding): Decimal
toJSON(): string; toJSON(): string;
toNearest(n: Decimal.Value, rounding?: Decimal.Rounding): Decimal; toNearest(n: DecimalValue, rounding?: DecimalRounding): Decimal
toNumber(): number; toNumber(): number;
toOctal(significantDigits?: number): Decimal; toOctal(significantDigits?: number): Decimal
toOctal(significantDigits: number, rounding: Decimal.Rounding): Decimal; toOctal(significantDigits: number, rounding: DecimalRounding): Decimal
toPower(n: Decimal.Value): Decimal; toPower(n: DecimalValue): Decimal
pow(n: Decimal.Value): Decimal; pow(n: DecimalValue): Decimal
toPrecision(significantDigits?: number): string; toPrecision(significantDigits?: number): string;
toPrecision(significantDigits: number, rounding: Decimal.Rounding): string; toPrecision(significantDigits: number, rounding: DecimalRounding): string;
toSignificantDigits(significantDigits?: number): Decimal; toSignificantDigits(significantDigits?: number): Decimal
toSignificantDigits(significantDigits: number, rounding: Decimal.Rounding): Decimal; toSignificantDigits(significantDigits: number, rounding: DecimalRounding): Decimal
toSD(significantDigits?: number): Decimal; toSD(significantDigits?: number): Decimal
toSD(significantDigits: number, rounding: Decimal.Rounding): Decimal; toSD(significantDigits: number, rounding: DecimalRounding): Decimal
toString(): string; toString(): string;
truncated(): Decimal; truncated(): Decimal
trunc(): Decimal; trunc(): Decimal
valueOf(): string; valueOf(): string;
static abs(n: Decimal.Value): Decimal; static abs(n: DecimalValue): Decimal
static acos(n: Decimal.Value): Decimal; static acos(n: DecimalValue): Decimal
static acosh(n: Decimal.Value): Decimal; static acosh(n: DecimalValue): Decimal
static add(x: Decimal.Value, y: Decimal.Value): Decimal; static add(x: DecimalValue, y: DecimalValue): Decimal
static asin(n: Decimal.Value): Decimal; static asin(n: DecimalValue): Decimal
static asinh(n: Decimal.Value): Decimal; static asinh(n: DecimalValue): Decimal
static atan(n: Decimal.Value): Decimal; static atan(n: DecimalValue): Decimal
static atanh(n: Decimal.Value): Decimal; static atanh(n: DecimalValue): Decimal
static atan2(y: Decimal.Value, x: Decimal.Value): Decimal; static atan2(y: DecimalValue, x: DecimalValue): Decimal
static cbrt(n: Decimal.Value): Decimal; static cbrt(n: DecimalValue): Decimal
static ceil(n: Decimal.Value): Decimal; static ceil(n: DecimalValue): Decimal
static clone(object?: Decimal.Configuration): Decimal.Constructor; static clone(object?: DecimalConfig): DecimalConstructor;
static config(object: Decimal.Configuration): Decimal.Constructor; static config(object: DecimalConfig): DecimalConstructor;
static cos(n: Decimal.Value): Decimal; static cos(n: DecimalValue): Decimal
static cosh(n: Decimal.Value): Decimal; static cosh(n: DecimalValue): Decimal
static div(x: Decimal.Value, y: Decimal.Value): Decimal; static div(x: DecimalValue, y: DecimalValue): Decimal
static exp(n: Decimal.Value): Decimal; static exp(n: DecimalValue): Decimal
static floor(n: Decimal.Value): Decimal; static floor(n: DecimalValue): Decimal
static hypot(...n: Decimal.Value[]): Decimal; static hypot(...n: DecimalValue[]): Decimal
static ln(n: Decimal.Value): Decimal; static ln(n: DecimalValue): Decimal
static log(n: Decimal.Value, base?: number): Decimal; static log(n: DecimalValue, base?: DecimalValue): Decimal
static log2(n: Decimal.Value): Decimal; static log2(n: DecimalValue): Decimal
static log10(n: Decimal.Value): Decimal; static log10(n: DecimalValue): Decimal
static max(...n: Decimal.Value[]): Decimal; static max(...n: DecimalValue[]): Decimal
static min(...n: Decimal.Value[]): Decimal; static min(...n: DecimalValue[]): Decimal
static mod(x: Decimal.Value, y: Decimal.Value): Decimal; static mod(x: DecimalValue, y: DecimalValue): Decimal
static mul(x: Decimal.Value, y: Decimal.Value): Decimal; static mul(x: DecimalValue, y: DecimalValue): Decimal
// Browser only // Browser only
static noConflict(): Decimal.Constructor; static noConflict(): DecimalConstructor;
static pow(base: Decimal.Value, exponent: Decimal.Value): Decimal; static pow(base: DecimalValue, exponent: DecimalValue): Decimal
static random(significantDigits?: number): Decimal; static random(significantDigits?: number): Decimal
static round(n: Decimal.Value): Decimal; static round(n: DecimalValue): Decimal
static set(object: Decimal.Configuration): Decimal.Constructor; static set(object: DecimalConfig): DecimalConstructor;
static sign(n: Decimal.Value): Decimal; static sign(n: DecimalValue): Decimal
static sin(n: Decimal.Value): Decimal; static sin(n: DecimalValue): Decimal
static sinh(n: Decimal.Value): Decimal; static sinh(n: DecimalValue): Decimal
static sqrt(n: Decimal.Value): Decimal; static sqrt(n: DecimalValue): Decimal
static sub(x: Decimal.Value, y: Decimal.Value): Decimal; static sub(x: DecimalValue, y: DecimalValue): Decimal
static tan(n: Decimal.Value): Decimal; static tan(n: DecimalValue): Decimal
static tanh(n: Decimal.Value): Decimal; static tanh(n: DecimalValue): Decimal
static trunc(n: Decimal.Value): Decimal; static trunc(n: DecimalValue): Decimal
static readonly default: Decimal.Constructor; static readonly default: DecimalConstructor;
static readonly Decimal: Decimal.Constructor; static readonly Decimal: DecimalConstructor;
static readonly precision: number; static readonly precision: number;
static readonly rounding: Decimal.Rounding; static readonly rounding: DecimalRounding;
static readonly toExpNeg: number; static readonly toExpNeg: number;
static readonly toExpPos: number; static readonly toExpPos: number;
static readonly minE: number; static readonly minE: number;
static readonly maxE: number; static readonly maxE: number;
static readonly crypto: boolean; static readonly crypto: boolean;
static readonly modulo: Decimal.Modulo; static readonly modulo: DecimalModulo;
// Requires 'toFormat'. // Requires `toFormat`.
static readonly format?: Decimal.Format; static readonly format?: DecimalFormat;
static readonly ROUND_UP: 0; static readonly ROUND_UP: 0;
static readonly ROUND_DOWN: 1; static readonly ROUND_DOWN: 1;