@sheetxl/formulas 0.7.21 → 0.7.23-beta.1

package/types/src/information/Information.d.ts

@@ -0,0 +1,166 @@
+import { FormulaError, AcceptError, AcceptRefError, Scalar, IReferenceRange, IRange, Flatten } from '@sheetxl/primitives';
+/**
+ * @summary Returns information about the cell.
+ * @param {'address' | 'col' | 'contents' | 'row' | 'type'} infoType The type of information to return.
+ * @param infoType
+ * @param reference
+ *
+ * @remarks
+ * This has similar functionality to Excel online but is missing formatting information from Excel desktop.
+ * {@link https://support.office.com/client/results?authtype=unknown&lcid=1033&locale=en-us&ns=EXCEL&syslcid=1033&uilcid=1033&version=90&helpid=xlmain11.chm60173}
+ */
+export declare function CELL(infoType: string, reference?: AcceptError<IReferenceRange>): Scalar;
+/**
+ * @name ERROR.TYPE
+ * @summary Returns a number matching an error value.
+ * @param errorVal is the error value for which you want the identifying number, and can be an actual error value or a reference to a cell containing an error value.
+ */
+export declare function ERROR_TYPE(errorVal: AcceptError<Scalar>): Scalar;
+/**
+ * @summary Returns information about the current operating system.
+ * @param {'DIRECTORY' | 'NUMFILE' | 'ORIGIN' | 'OSVERSION' | 'RECALC' | 'RELEASE' | 'SYSTEM' | 'USER'} typeText The type of information to return.
+ */
+export declare function INFO(typeText: string): string;
+/**
+ * @summary Checks whether a reference is to an empty cell, and returns TRUE or FALSE.
+ * @param value is the cell or a name that refers to the cell you want to test.
+ */
+export declare function ISBLANK(value: AcceptError<Scalar>): boolean;
+/**
+ * @summary Returns TRUE if the value is a date.
+ * @param value The value to check.
+ * @category Sheets
+ *
+ * @remarks
+ * A TEXT predicate, despite the name — it asks whether text spells a date, not whether a value
+ * is one. Measured in Sheets 2026-08-19: every number is FALSE at every serial, `0`, `1`,
+ * `2958465` and `-1` alike, and so is `DATEVALUE("1/1/2020")`, whose declared return is a
+ * number. Booleans and blanks are FALSE; errors propagate with their identity. Text is TRUE
+ * when the parser accepts the WHOLE string — a bare `"July"` and `"2/30/2020"` are FALSE.
+ *
+ * Where Sheets and Excel disagree on a SPELLING, Excel wins here: `ISDATE("July 20 1969")` is
+ * FALSE (Excel wants the comma in month-day-year order), `ISDATE("Feb 30")` is TRUE (Excel
+ * reads a number that cannot be a day as a 2-digit year — Feb 1930), and `ISDATE("1969-20-07")`
+ * is FALSE (year-first is year-month-day with a four-digit year; Sheets takes year-day-month,
+ * Excel does not). All measured, all the opposite of Sheets, and all inherited rather than
+ * decided here: this shares the `DATEVALUE` parser, and that parser answers to Excel.
+ *
+ * **`ISDATE(A1)` on a date cell is FALSE here and TRUE in Sheets — deliberately.** Sheets reads
+ * the referenced cell's NUMBER FORMAT, and that is the parity we cannot reach: a date here is a
+ * number carrying a date format, formats are not exposed to a formula, and the calculation graph
+ * does not treat a format edit as a change that dirties anything — so a format-reading `ISDATE`
+ * would answer correctly once and then go stale on the next reformat. Reading the value instead
+ * (any serial-range number is a date) was the alternative, and it was rejected: it would have
+ * contradicted six measured results to buy back one, and called `ISDATE(42)` a date.
+ *
+ * Sheets also answers TRUE for `ISDATE(TODAY())` and `ISDATE(TIME(13,0,0))` — there the
+ * argument's static type is a date, which is why `DATEVALUE` differs from `TODAY` there despite
+ * both evaluating to a number. That provenance does not survive to a function here either.
+ */
+export declare function ISDATE(value: Scalar): boolean;
+/**
+ * @summary Returns TRUE if the value is a valid email address.
+ * @param value The value to check.
+ * @category Sheets
+ */
+export declare function ISEMAIL(value: string): boolean;
+/**
+ * @summary Checks whether a value is an error other than #N/A, and returns TRUE or FALSE.
+ * @param value is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
+ */
+export declare function ISERR(value: AcceptError<Scalar>): Scalar;
+/**
+ * @summary Checks whether a value is an error, and returns TRUE or FALSE
+ * @param value is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value
+ */
+export declare function ISERROR(value: AcceptError<Scalar>): Scalar;
+/**
+ * @summary Returns TRUE if the number is even.
+ * @param number is the value to test.
+ *
+ * @remarks
+ * We take a range to error if a range.
+ */
+export declare function ISEVEN(number: IRange<number>): Scalar;
+/**
+ * @summary Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE.
+ * @param reference is a reference to the cell you want to test.  Reference can be a cell reference, a formula, or name that refers to a cell.
+ */
+export declare function ISFORMULA(reference: AcceptError<IReferenceRange>): boolean;
+/**
+ * @summary Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE.
+ * @param value is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
+ */
+export declare function ISLOGICAL(value: AcceptError<Scalar>): boolean;
+/**
+ * @summary Checks whether a value is #N/A, and returns TRUE or FALSE.
+ * @param value is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
+ */
+export declare function ISNA(value: AcceptError<Scalar>): boolean;
+/**
+ * @summary Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE.
+ * @param value is the value you want tested: a cell; a formula; or a name referring to a cell, formula, or value.
+ */
+export declare function ISNONTEXT(value: AcceptError<Scalar>): boolean;
+/**
+ * @summary Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE.
+ * @param value is the value you want tested: a cell; a formula; or a name referring to a cell, formula, or value.
+ */
+export declare function ISNUMBER(value: AcceptError<Scalar>): boolean;
+/**
+ * @summary Returns TRUE if the number is odd.
+ * @param number is the value to test.
+ *
+ * @remarks
+ * We take a range to error if a range.
+ */
+export declare function ISODD(number: IRange<number>): Scalar;
+/**
+ * @summary Checks whether the value is omitted, and returns TRUE or FALSE.
+ * @param argument is the value you want to test, such as a LAMBDA parameter.
+ */
+export declare function ISOMITTED(argument: AcceptError<Scalar>): boolean;
+/**
+ * @summary Returns TRUE if the value is a valid HTTP or HTTPS URL.
+ * @param value The value to check.
+ * @category Sheets
+ */
+export declare function ISURL(value: string): boolean;
+/**
+ * @summary Checks whether a value is a reference, and returns TRUE or FALSE.
+ * @param value is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.
+ */
+export declare function ISREF(value: Flatten<AcceptError<IRange>>): boolean;
+/**
+ * @summary Converts a value to text in a specific number format.
+ * @param value is a number, a formula that evaluates to a numeric value, or a reference to a cell containing a numeric value.
+ */
+export declare function ISTEXT(value: AcceptError<Scalar>): boolean;
+/**
+ * @summary Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero).
+ * @param value is the value to convert.
+ */
+export declare function N(value: AcceptError<Scalar>): Scalar;
+/**
+ * @summary Returns the #N/A error value
+ */
+export declare function NA(): FormulaError.Known;
+/**.
+ * @summary Returns the sheet number of the referenced sheet.
+ * @param value is the name of a sheet or a reference that you want the sheet number of. If omitted the number of the sheet containing the function is returned.
+ */
+export declare function SHEET(value?: AcceptRefError<IRange>): Scalar;
+/**
+ * @summary Returns the number of sheets in a reference.
+ * @param reference is a reference for which you want to know the number of sheets it contains. If omitted the number of sheets in the workbook containing the function is returned.
+ *
+ * @remarks
+ * A non-reference argument — a number, text, an array, a computed value — returns `#N/A`.
+ */
+export declare function SHEETS(reference?: AcceptRefError<IRange>): number | FormulaError.Known;
+/**
+ * @summary Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128.
+ * @param value is the value to check.
+ */
+export declare function TYPE(value: AcceptError<IRange>): number;
+//# sourceMappingURL=Information.d.ts.map

