@sheetxl/formulas 0.8.0-beta.1 → 0.8.0-beta.10

package/types/src/engineering/Imaginary.d.ts

@@ -1,153 +1,153 @@
-import { AcceptError, Scalar } from '@sheetxl/primitives';
+import { AcceptError, Omittable, Scalar, NoLift } from '@sheetxl/primitives';
 /**
- * @summary Converts real and imaginary coefficients into a complex number.
+ * Converts real and imaginary coefficients into a complex number.
  * @param realNum is the real coefficient of the complex number.
  * @param iNum is the imaginary coefficient of the complex number.
  * @param suffix is the suffix for the imaginary component of the complex number.
  */
-export declare function COMPLEX(realNum: AcceptError<Scalar>, iNum: AcceptError<Scalar>, suffix?: AcceptError<string>): Scalar;
+export declare function COMPLEX(realNum: NoLift<Omittable<AcceptError<Scalar>>>, iNum: NoLift<Omittable<AcceptError<Scalar>>>, suffix?: NoLift<AcceptError<string>>): Scalar;
 /**
- * @summary Returns the absolute value (modulus) of a complex number
+ * Returns the absolute value (modulus) of a complex number
  * @param inumber is a complex number for which you want the absolute value
  */
-export declare function IMABS(inumber: Scalar): number;
+export declare function IMABS(inumber: NoLift<Scalar>): number;
 /**
- * @summary Returns the imaginary coefficient of a complex number
+ * Returns the imaginary coefficient of a complex number
  * @param inumber is a complex number for which you want the imaginary coefficient
  */
-export declare function IMAGINARY(inumber: Scalar): number;
+export declare function IMAGINARY(inumber: NoLift<Scalar>): number;
 /**
- * @summary Returns the argument q, an angle expressed in radians
+ * Returns the argument q, an angle expressed in radians
  * @param inumber is a complex number for which you want the argument
  */
-export declare function IMARGUMENT(inumber: Scalar): number;
+export declare function IMARGUMENT(inumber: NoLift<Scalar>): number;
 /**
- * @summary Returns the complex conjugate of a complex number
+ * Returns the complex conjugate of a complex number
  * @param inumber is a complex number for which you want the conjugate
  */
