@sheetxl/formulas-extended 0.8.0-beta.1 → 0.8.0-beta.2

package/node/esm/Dy6UD7hQRBsT0WNp.mjs

@@ -1,304 +0,0 @@
-/**
-* @license @sheetxl/formulas-extended - Formulas Enterprise - TypeScript formulas compatible with Excel built-ins. - v0.8.0-beta.1
-*
-* (C) 2026-present SheetXL Inc. & Michael T. Ford
-* License: The license can be found at https://www.sheetxl.com/license.
-*/
-var e = {
-	COUPDAYS: {
-		s: "Returns the number of days from the beginning of the coupon period to the settlement date.",
-		p: {
-			settlement: { d: "is the security's settlement date, expressed as a serial date number." },
-			maturity: { d: "is the security's maturity date, expressed as a serial date number." },
-			frequency: { d: "is the number of coupon payments per year." },
-			basis: { d: "is the type of day count basis to use." }
-		}
-	},
-	CUMIPMT: {
-		s: "Returns the cumulative interest paid between two periods.",
-		p: {
-			rate: { d: "is the interest rate." },
-			nper: { d: "is the total number of payment periods." },
-			pv: { d: "is the present value of the investment." },
-			startPeriod: { d: "is the first period in the calculation." },
-			endPeriod: { d: "is the last period in the calculation." },
-			type: { d: "is the timing of the payment." }
-		}
-	},
-	CUMPRINC: {
-		s: "Returns the cumulative principal paid on a loan between two periods.",
-		p: {
-			rate: { d: "is the interest rate." },
-			nper: { d: "is the total number of payment periods." },
-			pv: { d: "is the present value of the investment." },
-			startPeriod: { d: "is the first period in the calculation." },
-			endPeriod: { d: "is the last period in the calculation." },
-			type: { d: "is the timing of the payment." }
-		}
-	},
-	DB: {
-		s: "Returns the depreciation of an asset for a specified period using the fixed-declining balance method.",
-		p: {
-			cost: { d: "is the initial cost of the asset." },
-			salvage: { d: "is the salvage value at the end of the life of the asset." },
-			life: { d: "is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset)." },
-			period: { d: "is the period for which you want to calculate the depreciation. Period must use the same units as Life." },
-			month: { d: "is the number of months in the first year." }
-		}
-	},
-	DDB: {
-		s: "Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.",
-		p: {
-			cost: { d: "is the initial cost of the asset." },
-			salvage: { d: "is the salvage value at the end of the life of the asset." },
-			life: { d: "is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset)." },
-			period: { d: "is the period for which you want to calculate the depreciation. Period must use the same units as Life." },
-			factor: { d: "is the rate at which the balance declines." }
-		}
-	},
-	DISC: {
-		s: "Returns the discount rate for a security.",
-		p: {
-			settlement: { d: "is the security's settlement date, expressed as a serial date number." },
-			maturity: { d: "is the security's maturity date, expressed as a serial date number." },
-			pr: { d: "is the security's price per $100 face value." },
-			redemption: { d: "is the security's redemption value per $100 face value." },
-			basis: { d: "is the type of day count basis to use." }
-		}
-	},
-	DOLLARDE: {
-		s: "Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.",
-		p: {
-			fractionalDollar: { d: "is a number expressed as a fraction." },
-			fraction: { d: "is the integer to use in the denominator of the fraction." }
-		}
-	},
-	DOLLARFR: {
-		s: "Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.",
-		p: {
-			decimalDollar: { d: "is a decimal number." },
-			fraction: { d: "is the integer to use in the denominator of the fraction." }
-		}
-	},
-	EFFECT: {
-		s: "Returns the effective annual interest rate.",
-		p: {
-			nominalRate: { d: "is the nominal interest rate." },
-			npery: { d: "is the number of compounding periods per year." }
-		}
-	},
-	FV: {
-		s: "Returns the future value of an investment based on periodic, constant payments and a constant interest rate.",
-		p: {
-			rate: { d: "is the interest rate." },
-			nper: { d: "is the total number of payment periods." },
-			pmt: { d: "is the payment made each period; it cannot change over the life of the investment." },
-			pv: { d: "is the present value of the investment." },
-			type: { d: "Indicates when pmts are due." }
-		}
-	},
-	FVSCHEDULE: {
-		s: "Returns the future value of an initial principal after applying a series of compound interest rates.",
-		p: {
-			principal: { d: "is the present value." },
-			schedule: { d: "is an array of interest rates to apply." }
-		}
-	},
-	IPMT: {
-		s: "Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.",
-		p: {
-			rate: { d: "is the interest rate." },
-			per: { d: "is the period for which you want to find the interest and must be in the range 1 to Nper." },
-			nper: { d: "is the total number of payment periods." },
-			pv: { d: "is the present value of the investment." },
-			fv: { d: "is the future value, or a cash balance you want to attain after the last payment is made." },
-			type: { d: "is a logical value representing the timing of payment: at the end of the period = 0, at the beginning of the period = 1." }
-		}
-	},
-	IRR: {
-		s: "Returns the internal rate of return for a series of cash flows.",
-		p: {
-			values: { d: "is an array or a reference to cells that contain numbers for which you want to calculate the internal rate of return." },
-			guess: { d: "is a number that you guess is close to the result of IRR." }
-		}
-	},
-	ISPMT: {
-		s: "Returns the interest paid during a specific period of an investment.",
-		p: {
-			rate: { d: "is the interest rate." },
-			per: { d: "period for which you want to find the interest." },
-			nper: { d: "number of payment periods in an investment." },
-			pv: { d: "lump sum amount that a series of future payments is right now." }
-		}
-	},
-	MIRR: {
-		s: "Returns the modified internal rate of return for a series of periodic cash flows.",
-		p: {
-			values: { d: "An array of cash flows; must contain at least one positive and one negative value." },
-			financeRate: { d: "The interest rate paid on negative cash flows (cost of capital)." },
-			reinvestRate: { d: "The interest rate received on positive cash flows (reinvestment rate)." }
-		}
-	},
-	NOMINAL: {
-		s: "Returns the annual nominal interest rate.",
-		p: {
-			effectiveRate: { d: "is the effective interest rate." },
-			npery: { d: "is the number of compounding periods per year." }
-		}
-	},
-	NPER: {
-		s: "Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.",
-		p: {
-			rate: { d: "is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR." },
-			pmt: { d: "is the payment made each period; it cannot change over the life of the investment." },
-			pv: { d: "is the present value, or the lump-sum amount that a series of future payments is worth now." },
-			fv: { d: "is the future value, or a cash balance you want to attain after the last payment is made." },
-			type: { d: "is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0." }
-		}
-	},
-	NPV: {
-		s: "Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values).",
-		p: {
-			rate: { d: "is the rate of discount over the length of one period." },
-			value: { d: "are 1 to 254 payments and income, equally spaced in time and occurring at the end of each period." }
-		}
-	},
-	PDURATION: {
-		s: "Returns the number of periods required by an investment to reach a specified value.",
-		p: {
-			rate: { d: "is the interest rate." },
-			pv: { d: "is the present value of the investment." },
-			fv: { d: "is the desired future value of the investment." }
-		}
-	},
-	PMT: {
-		s: "Calculates the payment for a loan based on constant payments and a constant interest rate.",
-		p: {
-			rate: { d: "is the interest rate." },
-			nper: { d: "is the total number of payment periods." },
-			pv: { d: "is the present value of the investment." },
-			fv: { d: "is the future value, or a cash balance you want to attain after the last payment is made." },
-			type: { d: "is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0." }
-		}
-	},
-	PPMT: {
-		s: "Returns the payment on the principal for a given investment based on periodic, constant payments and a constant payments and a constant interest rate.",
-		p: {
-			rate: { d: "is the interest rate per period." },
-			per: { d: "is the period for which you want to find the principal payment and must be in the range 1 to Nper." },
-			nper: { d: "is the total number of payment periods in the investment." },
-			pv: { d: "is the present value of the investment." },
-			fv: { d: "is the future value, or a cash balance you want to attain after the last payment is made." },
-			type: { d: "is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0." }
-		}
-	},
-	PRICEDISC: {
-		s: "Returns the price per $100 face value of a discounted security.",
-		p: {
-			settlement: { d: "is the security's settlement date, expressed as a serial date number." },
-			maturity: { d: "is the security's maturity date, expressed as a serial date number." },
-			discount: { d: "is the security's discount rate." },
-			redemption: { d: "is the amount to be received at maturity." },
-			basis: { d: "is the type of day count basis to use." }
-		}
-	},
-	PV: {
-		s: "Returns the present value of an investment: the total amount that a series of future payments is worth now.",
-		p: {
-			rate: { d: "is the interest rate." },
-			nper: { d: "is the total number of payment periods in an investment." },
-			pmt: { d: "is the payment made each period and cannot change over the life of the investment." },
-			fv: { d: "is the future value, or a cash balance you want to attain after the last payment is made." },
-			type: { d: "is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0." }
-		}
-	},
-	RATE: {
-		s: "Returns the interest rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR.",
-		p: {
-			nper: { d: "is the total number of payment periods." },
-			pmt: { d: "is the payment made each period and cannot change over the life of the loan or investment." },
-			pv: { d: "is the present value: the total amount that a series of future payments is worth now." },
-			fv: { d: "is the future value, or a cash balance you want to attain after the last payment is made." },
-			type: { d: "is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0." },
-			guess: { d: "is your guess for what the rate will be." }
-		}
-	},
-	RRI: {
-		s: "Returns an equivalent interest rate for the growth of an investment.",
-		p: {
-			nper: { d: "is the total number of payment periods." },
-			pv: { d: "is the present value of the investment." },
-			fv: { d: "is the future value of the investment." }
-		}
-	},
-	SLN: {
-		s: "Returns the straight-line depreciation of an asset for one period.",
-		p: {
-			cost: { d: "is the initial cost of the asset." },
-			salvage: { d: "is the salvage value at the end of the life of the asset." },
-			life: { d: "is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset)." }
-		}
-	},
-	STOCKHISTORY: {
-		s: "Returns an array of historical quote data for a symbol and date range you specify..",
-		p: {
-			stock: { d: "Symbol of financial instrument to be considered or a Stock data type." },
-			startDate: { d: "First date to return data from." },
-			endDate: { d: "Last date to return data from." },
-			interval: { d: "A number indicating the granularity of the data; 0 - Daily, 1 - Weekly, 2 - Monthly." },
-			headers: { d: "A logical value to add column header data; 0 - No column header, 1 - Show column header, 2 - Show instrument identifier and column header." },
-			properties: { d: "A number indicating which column of data to return; 0 through 5." }
-		},
-		h: "Unimplemented RichData"
-	},
-	SYD: {
-		s: "Returns the sum-of-years' digits depreciation of an asset for a specified period.",
-		p: {
-			cost: { d: "is the initial cost of the asset." },
-			salvage: { d: "is the salvage value at the end of the life of the asset." },
-			life: { d: "is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset)." },
-			per: { d: "is the period and must use the same units as Life." }
-		}
-	},
-	TBILLEQ: {
-		s: "Returns the bond-equivalent yield for a treasury bill.",
-		p: {
-			settlement: { d: "is the Treasury bill's settlement date, expressed as a serial date number." },
-			maturity: { d: "is the Treasury bill's maturity date, expressed as a serial date number." },
-			discount: { d: "is the Treasury bill's discount rate." }
-		}
-	},
-	TBILLPRICE: {
-		s: "Returns the price per $100 face value for a treasury bill.",
-		p: {
-			settlement: { d: "is the Treasury bill's settlement date, expressed as a serial date number." },
-			maturity: { d: "is the Treasury bill's maturity date, expressed as a serial date number." },
-			discount: { d: "is the Treasury bill's discount rate." }
-		}
-	},
-	TBILLYIELD: {
-		s: "Returns the yield for a treasury bill.",
-		p: {
-			settlement: { d: "is the Treasury bill's settlement date, expressed as a serial date number." },
-			maturity: { d: "is the Treasury bill's maturity date, expressed as a serial date number." },
-			pr: { d: "is the Treasury Bill's price per $100 face value." }
-		}
-	},
-	XIRR: {
-		s: "Returns the internal rate of return for a schedule of cash flows.",
-		p: {
-			values: { d: "is a series of cash flows that correspond to a schedule of payments in dates." },
-			dates: { d: "is a schedule of payment dates that corresponds to the cash flow payments." },
-			guess: { d: "is a number that you guess is close to the result of XIRR." }
-		}
-	},
-	XNPV: {
-		s: "Returns the net present value for a schedule of cash flows.",
-		p: {
-			rate: { d: "is the discount rate to apply to the cash flows." },
-			values: { d: "is a series of cash flows that correspond to a schedule of payments in dates." },
-			dates: { d: "is a schedule of payment dates that corresponds to the cash flow payments." }
-		}
-	}
-};
-export { e as default };

