@sheetxl/formulas 0.7.28-beta.4 → 0.8.0-beta.2

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

@@ -1,37 +1,37 @@
-import { AcceptError, Scalar, IRange, IReferenceRange, Repeating } from '@sheetxl/primitives';
+import { FormulaError, AcceptError, Scalar, IRange, IReferenceRange, Repeating, ReportType } from '@sheetxl/primitives';
 /**
- * @summary Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names, arrays, or references that contain numbers.
+ * Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names, arrays, or references that contain numbers.
  * @param number are 1 to 255 arguments for which you want the average of the absolute deviations.
  */
 export declare function AVEDEV(number: IRange<number>[]): number;
 /**
- * @summary Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers.
+ * Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers.
  * @param number are 1 to 255 numeric arguments for which you want the average.
  */
 export declare function AVERAGE(number: IRange<number>[]): number;
 /**
- * @summary Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be numbers, names, arrays, or references.
+ * Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be numbers, names, arrays, or references.
  * @param value are 1 to 255 arguments for which you want the average.
  */
 export declare function AVERAGEA(value: IRange<number>[]): number;
 /**
- * @summary Finds average(arithmetic mean) for the cells specified by a given condition or criteria.
+ * Finds average(arithmetic mean) for 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 used to find the average.
  * @param averageRange are the actual cells to be used to find the average. If omitted, the cells in range are used.
  */
-export declare function AVERAGEIF(range: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>, averageRange?: AcceptError<IReferenceRange>): Scalar;
+export declare function AVERAGEIF(range: IReferenceRange, criteria: AcceptError<Scalar>, averageRange?: IReferenceRange): Scalar;
 /**
- * @summary Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.
+ * Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.
  * @param averageRange are the actual cells to be used to find the average.
  * @param criteria the ranges to evaluate and the conditions to evaluate them against.
  * @param criteria.criteriaRange is the range of cells you want evaluated for the particular condition.
  * @param criteria.criteria is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average.
  */
-export declare function AVERAGEIFS(averageRange: AcceptError<IRange>, criteria: Repeating<[criteriaRange: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>]>): Scalar;
+export declare function AVERAGEIFS(averageRange: IReferenceRange, criteria: Repeating<[criteriaRange: IReferenceRange, criteria: AcceptError<Scalar>]>): Scalar;
 /**
+ * Finds the weighted average of a set of values, given the values and the corresponding weights.
  * @name AVERAGE.WEIGHTED
- * @summary Finds the weighted average of a set of values, given the values and the corresponding weights.
  * @param values the values to average and the weights to apply to them.
  * @param values.values are the values to be averaged.
  * @param values.weights are the corresponding weights to apply. A weight may be zero but not negative.
@@ -39,66 +39,66 @@ export declare function AVERAGEIFS(averageRange: AcceptError<IRange>, criteria:
  */
 export declare function AVERAGE_WEIGHTED(values: Repeating<[values: IRange, weights: IRange]>): number;
 /**
- * @summary Counts the number of cells in a range that contain numbers.
+ * Counts the number of cells in a range that contain numbers.
  * @param number are 1 to 255 arguments that can contain or refer to a variety of different types of data, but only numbers are counted.
  */
 export declare function COUNT(number: AcceptError<IRange<number>>[]): number;
 /**
- * @summary Counts the number of cells in a range that are not empty.
+ * Counts the number of cells in a range that are not empty.
  * @param value are 1 to 255 arguments representing the values and cells you want to count. Values can be any type of information.
  */
 export declare function COUNTA(value: AcceptError<IRange<number>>[]): number;
 /**
- * @summary Counts the number of empty cells in a specified range of cells.
+ * Counts the number of empty cells in a specified range of cells.
  * @param range is the range from which you want to count the empty cells.
  */
-export declare function COUNTBLANK(range: AcceptError<IRange>): number;
+export declare function COUNTBLANK(range: IReferenceRange): number | FormulaError.Known;
 /**
- * @summary Counts the number of cells within a range that meet the given condition.
+ * Counts the number of cells within a range that meet the given condition.
  * @param range is the range of cells from which you want to count nonblank cells.
  * @param criteria is the condition in the form of a number, expression, or text that defines which cells will be counted.
  */
