@sheetxl/formulas-extended 0.7.23-beta.1

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

@@ -0,0 +1,106 @@
+/**
+ * Odd first and last coupon bond price/yield functions.
+ *
+ * "Odd" means the first or last coupon period is irregular — shorter or longer
+ * than a standard coupon period.  This happens when a bond is issued between
+ * coupon dates (odd first) or the final coupon date doesn't align with
+ * maturity (odd last).
+ *
+ * Why ODDLPRICE lives here and not in financialHelpers:
+ * The odd-last formula uses a different internal structure (_getCoupDate,
+ * _getFrac) that is not shared by any other function.  Keeping it here avoids
+ * polluting the shared helper module with single-use private math.
+ *
+ * Date ordering requirements:
+ *   ODDFPRICE/ODDFYIELD: issue < settlement < firstCoupon < maturity
+ *   ODDLPRICE/ODDLYIELD: lastInterest < settlement < maturity
+ */
+/**
+ * @summary Returns the price per $100 face value of a security with an odd first period.
+ * @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 issue is the security's issue date, expressed as a serial date number.
+ * @param firstCoupon is the security's first coupon date, expressed as a serial date number.
+ * @param yld is the security's annual yield.
+ * @param redemption is the security's redemption value per $100 face value.
+ * @param frequency is the number of coupon payments per year.
+ * @param basis is the type of day count basis to use.
+ *
+ * @remarks
+ * The first coupon period is "odd" (shorter or longer than normal) when the
+ * bond is issued between standard coupon dates.
+ */
+export declare function ODDFPRICE(settlement: number, // date
+maturity: number, // date
+issue: number, // date
+firstCoupon: number, // date
+rate: number, yld: number, redemption: number, frequency: number, basis?: number): number;
+/**
+ * @summary Returns the yield of a security with an odd first period.
+ * @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 issue is the security's issue date, expressed as a serial date number.
+ * @param firstCoupon is the security's first coupon date, expressed as a serial date number.
+ * @param rate is the security's interest rate.
+ * @param pr is the security's price.
+ * @param redemption is the security's redemption value per $100 face value.
+ * @param frequency is the number of coupon payments per year.
+ * @param basis is the type of day count basis to use.
+ *
+ * @remarks
+ * Numerically inverts ODDFPRICE via Newton-Raphson.  The initial guess uses
+ * the same heuristic as Excel: a linear approximation of yield from the
+ * price/day-count relationship.
+ */
+export declare function ODDFYIELD(settlement: number, // date
+maturity: number, // date
+issue: number, // date
+firstCoupon: number, // date
+rate: number, pr: number, redemption: number, frequency: number, basis?: number): number;
+/**
+ * @summary Returns the price per $100 face value of a security with an odd last period.
+ * @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 lastInterest is the security's last coupon date, expressed as a serial date number.
+ * @param rate is the interest rate.
+ * @param yld is the security's annual yield.
+ * @param redemption is the amount to be received at maturity.
+ * @param frequency is the number of coupon payments per year.
+ * @param basis is the type of day count basis to use.
+ *
+ * @remarks
+ * The last coupon period is "odd" when the final coupon date and maturity do
+ * not coincide — i.e. the bond matures between regular coupon dates.
+ *
+ * Unlike the odd-first functions, the odd-last formula is derived from a
+ * different spec formula that expresses price as a function of three
+ * fractional period lengths (fAi, fDCi, fDSCi — see _calculateOddLPrice).
+ */
+export declare function ODDLPRICE(settlement: number, // date
+maturity: number, // date
+lastInterest: number, // date
+rate: number, yld: number, redemption: number, frequency: number, basis?: number): number;
+/**
+ * @summary Returns the yield of a security with an odd last period.
+ * @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 lastInterest is the security's last coupon date, expressed as a serial date number.
+ * @param rate is the interest rate.
+ * @param pr is the security's price.
+ * @param redemption is the amount to be received at maturity.
+ * @param frequency is the number of coupon payments per year.
+ * @param basis is the type of day count basis to use.
+ *
+ * @remarks
+ * For the odd-last case Excel uses a closed-form yield formula (not Newton)
+ * because the price formula is linear in yield.  We follow the same approach.
+ *
+ * Formula from the Excel spec:
+ *   yield = (freq*(redemption−pr) + 100*rate*(fDCi−fAi))
+ *           / (fDSCi*pr + 100*rate*fAi*fDSCi/freq)
+ */
+export declare function ODDLYIELD(settlement: number, // date
+maturity: number, // date
+lastInterest: number, // date
+rate: number, pr: number, redemption: number, frequency: number, basis?: number): number;
+//# sourceMappingURL=ODD.d.ts.map