package/types/src/information/Information.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Information.d.ts","sourceRoot":"","sources":["../../../../src/information/Information.ts"],"names":[],"mappings":"AACA,OAAO,EACW,YAAY,EAC5B,KAAK,WAAW,EAAE,KAAK,cAAc,EAAE,KAAK,MAAM,EAAE,KAAK,eAAe,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EACpG,MAAM,qBAAqB,CAAC;AAE7B;;;;;;;;;GASG;AAEH,wBAAgB,IAAI,CAClB,QAAQ,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,GACvC,MAAM,CA8CR;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAKhE;AAED;;;GAGG;AAEH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAyC7C;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAE3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAU7C;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAK9C;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAExD;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAIrD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,OAAO,CAQ1E;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAE7D;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAExD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAE7D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAE5D;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAIpD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAKhE;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAS5C;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAOlE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,OAAO,CAE1D;AAED;;;GAGG;AACH,wBAAgB,CAAC,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAKpD;AAED;;GAEG;AACH,wBAAgB,EAAE,IAAI,YAAY,CAAC,KAAK,CAEvC;AAED;;;GAGG;AACH,wBAAgB,KAAK,CACnB,KAAK,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,GAC7B,MAAM,CAgBR;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,YAAY,CAAC,KAAK,CAOtF;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAWvD"}