-export declare function COUNTIF(range: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>): Scalar;
+export declare function COUNTIF(range: IReferenceRange, criteria: AcceptError<Scalar>): Scalar;
 /**
- * @summary Counts the number of cells specified by a given set of conditions or criteria.
+ * Counts the number of cells specified by a given set of conditions or criteria.
  * @param criteria the ranges to evaluate and the conditions to evaluate them against.
  * @param criteria.criteriaRange is the range of cells you want evaluated for the particular condition.
  * @param criteria.criteria is the condition in the form of a number, expression, or text that defines which cells will be counted.
  */
-export declare function COUNTIFS(criteria: Repeating<[criteriaRange: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>]>): Scalar;
+export declare function COUNTIFS(criteria: Repeating<[criteriaRange: IReferenceRange, criteria: AcceptError<Scalar>]>): Scalar;
 /**
- * @summary Counts the number of unique values in a list of specified values and ranges.
+ * Counts the number of unique values in a list of specified values and ranges.
  * @param value are the values or ranges to consider for uniqueness.
  * @category Sheets
  */
 export declare function COUNTUNIQUE(value: AcceptError<IRange>[]): number;
 /**
- * @summary Counts the number of unique values in a range of cells, filtered by a set of criteria.
+ * Counts the number of unique values in a range of cells, filtered by a set of criteria.
  * @param countUniqueRange is the range from which the unique values will be counted.
  * @param criteria the ranges to evaluate and the conditions to evaluate them against.
  * @param criteria.criteriaRange is the range of cells you want evaluated for the particular condition.
  * @param criteria.criteria is the condition in the form of a number, expression, or text that defines which cells will be counted.
  * @category Sheets
  */
-export declare function COUNTUNIQUEIFS(countUniqueRange: AcceptError<IRange>, criteria: Repeating<[criteriaRange: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>]>): number;
+export declare function COUNTUNIQUEIFS(countUniqueRange: IRange, criteria: Repeating<[criteriaRange: IReferenceRange, criteria: AcceptError<Scalar>]>): number;
 /**
- * @summary Returns the k-th largest value in a data set. For example, the fifth largest number.
+ * Returns the k-th largest value in a data set. For example, the fifth largest number.
  * @param array is the array or range of data for which you want to determine the k-th largest value.
  * @param k is the position (from the largest) in the array or cell range of the value to return.
  */
-export declare function LARGE(array: IRange<number>, k: number): number;
+export declare function LARGE(array: ReportType<IRange<number>>, k: number): number;
 /**
- * @summary Returns the largest value in a set of values. Ignores logical values and text.
+ * Returns the largest value in a set of values. Ignores logical values and text.
  * @param number are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum.
  */
 export declare function MAX(number: IRange<number>[]): number;
 /**
- * @summary Returns the largest value in a set of values. Does not ignore logical values and text.
+ * Returns the largest value in a set of values. Does not ignore logical values and text.
  * @param value are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum.
  */
 export declare function MAXA(value: IRange<number>[]): number;
 /**
- * @summary Returns the maximum value for the cells within a range that meet the given condition.
+ * Returns the maximum value for the cells within a range that meet the given condition.
  * @param range is the range of cells from which you want to find the maximum nonblank cells.
  * @param criteria is the condition in the form of a number, expression, or text that defines which cells will be counted.
  * @param maxRange are the actual cells to be used to find the maximum. If omitted, the cells in range are used.
@@ -106,30 +106,30 @@ export declare function MAXA(value: IRange<number>[]): number;
  */
 export declare function MAXIF(range: IReferenceRange, criteria: Scalar, maxRange?: IReferenceRange): Scalar;
 /**
- * @summary Returns the maximum value among cells specified by a given set of conditions or criteria.
+ * Returns the maximum value among cells specified by a given set of conditions or criteria.
  * @param maxRange the cells in which to determine the maximum value.
  * @param criteria the ranges to evaluate and the conditions to evaluate them against.
  * @param criteria.criteriaRange is the range of cells you want to evaluate for the particular condition.
  * @param criteria.criteria is the condition or criteria in the form of a number, expression, or text that defines which cells will be included when determining the maximum value.
  */
