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

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

@@ -1,101 +1,101 @@
-import { AcceptError, Scalar } from '@sheetxl/primitives';
+import { AcceptError, Omittable, Scalar, NoLift } from '@sheetxl/primitives';
 /**
- * @summary Converts a binary number to decimal.
+ * Converts a binary number to decimal.
  * @param number is the binary number you want to convert.
  */
-export declare function BIN2DEC(number: Scalar): number;
+export declare function BIN2DEC(number: NoLift<Omittable<Scalar>>): number;
 /**
- * @summary Converts a binary number to hexadecimal.
+ * Converts a binary number to hexadecimal.
  * @param number is the binary number you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function BIN2HEX(number: AcceptError<Scalar>, places?: AcceptError<Scalar>): string;
+export declare function BIN2HEX(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string;
 /**
- * @summary Converts a binary number to octal.
+ * Converts a binary number to octal.
  * @param number is the binary number you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function BIN2OCT(number: AcceptError<Scalar>, places?: AcceptError<Scalar>): string;
+export declare function BIN2OCT(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string;
 /**
- * @summary Returns a bitwise 'And' of two numbers.
+ * Returns a bitwise 'And' of two numbers.
  * @param number1 is the decimal representation of the binary number you want to evaluate.
  * @param number2 is the decimal representation of the binary number you want to evaluate.
  */
-export declare function BITAND(number1: Scalar, number2: Scalar): number;
+export declare function BITAND(number1: AcceptError<Scalar>, number2: AcceptError<Scalar>): number;
 /**
- * @summary Returns a number shifted left by shiftAmount bits.
+ * Returns a number shifted left by shiftAmount bits.
  * @param number is the decimal representation of the binary number you want to evaluate.
  * @param shiftAmount is the number of bits that you want to shift Number left by.
  */
-export declare function BITLSHIFT(number: Scalar, shiftAmount: Scalar): number;
+export declare function BITLSHIFT(number: AcceptError<Scalar>, shiftAmount: AcceptError<Scalar>): number;
 /**
- * @summary Returns a bitwise 'Or' of two numbers.
+ * Returns a bitwise 'Or' of two numbers.
  * @param number1 is the decimal representation of the binary number you want to evaluate.
  * @param number2 is the decimal representation of the binary number you want to evaluate.
  */
-export declare function BITOR(number1: Scalar, number2: Scalar): number;
+export declare function BITOR(number1: AcceptError<Scalar>, number2: AcceptError<Scalar>): number;
 /**
- * @summary Returns a number shifted right by shiftAmount bits.
+ * Returns a number shifted right by shiftAmount bits.
  * @param number is the decimal representation of the binary number you want to evaluate.
  * @param shiftAmount is the number of bits that you want to shift Number left by.
  */
-export declare function BITRSHIFT(number: Scalar, shiftAmount: Scalar): number;
+export declare function BITRSHIFT(number: AcceptError<Scalar>, shiftAmount: AcceptError<Scalar>): number;
 /**
- * @summary Returns a bitwise 'Exclusive Or' of two numbers.
+ * Returns a bitwise 'Exclusive Or' of two numbers.
  * @param number1 is the decimal representation of the binary number you want to evaluate.
  * @param number2 is the decimal representation of the binary number you want to evaluate.
  */
-export declare function BITXOR(number1: Scalar, number2: Scalar): number;
+export declare function BITXOR(number1: AcceptError<Scalar>, number2: AcceptError<Scalar>): number;
 /**
- * @summary Converts a decimal number to binary.
+ * Converts a decimal number to binary.
  * @param number is the decimal integer you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function DEC2BIN(number: AcceptError<Scalar>, places?: AcceptError<Scalar>): string;
+export declare function DEC2BIN(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string;
 /**
- * @summary Converts a decimal number to hexadecimal.
+ * Converts a decimal number to hexadecimal.
  * @param number is the decimal integer you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function DEC2HEX(number: AcceptError<Scalar>, places?: AcceptError<Scalar>): string;
+export declare function DEC2HEX(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string;
 /**
- * @summary Converts a decimal number to octal.
+ * Converts a decimal number to octal.
  * @param number is the decimal integer you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function DEC2OCT(number: AcceptError<Scalar>, places?: AcceptError<Scalar>): string;
+export declare function DEC2OCT(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string;
 /**
- * @summary Converts a Hexadecimal number to binary.
+ * Converts a Hexadecimal number to binary.
  * @param number is the hexadecimal number you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function HEX2BIN(number: AcceptError<string>, places?: AcceptError<Scalar>): string | number;
+export declare function HEX2BIN(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string | number;
 /**
- * @summary Converts a hexadecimal number to decimal.
+ * Converts a hexadecimal number to decimal.
  * @param number is the hexadecimal number you want to convert.
  */