package/types/src/japanese/Date.d.ts

@@ -0,0 +1,15 @@
+import { Scalar } from '@sheetxl/primitives';
+/**
+ * @hidden Unimplemented Japanese.
+ * @summary Converts a standard date code into a localized text string.
+ * @param number A numeric value representing a date code.
+ */
+export declare function DATESTRING(number: number): Scalar;
+/**
+ * @hidden Unimplemented Japanese.
+ * @summary Converts a number into Japanese Kanji words.
+ * @param number A numeric value representing a date code.
+ * @param number2 A numeric value representing a date code.
+ */
+export declare function NUMBERSTRING(number: number, number2: number): Scalar;
+//# sourceMappingURL=Date.d.ts.map

package/types/src/japanese/Date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Date.d.ts","sourceRoot":"","sources":["../../../../src/japanese/Date.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEhE;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAKjD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAGpE"}

package/types/src/japanese/Text.d.ts

@@ -0,0 +1,8 @@
+import { Scalar, IReferenceRange } from '@sheetxl/primitives';
+/**
+ * @hidden Unimplemented Japanese.
+ * @summary Returns the phonetic spelling of a text string.
+ * @param reference Text string or a reference to a single cell or a range of cells that contain a furigana text string.
+ */
+export declare function PHONETIC(reference: IReferenceRange): Scalar | undefined;
+//# sourceMappingURL=Text.d.ts.map

package/types/src/japanese/Text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Text.d.ts","sourceRoot":"","sources":["../../../../src/japanese/Text.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,MAAM,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtF;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,eAAe,GAAW,MAAM,GAAG,SAAS,CAG/E"}

package/types/src/logical/Logical.d.ts