-export declare function IMCONJUGATE(inumber: Scalar): Scalar;
+export declare function IMCONJUGATE(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the cosine of a complex number
+ * Returns the cosine of a complex number
  * @param inumber is a complex number for which you want the cosine
  */
-export declare function IMCOS(inumber: Scalar): Scalar;
+export declare function IMCOS(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the hyperbolic cosine of a complex number
+ * Returns the hyperbolic cosine of a complex number
  * @param inumber is a complex number for which you want the hyperbolic cosine
  */
-export declare function IMCOSH(inumber: Scalar): Scalar;
+export declare function IMCOSH(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the cotangent of a complex number
+ * Returns the cotangent of a complex number
  * @param inumber is a complex number for which you want the cotangent
  */
-export declare function IMCOT(inumber: Scalar): Scalar;
+export declare function IMCOT(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the hyperbolic cotangent of a complex number.
+ * Returns the hyperbolic cotangent of a complex number.
  * @param inumber is a complex number for which you want the hyperbolic cotangent.
  * @category Sheets
  */
 export declare function IMCOTH(inumber: Scalar): Scalar;
 /**
- * @summary Returns the cosecant of a complex number
+ * Returns the cosecant of a complex number
  * @param inumber is a complex number for which you want the cosecant
  */
-export declare function IMCSC(inumber: Scalar): Scalar;
+export declare function IMCSC(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the hyperbolic cosecant of a complex number
+ * Returns the hyperbolic cosecant of a complex number
  * @param inumber is a complex number for which you want the hyperbolic cosecant
  */
-export declare function IMCSCH(inumber: Scalar): Scalar;
+export declare function IMCSCH(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the quotient of two complex numbers
+ * Returns the quotient of two complex numbers
  * @param inumber1 is the complex numerator or dividend
  * @param inumber2 is the complex denominator or divisor
  */
-export declare function IMDIV(inumber1: Scalar, inumber2: Scalar): Scalar;
+export declare function IMDIV(inumber1: NoLift<Omittable<AcceptError<Scalar>>>, inumber2: NoLift<Omittable<AcceptError<Scalar>>>): Scalar;
 /**
- * @summary Returns the exponential of a complex number
+ * Returns the exponential of a complex number
  * @param inumber is a complex number for which you want the exponential
  */
-export declare function IMEXP(inumber: Scalar): Scalar;
+export declare function IMEXP(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the exponential of a complex number
+ * Returns the exponential of a complex number
  * @param inumber is a complex number for which you want the exponential
  */
-export declare function IMLN(inumber: Scalar): Scalar;
+export declare function IMLN(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the logarithm of a complex number to a specified base.
+ * Returns the logarithm of a complex number to a specified base.
  * @param inumber is a complex number for which you want the logarithm.
  * @param base is the base of the logarithm. Default is 10.
  * @category Sheets
  */
 export declare function IMLOG(inumber: Scalar, base?: number): Scalar;
 /**
- * @summary Returns the base-10 logarithm of a complex number
+ * Returns the base-10 logarithm of a complex number
  * @param inumber is a complex number for which you want the common logarithm
  */
-export declare function IMLOG10(inumber: Scalar): Scalar;
+export declare function IMLOG10(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the base-2 logarithm of a complex number
+ * Returns the base-2 logarithm of a complex number
  * @param inumber is a complex number for which you want the base-2 logarithm
  */
-export declare function IMLOG2(inumber: Scalar): Scalar;
+export declare function IMLOG2(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the base-2 logarithm of a complex number
+ * Returns the base-2 logarithm of a complex number
  * @param inumber is a complex number for which you want the base-2 logarithm
  */
-export declare function IMPOWER(inumber: Scalar, number: Scalar): Scalar;
+export declare function IMPOWER(inumber: NoLift<Omittable<AcceptError<Scalar>>>, number: NoLift<Omittable<AcceptError<Scalar>>>): Scalar;
 /**
- * @summary Returns the product of 1 to 255 complex numbers
+ * Returns the product of 1 to 255 complex numbers
  * @param inumber are from 1 to 255 complex numbers to multiply.
  */
 export declare function IMPRODUCT(inumber: Scalar[]): Scalar;
 /**
- * @summary Returns the real coefficient of a complex number
+ * Returns the real coefficient of a complex number
  * @param inumber is a complex number for which you want the real coefficient
  */
-export declare function IMREAL(inumber: Scalar): number;
+export declare function IMREAL(inumber: NoLift<Scalar>): number;
 /**
- * @summary Returns the secant of a complex number
+ * Returns the secant of a complex number
  * @param inumber is a complex number for which you want the secant
  */
-export declare function IMSEC(inumber: Scalar): Scalar;
+export declare function IMSEC(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the hyperbolic secant of a complex number
+ * Returns the hyperbolic secant of a complex number
  * @param inumber is a complex number for which you want the hyperbolic secant
  */
-export declare function IMSECH(inumber: Scalar): Scalar;
+export declare function IMSECH(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the sine of a complex number
+ * Returns the sine of a complex number
  * @param inumber is a complex number for which you want the sine
  */
-export declare function IMSIN(inumber: Scalar): Scalar;
+export declare function IMSIN(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the hyperbolic sine of a complex number
+ * Returns the hyperbolic sine of a complex number
  * @param inumber is a complex number for which you want the hyperbolic sine
  */
-export declare function IMSINH(inumber: Scalar): Scalar;
+export declare function IMSINH(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the square root of a complex number
+ * Returns the square root of a complex number
  * @param inumber is a complex number for which you want the square root
  */
-export declare function IMSQRT(inumber: Scalar): Scalar;
+export declare function IMSQRT(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the difference of two complex numbers
+ * Returns the difference of two complex numbers
  * @param inumber1 is the complex number from which to subtract inumber2
  * @param inumber2 is the complex number to subtract from inumber1
  */
-export declare function IMSUB(inumber1: Scalar, inumber2: Scalar): Scalar;
+export declare function IMSUB(inumber1: NoLift<Omittable<AcceptError<Scalar>>>, inumber2: NoLift<Omittable<AcceptError<Scalar>>>): Scalar;
 /**
- * @summary Returns the sum of complex numbers
+ * Returns the sum of complex numbers
  * @param inumber are from 1 to 255 complex numbers to add
  */
 export declare function IMSUM(inumber: Scalar[]): Scalar;
 /**
- * @summary Returns the tangent of a complex number
+ * Returns the tangent of a complex number
  * @param inumber is a complex number for which you want the tangent
  */
-export declare function IMTAN(inumber: Scalar): Scalar;
+export declare function IMTAN(inumber: NoLift<Scalar>): Scalar;
 /**
- * @summary Returns the hyperbolic tangent of a complex number.
+ * Returns the hyperbolic tangent of a complex number.
  * @param inumber is a complex number for which you want the hyperbolic tangent.
  * @category Sheets
  */

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

@@ -1,33 +1,107 @@
-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
+import { FormulaError, AcceptError, NoLift, ReportType, Scalar, Volatile, IReferenceRange, IRange, Flatten } from '@sheetxl/primitives';
+/**
+ * The information to return about the cell.
+ */
+declare enum CellInfoType {
+    /** Reference of the first cell in the reference, as text. */
+    Address = "address",
+    /** Column number of the cell in the reference. */
+    Col = "col",
+    /**
+     * 1 if the cell is formatted in color for negative values; otherwise 0.
+     * @deprecated Excel desktop only
+     */
+    Color = "color",
+    /** Value of the upper-left cell in the reference; not a formula. */
+    Contents = "contents",
+    /**
+     * Full path of the file that contains the reference, as text.
+     * @deprecated Excel desktop only
+     */
+    Filename = "filename",
+    /**
+     * Text value corresponding to the number format of the cell.
+     * @deprecated Excel desktop only
+     */
+    Format = "format",
+    /**
+     * 1 if the cell is formatted with parentheses for positive or all values; otherwise 0.
+     * @deprecated Excel desktop only
+     */
+    Parentheses = "parentheses",
+    /**
+     * Text value corresponding to the label prefix of the cell.
+     * @deprecated Excel desktop only
+     */
+    Prefix = "prefix",
+    /**
+     * 0 if the cell is not locked; otherwise 1.
+     * @deprecated Excel desktop only
+     */
+    Protect = "protect",
+    /** Row number of the cell in the reference. */
+    Row = "row",
+    /** "b" for a blank cell, "l" for a text constant, "v" for anything else. */
+    Type = "type",
+    /**
+     * Column width of the cell, rounded to an integer.
+     * @deprecated Excel desktop only
+     */
+    Width = "width"
+}
+/**
+ * Returns information about the cell.
+ * @param infoType The type of information to return.
+ * @param reference The cell to report on. Defaults to the cell holding the formula.
  *
  * @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;
+export declare function CELL(infoType: CellInfoType, reference?: IReferenceRange): Volatile<Scalar>;
 /**
+ * Returns a number matching an error value.
  * @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.
+/** The information to return about the operating environment. */
+declare enum InfoType {
+    /** Path of the current directory or folder. */
+    Directory = "directory",
+    /** Amount of memory available. Legacy: answers #N/A. */
+    MemAvail = "memavail",
+    /** Amount of memory being used for data. Legacy: answers #N/A. */
+    MemUsed = "memused",
+    /** Number of active worksheets in the open workbooks. */
+    NumFile = "numfile",
+    /** Absolute reference of the top and leftmost visible cell. */
+    Origin = "origin",
+    /** Current operating system version, as text. */
+    OSVersion = "osversion",
+    /** Current recalculation mode; "Automatic" or "Manual". */
+    Recalc = "recalc",
+    /** Version of the application, as text. */
+    Release = "release",
+    /** Name of the operating environment; "pcdos" or "mac". */
+    System = "system",
+    /** Total memory available. Legacy: answers #N/A. */
+    TotMem = "totmem",
+    /** The licensed user. Not part of Excel. */
+    User = "user"
+}
+/**
+ * Returns information about the current operating system.
+ * @param typeText The type of information to return.
+ */
+export declare function INFO(typeText: InfoType): Volatile<Scalar>;
+/**
+ * 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.
+ * Returns TRUE if the value is a date.
  * @param value The value to check.
  * @category Sheets
  *
@@ -59,108 +133,103 @@ export declare function ISBLANK(value: AcceptError<Scalar>): boolean;
  */
 export declare function ISDATE(value: Scalar): boolean;
 /**
- * @summary Returns TRUE if the value is a valid email address.
+ * 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.
+ * 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
+ * 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.
+ * 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;
+export declare function ISEVEN(number: NoLift<Scalar>): Scalar;
 /**
- * @summary Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE.
+ * 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;
+export declare function ISFORMULA(reference: ReportType<IReferenceRange>): boolean;
 /**
- * @summary Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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;
+export declare function ISODD(number: NoLift<Scalar>): Scalar;
 /**
- * @summary Checks whether the value is omitted, and returns TRUE or FALSE.
+ * 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;
+export declare function ISOMITTED(argument: AcceptError<any>): boolean;
 /**
- * @summary Returns TRUE if the value is a valid HTTP or HTTPS URL.
+ * 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.
+ * 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.
+ * 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).
+ * 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;
+export declare function N(value: IRange | Scalar): Scalar;
 /**
- * @summary Returns the #N/A error value
+ * Returns the #N/A error value
  */
 export declare function NA(): FormulaError.Known;
-/**.
- * @summary Returns the sheet number of the referenced sheet.
+/**
+ * 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;
+export declare function SHEET(value?: ReportType<IRange>): Scalar;
 /**
- * @summary Returns the number of sheets in a reference.
+ * 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;
+export declare function SHEETS(reference?: ReportType<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.
+ * 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;
+export {};
 //# sourceMappingURL=Information.d.ts.map

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

@@ -1,13 +1,13 @@
 import { Scalar } from '@sheetxl/primitives';
 /**
+ * Converts a standard date code into a localized text string.
  * @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;
 /**
+ * Converts a number into Japanese Kanji words.
  * @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.
  */

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

@@ -1,7 +1,7 @@
 import { Scalar, IReferenceRange } from '@sheetxl/primitives';
 /**
+ * Returns the phonetic spelling of a text string.
  * @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;