-export declare function HEX2DEC(number: string): number;
+export declare function HEX2DEC(number: NoLift<Omittable<Scalar>>): number;
 /**
- * @summary Converts a hexadecimal number to octal.
+ * Converts a hexadecimal number to octal.
  * @param number is the hexadecimal number you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function HEX2OCT(number: AcceptError<string>, places?: AcceptError<Scalar>): string;
+export declare function HEX2OCT(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string;
 /**
- * @summary Converts an octal number to binary.
+ * Converts an octal number to binary.
  * @param number is the octal number you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function OCT2BIN(number: AcceptError<string>, places?: AcceptError<Scalar>): string;
+export declare function OCT2BIN(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string;
 /**
- * @summary Converts an octal number to decimal.
+ * Converts an octal number to decimal.
  * @param number is the octal number you want to convert.
  */
-export declare function OCT2DEC(number: string): number;
+export declare function OCT2DEC(number: NoLift<Omittable<Scalar>>): number;
 /**
- * @summary Converts an octal number to hexadecimal.
+ * Converts an octal number to hexadecimal.
  * @param number is the octal number you want to convert.
  * @param places is the number of characters to use.
  */
-export declare function OCT2HEX(number: AcceptError<string>, places?: AcceptError<Scalar>): string | number;
+export declare function OCT2HEX(number: NoLift<Omittable<AcceptError<Scalar>>>, places?: NoLift<Omittable<AcceptError<Scalar>>>): string | number;
 //# sourceMappingURL=Bitwise.d.ts.map

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

@@ -1,9 +1,9 @@
-import { Scalar } from '@sheetxl/primitives';
+import { AcceptError, Scalar, NoLift } from '@sheetxl/primitives';
 /**
- * @summary Converts a number from one measurement system to another.
+ * Converts a number from one measurement system to another.
  * @param number is the value in fromUnit to convert.
  * @param fromUnit is the units for number.
  * @param toUnit is the units for the result.
  */
-export declare function CONVERT(number: Scalar, fromUnit: string, toUnit: string): number;
+export declare function CONVERT(number: NoLift<Scalar>, fromUnit: NoLift<AcceptError<Scalar>>, toUnit: NoLift<AcceptError<Scalar>>): number;
 //# sourceMappingURL=Convert.d.ts.map

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

@@ -1,14 +1,14 @@
-import { AcceptError, Scalar } from '@sheetxl/primitives';
+import { AcceptError, Omittable, Scalar, NoLift } from '@sheetxl/primitives';
 /**
- * @summary Tests whether two numbers are equal.
+ * Tests whether two numbers are equal.
  * @param number1 is the first number.
  * @param number2 is the second number.
  */
-export declare function DELTA(number1: AcceptError<Scalar>, number2?: AcceptError<Scalar>): number;
+export declare function DELTA(number1: NoLift<Omittable<AcceptError<Scalar>>>, number2?: NoLift<Omittable<AcceptError<Scalar>>>): number;
 /**
- * @summary Tests whether a number is greater than a threshold value.
+ * Tests whether a number is greater than a threshold value.
  * @param number is the value to test against step.
  * @param step is the threshold value.
  */
-export declare function GESTEP(number: AcceptError<Scalar>, step?: AcceptError<Scalar>): number;
+export declare function GESTEP(number: NoLift<Omittable<AcceptError<Scalar>>>, step?: NoLift<Omittable<AcceptError<Scalar>>>): number;
 //# sourceMappingURL=Engineering.d.ts.map

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

@@ -1,25 +1,25 @@
-import { Scalar } from '@sheetxl/primitives';
+import { AcceptError, Omittable, Scalar, NoLift } from '@sheetxl/primitives';
 /**
- * @summary Returns the error function.
+ * Returns the error function.
  * @param lowerLimit is the lower bound for integrating ERF.
  * @param upperLimit is the upper bound for integrating ERF.
  */
-export declare function ERF(lowerLimit: Scalar, upperLimit?: Scalar): number;
+export declare function ERF(lowerLimit: NoLift<Omittable<AcceptError<Scalar>>>, upperLimit?: NoLift<AcceptError<Scalar>>): number;
 /**
+ * Returns the error function.
  * @name ERF.PRECISE
- * @summary Returns the error function.
  * @param x is the lower bound for integrating ERF.PRECISE.
  */
-export declare function ERF_PRECISE(x: Scalar): number;
+export declare function ERF_PRECISE(x: NoLift<Omittable<Scalar>>): number;
 /**
- * @summary Returns the complementary error function.
+ * Returns the complementary error function.
  * @param x is the lower bound for integrating ERF.
  */
-export declare function ERFC(x: Scalar): number;
+export declare function ERFC(x: NoLift<Omittable<Scalar>>): number;
 /**
+ * Returns the complementary error function.
  * @name ERFC.PRECISE
- * @summary Returns the complementary error function.
  * @param x is the lower bound for integrating ERF.
  */
-export declare function ERFC_PRECISE(x: Scalar): number;
+export declare function ERFC_PRECISE(x: NoLift<Omittable<Scalar>>): number;
 //# sourceMappingURL=Error.d.ts.map

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
  */