@@ -0,0 +1,133 @@
+import { IRange, AcceptError, AcceptRefError, IReferenceRange, Scalar, Lambda, Omittable, Repeating } from '@sheetxl/primitives';
+/**
+ * @summary Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE.
+ * @param logical are 1 to 255 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references.
+ */
+export declare function AND(logical: IRange[]): Scalar;
+/**
+ * @summary Applies a LAMBDA function to each column and returns an array of the results.
+ * @param array is an array to be separated by column.
+ * @param fn is a LAMBDA that takes a column as its single parameter and returns one result for it.
+ */
+export declare function BYCOL(array: AcceptRefError<IRange>, fn?: Lambda<[column: IRange], Scalar>): IRange;
+/**
+ * @summary Applies a LAMBDA function to each row and returns an array of the results.
+ * @param array is an array to be separated by row.
+ * @param fn is a LAMBDA that takes a row as its single parameter and returns one result for it.
+ */
+export declare function BYROW(array: AcceptRefError<IRange>, fn?: Lambda<[row: IRange], Scalar>): IRange;
+/**
+ * @summary Returns the logical value FALSE.
+ */
+export declare function FALSE(): boolean;
+/**
+ * @summary Flattens all the values from one or more ranges into a single column.
+ * @param ranges One or more ranges or scalar values to flatten.
+ * @category Sheets
+ */
+export declare function FLATTEN(ranges: AcceptError<IRange>[]): IRange;
+/**
+ * @summary Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE.
+ * @param logicalTest is any value or expression that can be evaluated to TRUE or FALSE.
+ * @param valueIfTrue is the value that is returned if logicalTest is TRUE. If omitted, TRUE is returned. You can nest up to seven IF functions.
+ * @param valueIfFalse is the value that is returned if logicalTest is FALSE. If omitted, FALSE is returned.
+ */
+export declare function IF(logicalTest: boolean, valueIfTrue: AcceptError<any>, valueIfFalse?: AcceptError<any>): any;
+/**
+ * @summary Returns valueIfError if expression is an error and the value of the expression itself otherwise.
+ * @param value is any value or expression or reference.
+ * @param valueIfError is any value or expression or reference.
+ */
+export declare function IFERROR(value: AcceptError<Scalar>, valueIfError: AcceptError<any>): Scalar;
+/**
+ * @summary Returns the value you specify if the expression resolves to #N/A, otherwise returns the result of the expression.
+ * @param value is any value or expression or reference.
+ * @param valueIfNA is any value or expression or reference.
+ */
+export declare function IFNA(value: AcceptError<Scalar>, valueIfNA: AcceptError<any>): Scalar;
+/**
+ * @summary Checks whether one or more conditions are met and returns a value corresponding to the first TRUE condition.
+ * @param condition the conditions to test and the values to return for them.
+ * @param condition.logicalTest is any value or expression that can be evaluated to TRUE or FALSE.
+ * @param condition.logicalTrue is the value returned if logicalTest is TRUE.
+ */
+export declare function IFS(condition: Repeating<[logicalTest: boolean, logicalTrue: AcceptError<any>]>): any;
+/**
+ * @summary Creates a function value which can be called within formulas.
+ * @param parameterOrCalculation a parameter or a calculation that returns a value. If a parameter, it must be the last argument.
+ */
+export declare function LAMBDA(parameterOrCalculation: AcceptError<IRange>[]): Lambda;
+/**
+ * @summary Assigns calculation results to names. Useful for storing intermediate calculations and values by defining names inside a formula. These names only apply within the scope of the LET function.
+ * @param name the name, or a calculation which can make use of all names within the LET. Names must start with a letter, cannot be the output of a formula, or conflict with range syntax.
+ * @param nameOrValue the value associated with the name.
+ */
+export declare function LET(name: AcceptError<any>, nameOrValue: AcceptError<IRange>, calculationOrName: AcceptError<IRange>, ...rest: AcceptError<IRange>[]): any;
+/**
+ * @summary Returns a calculated array of a specified row and column size, by applying a LAMBDA function.
+ * @param rows is the number of rows in the array. Must be greater than zero.
+ * @param columns is the number of columns in the array. Must be greater than zero.
+ * @param fn is a LAMBDA that is called to create the array. The LAMBDA takes two parameters, row index and column index.
+ */
+export declare function MAKEARRAY(rows: Omittable<number, 1>, columns: Omittable<number, 1>, fn: Lambda<[rowIndex: number, colIndex: number], Scalar>): IRange;
+/**
+ * @summary Returns an array formed by 'mapping' each value in the array(s) to a new value by applying a lambda to create a new value.
+ * @param array is an array to be mapped.
+ * @param lambdaOrArray is a LAMBDA which must be the last argument and must have a parameter for each array passed, or another array to be mapped.
+ */
+export declare function MAP(array: AcceptRefError<IRange>, lambdaOrArray: (any | Lambda<any[], Scalar>)[]): IRange;
+/**
+ * @summary Changes FALSE to TRUE, or TRUE to FALSE.
+ * @param logical is a value or expression that can be evaluated to TRUE or FALSE.
+ */
+export declare function NOT(logical: boolean): boolean;
+/**
+ * @summary Checks whether any of the arguments are TRUE, and returns TRUE or FALSE. Returns FALSE only if all arguments are FALSE.
+ * @param logical are 1 to 255 conditions that you want to test that can be either TRUE or FALSE.
+ */
+export declare function OR(logical: IRange[]): Scalar;
+/**
+ * @summary Reduces an array to an accumulated value by applying a LAMBDA function to each value and returning the total value in the accumulator.
+ * @param initialValue is the starting value for the accumulator.
+ * @param array is an array to be reduced.
+ * @param fn is a LAMBDA that is called to reduce the array. The LAMBDA takes two parameters, accumulator and value.
+ */
+export declare function REDUCE(initialValue: Omittable<AcceptError<any>>, array: AcceptRefError<IRange>, fn: Lambda<[accumulator: any, value: Scalar], any>): any;
+/**
+ * @summary Reduces the cells specified by a given condition or criteria.
+ * @param range is the range of cells you want evaluated.
+ * @param criteria is the condition or criteria in the form of a number, expression, or text that defines which cells will be reduced.
+ * @param reduceRange are the actual cells to reduce. If omitted, the cells in range are used. This can be blank.
+ * @param fn is a LAMBDA that is called to reduce the array. The LAMBDA takes two parameters, accumulator and value.
+ * @category SheetXL
+ *
+ * @remarks
+ * This is a lambda equivalent to SUMIF, COUNTIF, and AVERAGEIF.
+ */
+export declare function REDUCEIF(range: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>, reduceRange: Omittable<AcceptError<IReferenceRange>>, fn: Lambda<[accumulator: Scalar, value: Scalar], Scalar>): Scalar;
+/**
+ * @summary Scans an array by applying a LAMBDA function to each value and returns an array that has each intermediate value.
+ * @param initialValue is the starting value for the accumulator.
+ * @param array is an array to be reduced.
+ * @param fn is a LAMBDA that is called to reduce the array. The LAMBDA takes two parameters, accumulator and value.
+ */
+export declare function SCAN(initialValue: Omittable<Scalar>, array: AcceptRefError<IRange>, fn: Lambda<[accumulator: Scalar, value: Scalar], Scalar>): IRange;
+/**
+ * @summary Evaluates an expression against a list of values and returns the result corresponding to the first matching value. If there is no match, an optional default value is returned.
+ * @param match the values to compare against expression and the results to return for them.
+ * @param match.value is a value to compare against expression.
+ * @param match.result is a result to be returned if the corresponding value matches expression.
+ * @param expression is an expression to be evaluated.
+ * @param defaultResult is the result to be returned when no value matches expression.
+ */
+export declare function SWITCH(expression: Scalar, match: Repeating<[value: Scalar, result: AcceptError<any>]>, defaultResult?: Omittable<AcceptError<any>, 0>): any;
+/**
+ * @summary Returns the logical value TRUE.
+ */
+export declare function TRUE(): boolean;
+/**
+ * @summary Returns a logical 'Exclusive Or' of all arguments.
+ * @param logical are 1 to 254 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references.
+ */
+export declare function XOR(logical: IRange[]): Scalar;
+//# sourceMappingURL=Logical.d.ts.map