-export declare function MAXIFS(maxRange: AcceptError<IRange>, criteria: Repeating<[criteriaRange: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>]>): Scalar;
+export declare function MAXIFS(maxRange: IReferenceRange, criteria: Repeating<[criteriaRange: IReferenceRange, criteria: AcceptError<Scalar>], 254>): Scalar;
 /**
- * @summary Returns the median, or the number in the middle of the set of given numbers.
+ * Returns the median, or the number in the middle of the set of given numbers.
  * @param number are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the median.
  */
 export declare function MEDIAN(number: IRange<number>[]): number;
 /**
- * @summary Returns the smallest number in a set of values. Ignores logical values and text.
+ * Returns the smallest number in a set of values. Ignores logical values and text.
  * @param number are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum.
  */
 export declare function MIN(number: IRange<number>[]): number;
 /**
- * @summary Returns the smallest value in a set of values. Does not ignore logical values and text.
+ * Returns the smallest value in a set of values. Does not ignore logical values and text.
  * @param value are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum.
  */
 export declare function MINA(value: IRange<number>[]): number;
 /**
- * @summary Returns the minimum value for the cells within a range that meet the given condition.
+ * Returns the minimum value for the cells within a range that meet the given condition.
  * @param range is the range of cells from which you want to count nonblank cells.
  * @param criteria is the condition in the form of a number, expression, or text that defines which cells will be counted.
  * @param minRange are the actual cells to be used to find the minimum. If omitted, the cells in range are used.
@@ -137,29 +137,29 @@ export declare function MINA(value: IRange<number>[]): number;
  */
 export declare function MINIF(range: IReferenceRange, criteria: Scalar, minRange?: IReferenceRange): Scalar;
 /**
- * @summary Returns the minimum value among cells specified by a given set of conditions or criteria.
+ * Returns the minimum value among cells specified by a given set of conditions or criteria.
  * @param minRange is the range of cells to evaluate for the minimum value.
  * @param criteria the ranges to evaluate and the conditions to evaluate them against.
  * @param criteria.criteriaRange is the range of cells to evaluate against the criteria.
  * @param criteria.criteria is the criteria to evaluate against the criteria range.
  */
-export declare function MINIFS(minRange: AcceptError<IRange>, criteria: Repeating<[criteriaRange: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>]>): Scalar;
+export declare function MINIFS(minRange: IReferenceRange, criteria: Repeating<[criteriaRange: IReferenceRange, criteria: AcceptError<Scalar>], 254>): Scalar;
 /**
- * @summary Returns the number of permutations for a given number of objects that can be selected from the total objects.
+ * Returns the number of permutations for a given number of objects that can be selected from the total objects.
  * @param number is the total number of objects.
  * @param numberChoosen is the number of objects in each permutation.
  */
 export declare function PERMUT(number: number, numberChoosen: number): number;
 /**
- * @summary Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.
+ * Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.
  * @param number is the total number of objects.
  * @param numberChoosen is the number of objects in each permutation.
  */
 export declare function PERMUTATIONA(number: number, numberChoosen: number): number;
 /**
- * @summary Returns the k-th smallest value in a data set. For example, the fifth smallest number.
+ * Returns the k-th smallest value in a data set. For example, the fifth smallest number.
  * @param array is an array or range of numerical data for which you want to determine the k-th smallest value.
  * @param k is the position (from the smallest) in the array or range of the value to return.
  */
-export declare function SMALL(array: IRange<number>, k: number): number;
+export declare function SMALL(array: ReportType<IRange<number>>, k: number): number;
 //# sourceMappingURL=Statistical.d.ts.map

package/types/src/testing/Testing.d.ts

@@ -1,7 +1,7 @@
 import { Scalar, IRange } from '@sheetxl/primitives';
 /**
+ * Returns the input value after a delay.
  * @hidden Testing
- * @summary Returns the input value after a delay.
  * @param time the delay time in milliseconds. Default is 1000ms (1 second).
  * @param input returns the input.
  * @param label optional label for the delay function.
@@ -12,8 +12,8 @@ declare global {
     var debugEventTarget: EventTarget | undefined;
 }
 /**
+ * Starts waiting for event
  * @hidden Testing
- * @summary Starts waiting for event
  * @param type the type of message.
  * @param input an optional dependency.
  *