package/types/src/financial/ODD.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ODD.d.ts","sourceRoot":"","sources":["../../../../src/financial/ODD.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,MAAM,EAAE,OAAO;AAC3B,QAAQ,EAAE,MAAM,EAAE,OAAO;AACzB,KAAK,EAAE,MAAM,EAAE,OAAO;AACtB,WAAW,EAAE,MAAM,EAAE,OAAO;AAC5B,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,MAAU,GAChB,MAAM,CAuBR;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,MAAM,EAAE,OAAO;AAC3B,QAAQ,EAAE,MAAM,EAAE,OAAO;AACzB,KAAK,EAAE,MAAM,EAAE,OAAO;AACtB,WAAW,EAAE,MAAM,EAAE,OAAO;AAC5B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,MAAU,GAChB,MAAM,CAuCR;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,MAAM,EAAE,OAAO;AAC3B,QAAQ,EAAE,MAAM,EAAE,OAAO;AACzB,YAAY,EAAE,MAAM,EAAE,OAAO;AAC7B,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,MAAU,GAChB,MAAM,CAqBR;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,MAAM,EAAE,OAAO;AAC3B,QAAQ,EAAE,MAAM,EAAE,OAAO;AACzB,YAAY,EAAE,MAAM,EAAG,OAAO;AAC9B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,MAAU,GAChB,MAAM,CA4BR"}

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

@@ -0,0 +1,27 @@
+/**
+ * @summary Returns the depreciation of an asset for any period you specify, including partial periods, 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 startPeriod is the first period in the calculation.
+ * @param endPeriod is the last period in the calculation.
+ * @param factor is the rate at which the balance declines.
+ * @param noSwitch switch to straight-line depreciation when depreciation is greater than the declining balance = FALSE; do not switch = TRUE.
+ *
+ * @remarks
+ * including partial periods, using the double-declining balance method or
+ * some other method you specify.
+ *
+ * VDB = Variable Declining Balance.  It generalises DDB by:
+ *   • accepting fractional start/end periods
+ *   • supporting any factor (not just 2)
+ *   • optionally switching to straight-line when SL > DDB (noSwitch=FALSE)
+ *
+ * The `noSwitch` flag controls the switch-to-SL behavior:
+ *   FALSE (default) — switch to straight-line when it yields more depreciation
+ *   TRUE            — pure declining-balance, never switch
+ */
+export declare function VDB(cost: number, salvage: number, life: number, startPeriod: number, // date
+endPeriod: number, // date
+factor?: number, noSwitch?: boolean): number;
+//# sourceMappingURL=VDB.d.ts.map

package/types/src/financial/VDB.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VDB.d.ts","sourceRoot":"","sources":["../../../../src/financial/VDB.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE,OAAO;AAC5B,SAAS,EAAE,MAAM,EAAE,OAAO;AAC1B,MAAM,GAAE,MAAU,EAClB,QAAQ,GAAE,OAAe,GACxB,MAAM,CAiCR"}

package/types/src/statistical/ETS.d.ts