package/types/src/logical/Logical.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logical.d.ts","sourceRoot":"","sources":["../../../../src/logical/Logical.ts"],"names":[],"mappings":"AACA,OAAO,EACyB,MAAM,EACpC,KAAK,WAAW,EAAE,KAAK,cAAc,EAAE,KAAK,eAAe,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EACtH,MAAM,qBAAqB,CAAC;AAI7B;;;GAGG;AACH,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAc7C;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CACnB,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,EAC7B,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,GACpC,MAAM,CASR;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CACnB,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,EAC7B,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,GACjC,MAAM,CASR;AAED;;GAEG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAE/B;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAiB7D;AAED;;;;;GAKG;AACH,wBAAgB,EAAE,CAChB,WAAW,EAAE,OAAO,EACpB,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAC7B,YAAY,GAAE,WAAW,CAAC,GAAG,CAAS,GACrC,GAAG,CAEL;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CACrB,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,EAC1B,YAAY,EAAE,WAAW,CAAC,GAAG,CAAC,GAC7B,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAClB,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,EAC1B,SAAS,EAAE,WAAW,CAAC,GAAG,CAAC,GAC1B,MAAM,CAER;AAED;;;;;GAKG;AACH,wBAAgB,GAAG,CACjB,SAAS,EAAE,SAAS,CAAC,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,GAC1E,GAAG,CAKL;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,sBAAsB,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAO5E;AAED;;;;GAIG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,EACtB,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,EAChC,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,EACtC,GAAG,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,GAC7B,GAAG,CAUL;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAC1B,OAAO,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAC7B,EAAE,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,GACvD,MAAM,CAoBR;AAED;;;;GAIG;AACH,wBAAgB,GAAG,CACjB,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,EAC7B,aAAa,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC,EAAE,GAC7C,MAAM,CAyCR;AAED;;;GAGG;AACH,wBAAgB,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7C;AAED;;;GAGG;AACH,wBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAe5C;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CACpB,YAAY,EAAE,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EACzC,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,EAC7B,EAAE,EAAE,MAAM,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,GACjD,GAAG,CAmBL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,WAAW,CAAC,eAAe,CAAC,EACnC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,EAC7B,WAAW,EAAE,SAAS,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,EACpD,EAAE,EAAE,MAAM,CAAC,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,GACvD,MAAM,CAGR;AAED;;;;;GAKG;AACH,wBAAgB,IAAI,CAClB,YAAY,EAAE,SAAS,CAAC,MAAM,CAAC,EAC/B,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,EAC7B,EAAE,EAAE,MAAM,CAAC,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,GACvD,MAAM,CAyBR;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAC3D,aAAa,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAC7C,GAAG,CAgCL;AAED;;GAEG;AACH,wBAAgB,IAAI,IAAI,OAAO,CAE9B;AAED;;;GAGG;AACH,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAY7C"}