package/types/src/financial/Financial.d.ts

@@ -1,288 +0,0 @@
-import { Scalar, Omittable, AcceptError, IRange, Flatten } from '@sheetxl/primitives';
-/**
- * @summary Returns the number of days from the beginning of the coupon period to the settlement date.
- * @param settlement is the security's settlement date, expressed as a serial date number.
- * @param maturity is the security's maturity date, expressed as a serial date number.
- * @param frequency is the number of coupon payments per year.
- * @param basis is the type of day count basis to use.
- */
-export declare function COUPDAYS(settlement: number, // date
-maturity: number, // date
-frequency: number, basis?: number): number;
-/**
- * @summary Returns the cumulative interest paid between two periods.
- * @param rate is the interest rate.
- * @param nper is the total number of payment periods.
- * @param pv is the present value of the investment.
- * @param startPeriod is the first period in the calculation.
- * @param endPeriod is the last period in the calculation.
- * @param type is the timing of the payment.
- * @compat atp
- */
-export declare function CUMIPMT(rate: Omittable<Scalar>, nper: Omittable<Scalar>, pv: Omittable<Scalar>, startPeriod: Omittable<Scalar>, endPeriod: Omittable<Scalar>, type: Omittable<Scalar>): number;
-/**
- * @summary Returns the cumulative principal paid on a loan between two periods.
- * @param rate is the interest rate.
- * @param nper is the total number of payment periods.
- * @param pv is the present value of the investment.
- * @param startPeriod is the first period in the calculation.
- * @param endPeriod is the last period in the calculation.
- * @param type is the timing of the payment.
- * @compat atp
- */
-export declare function CUMPRINC(rate: Omittable<Scalar>, nper: Omittable<Scalar>, pv: Omittable<Scalar>, startPeriod: Omittable<Scalar>, endPeriod: Omittable<Scalar>, type: Omittable<Scalar>): number;
-/**
- * @summary Returns the depreciation of an asset for a specified period using the fixed-declining balance method.
- * @param cost is the initial cost of the asset.
- * @param salvage is the salvage value at the end of the life of the asset.
- * @param life is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
- * @param period is the period for which you want to calculate the depreciation. Period must use the same units as Life.
- * @param month is the number of months in the first year.
- */
-export declare function DB(cost: number, salvage: number, life: number, period: number, month?: number): number;
-/**
- * @summary Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.
- * @param cost is the initial cost of the asset.
- * @param salvage is the salvage value at the end of the life of the asset.
- * @param life is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
- * @param period is the period for which you want to calculate the depreciation. Period must use the same units as Life.
- * @param factor is the rate at which the balance declines.
- *
- * @remarks
- * Double declining balance (DDB) depreciation method.
- */
-export declare function DDB(cost: number, salvage: number, life: number, period: number, factor?: number): number;
-/**
- * @summary Returns the discount rate for a security.
- * @param settlement is the security's settlement date, expressed as a serial date number.
- * @param maturity is the security's maturity date, expressed as a serial date number.
- * @param pr is the security's price per $100 face value.
- * @param redemption is the security's redemption value per $100 face value.
- * @param basis is the type of day count basis to use.
- */
-export declare function DISC(settlement: number, // date
-maturity: number, // date
-pr: number, redemption: number, basis?: number): number;
-/**
- * @summary Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.
- * @param fractionalDollar is a number expressed as a fraction.
- * @param fraction is the integer to use in the denominator of the fraction.
- */
-export declare function DOLLARDE(fractionalDollar: number, fraction: number): number;
-/**
- * @summary Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.
- * @param decimalDollar is a decimal number.
- * @param fraction is the integer to use in the denominator of the fraction.
- */
-export declare function DOLLARFR(decimalDollar: number, fraction: number): number;
-/**
- * @summary Returns the effective annual interest rate.
- * @param nominalRate is the nominal interest rate.
- * @param npery is the number of compounding periods per year.
- * @compat atp
- */
-export declare function EFFECT(nominalRate: Omittable<Scalar>, npery: Omittable<Scalar>): number;
-/**
- * @summary Returns the future value of an investment based on periodic, constant payments and a constant interest rate.
- * @param rate is the interest rate.
- * @param nper is the total number of payment periods.
- * @param pmt is the payment made each period; it cannot change over the life of the investment.
- * @param pv is the present value of the investment.
- * @param { '0' | '1' } type Indicates when pmts are due.
- */
-export declare function FV(rate: number, nper: number, pmt: number, pv?: number, type?: number): number;
-/**
- * @summary Returns the future value of an initial principal after applying a series of compound interest rates.
- * @param principal is the present value.
- * @param schedule is an array of interest rates to apply.
- * @compat atp
- */
-export declare function FVSCHEDULE(principal: Omittable<Scalar>, schedule: Omittable<AcceptError<IRange>>): number;
-/**
- * @summary Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.
- * @param rate is the interest rate.
- * @param per is the period for which you want to find the interest and must be in the range 1 to Nper.
- * @param nper is the total number of payment periods.
- * @param pv is the present value of the investment.
- * @param fv is the future value, or a cash balance you want to attain after the last payment is made.
- * @param type is a logical value representing the timing of payment: at the end of the period = 0, at the beginning of the period = 1.
- */
-export declare function IPMT(rate: number, per: number, nper: number, pv: number, fv?: number, type?: number): number;
-/**
- * @summary Returns the internal rate of return for a series of cash flows.
- * @param values is an array or a reference to cells that contain numbers for which you want to calculate the internal rate of return.
- * @param guess is a number that you guess is close to the result of IRR.
- */
-export declare function IRR(values: Flatten<number>, guess?: number): number;
-/**
- * @summary Returns the interest paid during a specific period of an investment.
- * @param rate is the interest rate.
- * @param per period for which you want to find the interest.
- * @param nper number of payment periods in an investment.
- * @param pv lump sum amount that a series of future payments is right now.
- */
-export declare function ISPMT(rate: number, per: number, nper: number, pv: number): number;
-/**
- * @summary Returns the modified internal rate of return for a series of periodic cash flows.
- * @param values An array of cash flows; must contain at least one positive and one negative value.
- * @param financeRate The interest rate paid on negative cash flows (cost of capital).
- * @param reinvestRate The interest rate received on positive cash flows (reinvestment rate).
- */
-export declare function MIRR(values: Flatten<number>, financeRate: number, reinvestRate: number): number;
-/**
- * @summary Returns the annual nominal interest rate.
- * @param effectiveRate is the effective interest rate.
- * @param npery is the number of compounding periods per year.
- * @compat atp
- */
-export declare function NOMINAL(effectiveRate: Omittable<Scalar>, npery: Omittable<Scalar>): number;
-/**
- * @summary Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.
- * @param rate is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
- * @param pmt is the payment made each period; it cannot change over the life of the investment.
- * @param pv is the present value, or the lump-sum amount that a series of future payments is worth now.
- * @param fv is the future value, or a cash balance you want to attain after the last payment is made.
- * @param type is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0.
- */
-export declare function NPER(rate: number, pmt: number, pv: number, fv?: number, type?: number): number;
-/**
- * @summary Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values).
- * @param rate is the rate of discount over the length of one period.
- * @param value are 1 to 254 payments and income, equally spaced in time and occurring at the end of each period.
- */
-export declare function NPV(rate: number, value: IRange<number>[]): number;
-/**
- * @summary Returns the number of periods required by an investment to reach a specified value.
- * @param rate is the interest rate.
- * @param pv is the present value of the investment.
- * @param fv is the desired future value of the investment.
- */
-export declare function PDURATION(rate: number, pv: number, fv: number): number;
-/**
- * @summary Calculates the payment for a loan based on constant payments and a constant interest rate.
- * @param rate is the interest rate.
- * @param nper is the total number of payment periods.
- * @param pv is the present value of the investment.
- * @param fv is the future value, or a cash balance you want to attain after the last payment is made.
- * @param type is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0.
- */
-export declare function PMT(rate: number, nper: number, pv: number, fv?: number, type?: number): number;
-/**
- * @summary Returns the payment on the principal for a given investment based on periodic, constant payments and a constant payments and a constant interest rate.
- * @param rate is the interest rate per period.
- * @param per is the period for which you want to find the principal payment and must be in the range 1 to Nper.
- * @param nper is the total number of payment periods in the investment.
- * @param pv is the present value of the investment.
- * @param fv is the future value, or a cash balance you want to attain after the last payment is made.
- * @param type is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0.
- */
-export declare function PPMT(rate: number, per: number, nper: number, pv: number, fv?: number, type?: number): number;
-/**
- * @summary Returns the price per $100 face value of a discounted security.
- * @param settlement is the security's settlement date, expressed as a serial date number.
- * @param maturity is the security's maturity date, expressed as a serial date number.
- * @param discount is the security's discount rate.
- * @param redemption is the amount to be received at maturity.
- * @param basis is the type of day count basis to use.
- */
-export declare function PRICEDISC(settlement: number, // date
-maturity: number, // date
-discount: number, redemption: number, basis?: number): number;
-/**
- * @summary Returns the present value of an investment: the total amount that a series of future payments is worth now.
- * @param rate is the interest rate.
- * @param nper is the total number of payment periods in an investment.
- * @param pmt is the payment made each period and cannot change over the life of the investment.
- * @param fv is the future value, or a cash balance you want to attain after the last payment is made.
- * @param type is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0.
- */
-export declare function PV(rate: number, nper: number, pmt: number, fv?: number, type?: number): number;
-/**
- * @summary Returns the interest rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR.
- * @param nper is the total number of payment periods.
- * @param pmt is the payment made each period and cannot change over the life of the loan or investment.
- * @param pv is the present value: the total amount that a series of future payments is worth now.
- * @param fv is the future value, or a cash balance you want to attain after the last payment is made.
- * @param type is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0.
- * @param guess is your guess for what the rate will be.
- */
-export declare function RATE(nper: number, pmt: number, pv: number, fv?: number, type?: number, guess?: number): number;
-/**
- * @summary Returns an equivalent interest rate for the growth of an investment.
- * @param nper is the total number of payment periods.
- * @param pv is the present value of the investment.
- * @param fv is the future value of the investment.
- */
-export declare function RRI(nper: number, pv: number, fv: number): number;
-/**
- * @summary Returns the straight-line depreciation of an asset for one period.
- * @param cost is the initial cost of the asset.
- * @param salvage is the salvage value at the end of the life of the asset.
- * @param life is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
- */
-export declare function SLN(cost: number, salvage: number, life: number): number;
-/**
- * @hidden Unimplemented RichData
- * @summary Returns an array of historical quote data for a symbol and date range you specify..
- * @param stock Symbol of financial instrument to be considered or a Stock data type.
- * @param startDate First date to return data from.
- * @param endDate Last date to return data from.
- * @param interval A number indicating the granularity of the data; 0 - Daily, 1 - Weekly, 2 - Monthly.
- * @param headers A logical value to add column header data; 0 - No column header, 1 - Show column header, 2 - Show instrument identifier and column header.
- * @param properties A number indicating which column of data to return; 0 through 5.
- */
-export declare function STOCKHISTORY(stock: string, startDate: number, // date
-endDate?: number, // date
-interval?: number, // 0=day, 1=week, 2=month
-headers?: number, // 0=none, 1=field names, 2=field names and row numbers
-properties?: Flatten<number>): Promise<IRange>;
-/**
- * @summary Returns the sum-of-years' digits depreciation of an asset for a specified period.
- * @param cost is the initial cost of the asset.
- * @param salvage is the salvage value at the end of the life of the asset.
- * @param life is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
- * @param per is the period and must use the same units as Life.
- */
-export declare function SYD(cost: number, salvage: number, life: number, per: number): number;
-/**
- * @summary Returns the bond-equivalent yield for a treasury bill.
- * @param settlement is the Treasury bill's settlement date, expressed as a serial date number.
- * @param maturity is the Treasury bill's maturity date, expressed as a serial date number.
- * @param discount is the Treasury bill's discount rate.
- */
-export declare function TBILLEQ(settlement: number, // date
-maturity: number, // date
-discount: number): number;
-/**
- * @summary Returns the price per $100 face value for a treasury bill.
- * @param settlement is the Treasury bill's settlement date, expressed as a serial date number.
- * @param maturity is the Treasury bill's maturity date, expressed as a serial date number.
- * @param discount is the Treasury bill's discount rate.
- */
-export declare function TBILLPRICE(settlement: number, // date
-maturity: number, // date
-discount: number): number;
-/**
- * @summary Returns the yield for a treasury bill.
- * @param settlement is the Treasury bill's settlement date, expressed as a serial date number.
- * @param maturity is the Treasury bill's maturity date, expressed as a serial date number.
- * @param pr is the Treasury Bill's price per $100 face value.
- */
-export declare function TBILLYIELD(settlement: number, // date
-maturity: number, // date
-pr: number): number;
-/**
- * @summary Returns the internal rate of return for a schedule of cash flows.
- * @param values is a series of cash flows that correspond to a schedule of payments in dates.
- * @param dates is a schedule of payment dates that corresponds to the cash flow payments.
- * @param guess is a number that you guess is close to the result of XIRR.
- */
-export declare function XIRR(values: IRange, dates: IRange, guess?: number): Scalar;
-/**
- * @summary Returns the net present value for a schedule of cash flows.
- * @param rate is the discount rate to apply to the cash flows.
- * @param values is a series of cash flows that correspond to a schedule of payments in dates.
- * @param dates is a schedule of payment dates that corresponds to the cash flow payments.
- */
-export declare function XNPV(rate: number, values: IRange, dates: IRange): Scalar;
-//# sourceMappingURL=Financial.d.ts.map