@@ -0,0 +1,45 @@
+import { IRange, Scalar } from '@sheetxl/primitives';
+/**
+ * @name FORECAST.ETS
+ * @summary Returns the forecasted value for a specific future target date using exponential smoothing method.
+ * @param targetDate is the data point for which you want to predict a value. It should carry on the pattern of values in the timeline.
+ * @param values is the array or range of numeric data you're predicting.
+ * @param timeline is the independent array or range of numeric data. The dates in the timeline must have a consistent step between them and can't be zero.
+ * @param seasonality [1] 0 = no seasonality; 1 = auto-detect; any integer > 1 = explicit seasonal period.
+ * @param dataCompletion [1] 1 = interpolate missing values; 0 = fill with zeros.
+ * @param aggregation [1] Aggregation method for duplicate timestamps: 1=Average, 2=Count, 3=Max, 4=Median, 5=Min, 6=Sum, 7=None (#NUM! if duplicates exist).
+ */
+export declare function FORECAST_ETS(targetDate: number, values: IRange, timeline: IRange, seasonality?: number, dataCompletion?: number, aggregation?: number): Scalar;
+/**
+ * @name FORECAST.ETS.CONFINT
+ * @summary Returns a confidence interval for the forecasted value at the specified target date.
+ * @param targetDate is the data point for which you want to predict a value. It should carry on the pattern of values in the timeline.
+ * @param values is the array or range of numeric data you're predicting.
+ * @param timeline is the independent array or range of numeric data. The dates in the timeline must have a consistent step between them and can't be zero.
+ * @param confidenceLevel [0.95] Confidence probability, must be strictly between 0 and 1.
+ * @param seasonality [1] 0 = no seasonality; 1 = auto-detect; any integer > 1 = explicit seasonal period.
+ * @param dataCompletion [1] 1 = interpolate missing values; 0 = fill with zeros.
+ * @param aggregation [1] Aggregation method for duplicate timestamps: 1=Average, 2=Count, 3=Max, 4=Median, 5=Min, 6=Sum, 7=None.
+ */
+export declare function FORECAST_ETS_CONFINT(targetDate: number, values: IRange, timeline: IRange, confidenceLevel?: number, seasonality?: number, dataCompletion?: number, aggregation?: number): Scalar;
+/**
+ * @name FORECAST.ETS.SEASONALITY
+ * @summary Returns the length of the repetitive pattern in the data for the specific time series.
+ * @param values is the array or range of numeric data you're predicting.
+ * @param timeline is the independent array or range of numeric data. The dates in the timeline must have a consistent step between them and can't be zero.
+ * @param dataCompletion [1] 1 = interpolate missing values; 0 = fill with zeros.
+ * @param aggregation [1] Aggregation method for duplicate timestamps: 1=Average, 2=Count, 3=Max, 4=Median, 5=Min, 6=Sum, 7=None.
+ */
+export declare function FORECAST_ETS_SEASONALITY(values: IRange, timeline: IRange, dataCompletion?: number, aggregation?: number): Scalar;
+/**
+ * @name FORECAST.ETS.STAT
+ * @summary Returns a requested statistic for the ETS forecast model.
+ * @param values is the array or range of numeric data you're predicting.
+ * @param timeline is the independent array or range of numeric data.
+ * @param statisticType 1=Alpha, 2=Beta (trend smoothing), 3=Gamma (seasonal smoothing), 4=MASE, 5=SMAPE, 6=MAE, 7=RMSE, 8=Step size.
+ * @param seasonality [1] 0 = no seasonality; 1 = auto-detect; any integer > 1 = explicit seasonal period.
+ * @param dataCompletion [1] 1 = interpolate missing values; 0 = fill with zeros.
+ * @param aggregation [1] Aggregation method for duplicate timestamps: 1=Average, 2=Count, 3=Max, 4=Median, 5=Min, 6=Sum, 7=None.
+ */
+export declare function FORECAST_ETS_STAT(values: IRange, timeline: IRange, statisticType: number, seasonality?: number, dataCompletion?: number, aggregation?: number): Scalar;
+//# sourceMappingURL=ETS.d.ts.map

package/types/src/statistical/ETS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ETS.d.ts","sourceRoot":"","sources":["../../../../src/statistical/ETS.ts"],"names":[],"mappings":"AACA,OAAO,EAAgC,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAI7F;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,WAAW,GAAE,MAAU,EACvB,cAAc,GAAE,MAAU,EAC1B,WAAW,GAAE,MAAU,GACtB,MAAM,CA0BR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,eAAe,GAAE,MAAa,EAC9B,WAAW,GAAE,MAAU,EACvB,cAAc,GAAE,MAAU,EAC1B,WAAW,GAAE,MAAU,GACtB,MAAM,CAyBR;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,cAAc,GAAE,MAAU,EAC1B,WAAW,GAAE,MAAU,GACtB,MAAM,CAWR;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EACrB,WAAW,GAAE,MAAU,EACvB,cAAc,GAAE,MAAU,EAC1B,WAAW,GAAE,MAAU,GACtB,MAAM,CA4BR"}

package/types/src/statistical/Regression.d.ts