package/types/src/lookupReference/GroupBy.d.ts

@@ -0,0 +1,19 @@
+import { IRange, AcceptRefError, Flatten, Omittable, Scalar } from '@sheetxl/primitives';
+/**
+ * @hidden Unimplemented TODO
+ * @summary Aggregate values by row fields.
+ * @param rowFields The range or array containing the row fields.
+ * @param values The range or array containing the values to aggregate.
+ * @param fn The function used to do the aggregations.
+ * @param fieldHeaders A number between 0 and 3 that specifies whether the field data has headers and whether field headers should be returned in the results.
+ * @param totalDepth Show totals for the row fields. 0 for none, 1 for grand totals, 2 for grand total and first level subtotals, etc.
+ * @param sortOrder The column index to sort the row fields on. A negative index will sort in reverse order.
+ * @param filterArray param-534 paramName-535.
+ * @param fieldRelationship The relationship of fields when multiple columns are supplied to the rowFields argument.
+ */
+export declare function GROUPBY(rowFields: AcceptRefError<IRange>, values: IRange, fn: Flatten<any>, // This can be either a Lamda function or a builtIn.
+fieldHeaders?: Omittable<number>, // 0-no, 1-yes, 2-no but generate, 3-yes and show
+totalDepth?: number, // 0-no totals, 1-grand totals, 2-grand and subtotals, -1-grand totals at top, -2 grand and sub totals at top
+sortOrder?: Omittable<Flatten<any>>, // <0, >0
+filterArray?: Omittable<Flatten<boolean>>, fieldRelationship?: number): Scalar[][];
+//# sourceMappingURL=GroupBy.d.ts.map

package/types/src/lookupReference/GroupBy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupBy.d.ts","sourceRoot":"","sources":["../../../../src/lookupReference/GroupBy.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,KAAK,MAAM,EAAwB,KAAK,cAAc,EAAE,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEtJ;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CACrB,SAAS,EAAE,cAAc,CAAC,MAAM,CAAC,EACjC,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,oDAAoD;AACtE,YAAY,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,iDAAiD;AACnF,UAAU,GAAE,MAAQ,EAAE,6GAA6G;AACnI,SAAS,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS;AAC9C,WAAW,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EACzC,iBAAiB,GAAE,MAAQ,GACxB,MAAM,EAAE,EAAE,CAGd"}

package/types/src/lookupReference/PivotBy.d.ts

@@ -0,0 +1,24 @@
+import { IRange, AcceptRefError, Flatten, Omittable, Scalar } from '@sheetxl/primitives';
+/**
+ * @hidden Unimplemented TODO
+ * @summary Aggregate values by rows and columns.
+ * @param rowFields The range or array containing the row fields.
+ * @param colFields The range or array containing the column fields.
+ * @param values The range or array containing the value fields.
+ * @param fn The function used to do the aggregations.
+ * @param fieldHeaders A number between 0 and 3 that specifies whether the field data has headers and whether field headers should be return in the results.
+ * @param rowTotalDepth Show totals for the row fields. 0 for none, 1 for grand totals, 2 for grand totals and first level subtotals, etc.
+ * @param rowSortOrder The column index to sort the row fields on. A negative index will sort in reverse order.
+ * @param colTotalDepth Show totals for the column fields. 0 for none, 1 for grand totals, 2 for grand totals and first level subtotals, etc.
+ * @param colSortOrder The column index to sort the column fields on. A negative index will sort in reverse order.
+ * @param filterArray An array of boolean where TRUE represents a row to retain.
+ * @param relativeTo Defines what PERCENTOF is calculated relative to.
+ */
+export declare function PIVOTBY(rowFields: AcceptRefError<IRange>, colFields: AcceptRefError<IRange>, values: Flatten<IRange>, fn: Flatten<IRange>, // Wow, this is a lambda function? No. I don't think so...
+fieldHeaders?: Omittable<number>, // 0-no, 1-yes, 2-no but generate, 3-yes and show
+rowTotalDepth?: number, // 0-no totals, 1-grand totals, 2-grand and subtotals, -1-grand totals at top, -2 grand and sub totals at top
+rowSortOrder?: Omittable<Flatten<any>>, // <0, >0
+colTotalDepth?: number, // 0-no totals, 1-grand totals, 2-grand and subtotals, -1-grand totals at top, -2 grand and sub totals at top
+colSortOrder?: Omittable<Flatten<any>>, // <0, >0
+filterArray?: Omittable<Flatten<boolean>>, relativeTo?: number): Scalar[][];
+//# sourceMappingURL=PivotBy.d.ts.map

package/types/src/lookupReference/PivotBy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PivotBy.d.ts","sourceRoot":"","sources":["../../../../src/lookupReference/PivotBy.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,KAAK,MAAM,EAAwB,KAAK,cAAc,EAAE,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEtJ;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CACrB,SAAS,EAAE,cAAc,CAAC,MAAM,CAAC,EACjC,SAAS,EAAE,cAAc,CAAC,MAAM,CAAC,EACjC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,EACvB,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,0DAA0D;AAC/E,YAAY,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,iDAAiD;AACnF,aAAa,GAAE,MAAQ,EAAE,6GAA6G;AACtI,YAAY,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS;AACjD,aAAa,GAAE,MAAQ,EAAE,6GAA6G;AACtI,YAAY,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS;AACjD,WAAW,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EACzC,UAAU,GAAE,MAAQ,GACnB,MAAM,EAAE,EAAE,CAIZ"}