@@ -0,0 +1,49 @@
+import { FormulaError, Scalar, IRange, Omittable } from '@sheetxl/primitives';
+/**
+ * The least-squares regression family: LINEST / LOGEST report the fitted model, TREND / GROWTH
+ * evaluate it at new x-values, and LOGEST / GROWTH are the linear pair run on `ln(y)`.
+ *
+ * All four share `_utils/LeastSquares.ts` — the known_y/known_x/new_x shape rules, the
+ * rank-deficient QR solve, and the `stats` grid.
+ */
+/**
+ * @summary Returns statistics that describe a linear trend matching known data points, by fitting a straight line using the least squares method.
+ * @param knownYs is the set of y-values you already know in the relationship y = mx + b.
+ * @param knownXs is an optional set of x-values that you may already know in the relationship y = mx + b.
+ * @param constant is a logical value: the constant b is calculated normally if Const = TRUE; b is set equal to 0 if Const = FALSE.
+ * @param stats is a logical value: return additional regression statistics = TRUE; return m-coefficients and the constant b = FALSE.
+ *
+ * @remarks {@link https://support.microsoft.com/en-us/office/linest-function-84d7d0d9-6e50-4101-977a-fa7abf772b6d|Docs}
+ */
+export declare function LINEST(knownYs: IRange, knownXs?: Omittable<IRange>, constant?: Omittable<boolean>, stats?: boolean): (number | FormulaError.Known)[][];
+/**
+ * @summary Returns statistics that describe an exponential curve matching known data points.
+ * @param knownYs is the set of y-values you already know in the relationship y = b*m^x.
+ * @param knownXs is an optional set of x-values that you may already know in the relationship y = b*m^x.
+ * @param constant is a logical value: the constant b is calculated normally if Const = TRUE; b is set equal to 1 if Const = FALSE.
+ * @param stats is a logical value: return additional regression statistics = TRUE; return m-coefficients and the constant b = FALSE.
+ *
+ * @remarks {@link https://support.microsoft.com/en-us/office/logest-function-f27462d8-3657-4030-866b-a272c1d18b4b|Docs}
+ */
+export declare function LOGEST(knownYs: IRange, knownXs?: Omittable<IRange>, constant?: Omittable<boolean>, stats?: boolean): (number | FormulaError.Known)[][];
+/**
+ * @summary Returns values along a linear trend fitted to known data points.
+ * @param knownYs The known y-values in the relationship y = mx + b.
+ * @param knownXs Optional x-values. Defaults to {1,2,3,...,n}.
+ * @param newXs The x-values for which to predict y. Defaults to knownX.
+ * @param useConst If FALSE, forces the constant b to zero. Defaults to TRUE.
+ *
+ * @remarks {@link https://support.microsoft.com/en-us/office/trend-function-e2f135f0-8827-4096-9873-9a7cf7b51ef1|Docs}
+ */
+export declare function TREND(knownYs: IRange, knownXs?: Omittable<IRange>, newXs?: Omittable<IRange>, useConst?: Omittable<boolean>): Scalar[][];
+/**
+ * @summary Returns numbers in an exponential growth trend matching known data points.
+ * @param knownYs is the set of y-values you already know in the relationship y = b*m^x, an array or range of positive numbers.
+ * @param knownXs is an optional set of x-values that you may already know in the relationship y = b*m^x, an array or range the same size as Known_y's.
+ * @param newXs  are new x-values for which you want GROWTH to return corresponding y-values.
+ * @param useConst is a logical value: the constant b is calculated normally if Const = TRUE; b is set equal to 1 if Const = FALSE.
+ *
+ * @remarks {@link https://support.microsoft.com/en-us/office/growth-function-541a91dc-3d5e-437d-b156-21324e68b80d|Docs}
+ */
+export declare function GROWTH(knownYs: IRange, knownXs?: Omittable<IRange>, newXs?: Omittable<IRange>, useConst?: Omittable<boolean>): number[][];
+//# sourceMappingURL=Regression.d.ts.map

package/types/src/statistical/Regression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Regression.d.ts","sourceRoot":"","sources":["../../../../src/statistical/Regression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAMnF;;;;;;GAMG;AAEH;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAC3B,QAAQ,GAAE,SAAS,CAAC,OAAO,CAAM,EACjC,KAAK,GAAE,OAAa,GACnB,CAAC,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,CASnC;AAED;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAC3B,QAAQ,GAAE,SAAS,CAAC,OAAO,CAAM,EACjC,KAAK,GAAE,OAAa,GACnB,CAAC,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,CAQnC;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAC3B,KAAK,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EACzB,QAAQ,GAAE,SAAS,CAAC,OAAO,CAAM,GAChC,MAAM,EAAE,EAAE,CAIZ;AAED;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CACpB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAC3B,KAAK,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EACzB,QAAQ,GAAE,SAAS,CAAC,OAAO,CAAM,GAChC,MAAM,EAAE,EAAE,CAMZ"}

package/types/src/statistical/TTEST.d.ts

@@ -0,0 +1,27 @@
+import { IRange } from '@sheetxl/primitives';
+/**
+ * @summary Returns the probability associated with a Student's t-Test.
+ * @param array1 is the first data set.
+ * @param array2 is the second data set.
+ * @param tails specifies the number of distribution tails to return: one-tailed distribution = 1; two-tailed distribution = 2.
+ * @param type is the kind of t-test: paired = 1, two-sample equal variance (homoscedastic) = 2, two-sample unequal variance = 3.
+ * @category Compatibility
+ *
+ * @remarks
+ * {@link https://support.microsoft.com/en-us/office/t-test-function-d4e08ec3-c545-485f-962e-276f7cbed055|Docs}
+ */
+export declare function TTEST(array1: IRange<number>, array2: IRange<number>, tails: number, type: number): number;
+/**
+ * @name T.TEST
+ * @summary Returns the probability associated with a Student's t-Test.
+ * @param array1 is the first data set.
+ * @param array2 is the second data set.
+ * @param tails specifies the number of distribution tails to return: one-tailed distribution = 1; two-tailed distribution = 2.
+ * @param type is the kind of t-test: paired = 1, two-sample equal variance (homoscedastic) = 2, two-sample unequal variance = 3.
+ * @category Statistical
+ *
+ * @remarks
+ * {@link https://support.microsoft.com/en-us/office/t-test-function-d4e08ec3-c545-485f-962e-276f7cbed055|Docs}
+ */
+export declare function T_TEST(array1: IRange<number>, array2: IRange<number>, tails: number, type: number): number;
+//# sourceMappingURL=TTEST.d.ts.map

package/types/src/statistical/TTEST.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TTEST.d.ts","sourceRoot":"","sources":["../../../../src/statistical/TTEST.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAIhE;;;;;;;;;;GAUG;AACH,wBAAgB,KAAK,CACnB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EACtB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EACtB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,MAAM,CAER;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EACtB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,EACtB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,MAAM,CA0CR"}

package/types/src/text/RegEx.d.ts

@@ -0,0 +1,34 @@
+import { IRange, Scalar } from '@sheetxl/primitives';
+/**
+ * @summary Extracts substrings of 'text' based on the provided REGEX 'pattern'.
+ * @param text is the text string from which you want to extract characters.
+ * @param pattern The regular expression to be applied.
+ * @param returnMode Specify which matches to return.
+ * @param caseInsensitive Whether the match is case insensitive.
+ */
+export declare function REGEXEXTRACT(text: string, pattern: string, returnMode?: number, caseInsensitive?: boolean): IRange;
+/**
+ * @summary Tests whether a text string matches a regular expression.
+ * @param text is the text string to be tested against the regular expression.
+ * @param regularExpression The regular expression to test the text against.
+ * @param caseInsensitive Whether the match is case insensitive.
+ * @category Sheets
+ */
+export declare function REGEXMATCH(text: string, regularExpression: string, caseInsensitive?: boolean): Scalar;
+/**
+ * @summary Returns 'text', with 'replacement' in place of matches with 'pattern'.
+ * @param text is the text string from which you want to extract characters.
+ * @param pattern The regular expression to be applied.
+ * @param replacement The replacement string.
+ * @param occurrence The occurrence of the match to replace.
+ * @param caseInsensitive Whether the match is case insensitive.
+ */
+export declare function REGEXREPLACE(text: string, pattern: string, replacement: string, occurrence?: number, caseInsensitive?: boolean): Scalar;
+/**
+ * @summary Checks whether the input matches the pattern, and returns TRUE or FALSE.
+ * @param text is the text string to be checked.
+ * @param pattern is the regular expression to be applied.
+ * @param caseInsensitive Whether the match is case insensitive.
+ */
+export declare function REGEXTEST(text: string, pattern: string, caseInsensitive?: boolean): Scalar;
+//# sourceMappingURL=RegEx.d.ts.map

package/types/src/text/RegEx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RegEx.d.ts","sourceRoot":"","sources":["../../../../src/text/RegEx.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,MAAM,EAAgC,KAAK,MAAM,EACvD,MAAM,qBAAqB,CAAC;AAE7B;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,UAAU,GAAE,MAAQ,EACpB,eAAe,GAAE,OAAa,GAC7B,MAAM,CAiCR;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,MAAM,EACzB,eAAe,GAAE,OAAa,GAC7B,MAAM,CAMR;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,UAAU,GAAE,MAAQ,EACpB,eAAe,GAAE,OAAa,GAC7B,MAAM,CAqCR;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,eAAe,GAAE,OAAa,GAC7B,MAAM,CAIR"}