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

package/types/src/_utils/SpecialFunctions.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Log-gamma. Lanczos with `g = 671/128` and fourteen coefficients.
+ *
+ * The six-coefficient form this was seeded with holds about ten digits, and every function here
+ * reads its answer through an `exp`, so those ten were the ceiling under the whole distribution
+ * library — `ibetainv` cannot find a root more accurately than the `ibeta` it is inverting.
+ */
+export declare function gammaln(x: number): number;
+/** Gamma, by the rational approximation — `Infinity` past the double's last representable value. */
+export declare function gammafn(x: number): number;
+/** The beta function. */
+export declare function betafn(x: number, y: number): number | undefined;
+/** The argument above which {@link stirlerr}'s series is good to the last bit. */
+export declare const StirlingFloor = 30;
+/**
+ * `ln B(x, y)`.
+ *
+ * `ln G(x) + ln G(y) - ln G(x + y)` is a difference of large numbers whenever either argument is
+ * large, and the answer is not large — the loss is total enough to be the whole story behind the
+ * F and t families' five-digit plateau at a degrees of freedom of 1E10. Above
+ * {@link StirlingFloor} the larger argument is folded into {@link lgammaDelta} instead, which
+ * never forms it. Below it the expression is the original one, so nothing else changes.
+ */
+export declare const betaln: (x: number, y: number) => number;
+/** The error function, by Chebyshev approximation. */
+export declare const erf: (x: number) => number;
+/** The complementary error function. */
+export declare const erfc: (x: number) => number;
+/** The inverse of {@link erfc}. */
+export declare function erfcinv(p: number): number;
+/**
+ * The lower regularized incomplete gamma, `P(a, x)`.
+ *
+ * The iteration count is a formula rather than a convergence test — both branches simply run
+ * `ITMAX` times. The cap is sized from the shape, so both also stop as soon as the accumulator
+ * has stopped moving; without that a large shape walks the cap one term at a time for no gain
+ * (a shape of 1e9 takes ten seconds).
+ *
+ * Past {@link TemmeShape} neither branch is asked at all — see {@link temmeQ}.
+ */
+export declare const lowRegGamma: (a: number, x: number) => number;
+/**
+ * `Q(a, x) = 1 - P(a, x)`, on the branch that does not cancel.
+ *
+ * The continued fraction computes `Q` and the series computes `P`, so spelling either one as
+ * `1 -` the other throws the smaller of the two away — for a far tail that is the entire answer.
+ */
+export declare const upRegGamma: (a: number, x: number) => number;
+/**
+ * `ln` of the `Gamma(a, 1)` density at `x`, written so that nothing in it cancels.
+ *
+ * The direct spelling `(a-1) ln x - x - ln G(a)` is a sum of terms the size of `a ln a` — 1.6E8
+ * at a shape of 1E7 — that has to come out near zero, so it holds seven digits there whatever
+ * `ln G` is asked. Folding Stirling's form for `ln G(a)` in symbolically leaves
+ *
+ * ```
+ *   -a (u - ln(1+u)) - ln(1+u) - ln(a)/2 - ln(2 pi)/2 - stirlerr(a),   u = x/a - 1
+ * ```
+ *
+ * whose every term is the size of the answer. It is Excel's form: `GAMMA.DIST(1E7,1E7,1,FALSE)`
+ * is exactly the value this returns.
+ */
+export declare function gammaLogPdf(a: number, x: number): number;
+/** The inverse of {@link lowRegGamma} in its second argument. */
+export declare function gammapinv(p: number, a: number): number;
+/**
+ * The continued fraction of the incomplete beta, by modified Lentz's method.
+ *
+ * The stop is an ulp of the ratio. The single-precision `3e-7` it was seeded with put a floor
+ * under every F and t answer at about seven digits — visible wherever a body asked for eight.
+ */
+export declare function betacf(x: number, a: number, b: number): number;
+/**
+ * The regularized incomplete beta, `I_x(a, b)`.
+ *
+ * The front factor goes through {@link betaln}, which does not cancel at a large argument.
+ */
+export declare const ibeta: (x: number, a: number, b: number) => number;
+/**
+ * `I_x(a, b)` where the caller supplies `1 - x` as well as `x`.
+ *
+ * A caller that has both in closed form has a far better `1 - x` than the subtraction does: an
+ * `x` of `dof/(dof + t^2)` is `1 - 2.25E-10` at a degrees of freedom of 1E10, and recovering
+ * that complement by subtracting leaves six of its digits, which is the whole answer on this
+ * branch. {@link ibeta} passes the subtraction, which is all there is to pass when `x` is what
+ * the caller was given.
+ */
+export declare function ibetaAt(x: number, cx: number, a: number, b: number): number;
+/** The inverse of {@link ibeta} in its first argument. */
+export declare function ibetainv(p: number, a: number, b: number): number;
+//# sourceMappingURL=SpecialFunctions.d.ts.map

package/types/src/_utils/X87.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Excel's circular trigonometry, which is not the platform library's.
+ *
+ * Excel's `SIN` `COS` `TAN` disagree with a correctly-rounded library in the FOURTH significant
+ * digit near a multiple of pi/2 — `SIN(PI())` is 1.22514845490862E-16 where the true sine of the
+ * double `PI()` is 1.2246467991473532E-16 — because Excel reduces the argument against pi
+ * ROUNDED TO A 64-BIT SIGNIFICAND (the x87 80-bit extended constant) rather than against pi. The
+ * difference is a constant, not noise to be tolerated at 15 digits.
+ *
+ * The reduction has to be carried at more than double precision: `k` reaches 2^27/(pi/2), about
+ * 8.5E7, so `k * PI_HI/2` needs the exact product rather than the rounded one. That is what the
+ * double-double helpers below are for. The answer is re-evaluated from the reduced argument
+ * rather than perturbed from the library's: perturbing keeps the ordinary arguments exact and
+ * loses the reduced ones.
+ */
+/** `|x|` at or above which Excel refuses a circular trig argument outright. */
+export declare const MAX_TRIG_ARGUMENT: number;
+/** Excel's sine. The caller owns the {@link MAX_TRIG_ARGUMENT} refusal. */
+export declare function x87Sin(x: number): number;
+/** Excel's cosine. The caller owns the {@link MAX_TRIG_ARGUMENT} refusal. */
+export declare function x87Cos(x: number): number;
+/**
+ * Excel's tangent, which is the quotient of the two above and not a function of its own.
+ * `TAN(x)` is exactly `SIN(x)/COS(x)` everywhere, including at the poles, where the quotient is
+ * what produces the large finite answer (`TAN(PI()/2)` is 1.6324552277619072E16).
+ */
+export declare const x87Tan: (x: number) => number;
+//# sourceMappingURL=X87.d.ts.map

package/types/src/database/Database.d.ts

@@ -1,86 +1,86 @@
-import { AcceptError, AcceptRefError, Scalar, IRange, IReferenceRange } from '@sheetxl/primitives';
+import { AcceptError, NoLift, Omittable, Scalar, IRange, IReferenceRange } from '@sheetxl/primitives';
 /**
- * @summary Averages the values in a column in a list or database that match conditions you specify.
+ * Averages the values in a column in a list or database that match conditions you specify.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DAVERAGE(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DAVERAGE(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify.
+ * Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DCOUNT(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DCOUNT(database: AcceptError<IReferenceRange>, field: NoLift<Omittable<AcceptError<Scalar>>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Counts nonblank cells in the field (column) of records in the database that match the conditions you specify.
+ * Counts nonblank cells in the field (column) of records in the database that match the conditions you specify.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DCOUNTA(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DCOUNTA(database: AcceptError<IReferenceRange>, field: NoLift<Omittable<AcceptError<Scalar>>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Extracts from a database a single record that matches the conditions you specify.
+ * Extracts from a database a single record that matches the conditions you specify.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DGET(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DGET(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Returns the largest number in the field (column) of records in the database that match the conditions you specify.
+ * Returns the largest number in the field (column) of records in the database that match the conditions you specify.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DMAX(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DMAX(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Returns the smallest number in the field (column) of records in the database that match the conditions you specify.
+ * Returns the smallest number in the field (column) of records in the database that match the conditions you specify.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DMIN(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DMIN(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Multiplies the values in the field (column) of records in the database that match the conditions you specify.
+ * Multiplies the values in the field (column) of records in the database that match the conditions you specify.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DPRODUCT(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DPRODUCT(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Estimates the standard deviation based on a sample from selected database entries.
+ * Estimates the standard deviation based on a sample from selected database entries.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DSTDEV(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DSTDEV(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Calculates the standard deviation based on the entire population of selected database entries.
+ * Calculates the standard deviation based on the entire population of selected database entries.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DSTDEVP(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DSTDEVP(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Adds the numbers in the field (column) of records in the database that match the conditions you specify.
+ * Adds the numbers in the field (column) of records in the database that match the conditions you specify.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DSUM(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DSUM(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Estimates variance based on a sample from selected database entries.
+ * Estimates variance based on a sample from selected database entries.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DVAR(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DVAR(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 /**
- * @summary Calculates variance based on the entire population of selected database entries.
+ * Calculates variance based on the entire population of selected database entries.
  * @param database is the range of cells that makes up the list or database. A database is a list of related data.
  * @param field is either the label of the column in double quotation marks or a number that represents the column's position in the list.
  * @param criteria is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.
  */
-export declare function DVARP(database: AcceptError<IReferenceRange>, field: AcceptRefError<Scalar>, criteria: AcceptRefError<IRange>): Scalar;
+export declare function DVARP(database: AcceptError<IReferenceRange>, field: NoLift<AcceptError<Scalar>>, criteria: AcceptError<IRange>): Scalar;
 //# sourceMappingURL=Database.d.ts.map

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

@@ -1,139 +1,348 @@
-import { AcceptError, Scalar, Flatten, Omittable } from '@sheetxl/primitives';
+import { AcceptError, Scalar, Volatile, Flatten, Omittable, NoLift, ReportType } from '@sheetxl/primitives';
 /**
- * @summary Returns the number that represents the date in date-time code.
+ * Returns the number that represents the date in date-time code.
  * @param year is a number from 1900 or 1904 (depending on the workbook's date system) to 9999.
  * @param month is a number from 1 to 12 representing the month of the year.
  * @param day is a number from 1 to 31 representing the day of the month.
  */
 export declare function DATE(year: number, month: number, day: number): number;
 /**
- * @summary Converts a date in the form of text to a number that represents the date as a date-time code.
+ * Converts a date in the form of text to a number that represents the date as a date-time code.
  * @param dateText is text that represents a date in date format, between 1/1/1900 or 1/1/1904 (depending on the workbook's date system) and 12/31/9999.
  */
 export declare function DATEVALUE(dateText: string): number;
 /**
- * @summary Returns the day of the month, a number from 1 to 31.
+ * Returns the day of the month, a number from 1 to 31.
  * @param serialNumber is a number in the date-time code or text in time format, such as 16:48:00 or 4:48:00 PM.
  */
 export declare function DAY(serialNumber: number): number;
 /**
- * @summary Returns the number of days between the two dates.
+ * Returns the number of days between the two dates.
  * @param endDate startDate and endDate are the two dates between which you want to know the number of days.
  * @param startDate startDate and endDate are the two dates between which you want to know the number of days.
  */
-export declare function DAYS(endDate: number, // date
-startDate: number): number;
+export declare function DAYS(endDate: Scalar, // date
+startDate: Scalar): number;
 /**
- * @summary Returns the serial number of the date that is the indicated number of months before or after the start date.
+ * Returns the serial number of the date that is the indicated number of months before or after the start date.
  * @param startDate is a serial date number that represents the start date.
  * @param months is the number of months before or after startDate.
+ * @remarks
+ * The ATP refusal: `EDATE(A1:A3,1)` is `#VALUE!` — a multi-cell reference does not broadcast at
+ * an `any` slot — while an ARRAY constant still lifts. Shared with `EOMONTH` and `WEEKNUM`; the
+ * native `DAY`/`WEEKDAY`/`DAYS` of the same category all spill.
  */
-export declare function EDATE(startDate: Scalar, months: Scalar): number;
+export declare function EDATE(startDate: NoLift<Omittable<Scalar>>, months: NoLift<Omittable<Scalar>>): number;
 /**
- * @summary Returns the serial number of the last day of the month before or after a specified number of months.
+ * Returns the serial number of the last day of the month before or after a specified number of months.
  * @param startDate is a serial date number that represents the start date.
  * @param months is the number of months before or after the startDate.
  */
-export declare function EOMONTH(startDate: Scalar, months: Scalar): number;
+export declare function EOMONTH(startDate: NoLift<Omittable<Scalar>>, months: NoLift<Omittable<Scalar>>): number;
 /**
- * @summary Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.).
+ * Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.).
  * @param serialNumber is a number in the date-time code or text in time format, such as 16:48:00 or 4:48:00 PM.
  */
 export declare function HOUR(serialNumber: number): number;
 /**
- * @summary Returns the ISO week number in the year for a given date.
+ * Returns the ISO week number in the year for a given date.
  * @param date is a number in the date-time code or text in time format, such as 16:48:00 or 4:48:00 PM.
  */
 export declare function ISOWEEKNUM(date: number): number;
 /**
- * @summary Returns the minute, a number from 0 to 59.
+ * Returns the minute, a number from 0 to 59.
  * @param serialNumber is a number in the date-time code or text in time format, such as 16:48:00 or 4:48:00 PM.
  */
 export declare function MINUTE(serialNumber: number): number;
 /**
- * @summary Returns the month, a number from 1 (January) to 12 (December).
+ * Returns the month, a number from 1 (January) to 12 (December).
  * @param serialNumber is a number in the date-time code or text in date format.
  */
 export declare function MONTH(serialNumber: number): number;
 /**
- * @summary Returns the number of whole workdays between two dates.
+ * Returns the number of whole workdays between two dates.
  * @param startDate is a serial date number that represents the start date.
  * @param endDate is a serial date number that represents the end date.
  * @param holidays is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.
  */
-export declare function NETWORKDAYS(startDate: number, // date
-endDate: number, // date
-holidays?: Omittable<Flatten<Scalar>>): number;
+export declare function NETWORKDAYS(startDate: NoLift<Omittable<AcceptError<Scalar>>>, // date
+endDate: NoLift<Omittable<AcceptError<Scalar>>>, // date
+holidays?: Omittable<Flatten<AcceptError<Scalar>>>): number;
 /**
+ * The days a weekend falls on, for NETWORKDAYS.INTL and WORKDAY.INTL.
+ *
+ * @remarks
+ * Documents the codes only: the slot is `Weekend | Scalar`, because a seven-character mask
+ * (`"0000011"`, Monday first) is just as legal and the body reads either itself. No gate.
+ */
+declare enum Weekend {
+    /**
+     * The weekend is Saturday and Sunday.
+     * @name Saturday, Sunday
+     */
+    SaturdaySunday = 1,
+    /**
+     * The weekend is Sunday and Monday.
+     * @name Sunday, Monday
+     */
+    SundayMonday = 2,
+    /**
+     * The weekend is Monday and Tuesday.
+     * @name Monday, Tuesday
+     */
+    MondayTuesday = 3,
+    /**
+     * The weekend is Tuesday and Wednesday.
+     * @name Tuesday, Wednesday
+     */
+    TuesdayWednesday = 4,
+    /**
+     * The weekend is Wednesday and Thursday.
+     * @name Wednesday, Thursday
+     */
+    WednesdayThursday = 5,
+    /**
+     * The weekend is Thursday and Friday.
+     * @name Thursday, Friday
+     */
+    ThursdayFriday = 6,
+    /**
+     * The weekend is Friday and Saturday.
+     * @name Friday, Saturday
+     */
+    FridaySaturday = 7,
+    /**
+     * The weekend is Sunday alone.
+     * @name Sunday only
+     */
+    SundayOnly = 11,
+    /**
+     * The weekend is Monday alone.
+     * @name Monday only
+     */
+    MondayOnly = 12,
+    /**
+     * The weekend is Tuesday alone.
+     * @name Tuesday only
+     */
+    TuesdayOnly = 13,
+    /**
+     * The weekend is Wednesday alone.
+     * @name Wednesday only
+     */
+    WednesdayOnly = 14,
+    /**
+     * The weekend is Thursday alone.
+     * @name Thursday only
+     */
+    ThursdayOnly = 15,
+    /**
+     * The weekend is Friday alone.
+     * @name Friday only
+     */
+    FridayOnly = 16,
+    /**
+     * The weekend is Saturday alone.
+     * @name Saturday only
+     */
+    SaturdayOnly = 17
+}
+/**
+ * Returns the number of whole workdays between two dates with custom weekend parameters.
  * @name NETWORKDAYS.INTL
- * @summary Returns the number of whole workdays between two dates with custom weekend parameters.
  * @param startDate is a serial date number that represents the start date.
  * @param endDate is a serial date number that represents the end date.
  * @param weekend is a number or string specifying when weekends occur.
  * @param holidays is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.
  */
-export declare function NETWORKDAYS_INTL(startDate: number, // date
-endDate: number, // date
-weekend?: Omittable<AcceptError<Scalar>>, holidays?: Omittable<Flatten<Scalar>>): number;
+export declare function NETWORKDAYS_INTL(startDate: NoLift<Omittable<AcceptError<Scalar>>>, // date
+endDate: NoLift<Omittable<AcceptError<Scalar>>>, // date
+weekend?: Omittable<AcceptError<Weekend | Scalar>>, holidays?: Omittable<Flatten<AcceptError<Scalar>>>): number;
 /**
- * @summary Returns the current date and time formatted as a date and time.
+ * Returns the current date and time formatted as a date and time.
  */
-export declare function NOW(): number;
+export declare function NOW(): Volatile<number>;
 /**
- * @summary Returns the second, a number from 0 to 59.
+ * Returns the second, a number from 0 to 59.
  * @param serialNumber is a number in the date-time code or text in time format, such as 16:48:23 or 4:48:47 PM.
  */
 export declare function SECOND(serialNumber: number): number;
 /**
- * @summary Converts hours, minutes, and seconds given as numbers to a date code, formatted with a time format.
+ * Converts hours, minutes, and seconds given as numbers to a date code, formatted with a time format.
  * @param hour is a number from 0 to 23 representing the hour.
  * @param minute is a number from 0 to 59 representing the minute.
  * @param second is a number from 0 to 59 representing the second.
  */
 export declare function TIME(hour: number, minute: number, second: number): number;
 /**
- * @summary Converts a text time to a date code for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula.
+ * Converts a text time to a date code for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula.
  * @param timeText is a text string that gives a time in any one of the time formats (date information in the string is ignored).
  */
 export declare function TIMEVALUE(timeText: string): number;
 /**
- * @summary Returns the current date formatted as a date.
+ * Returns the current date formatted as a date.
+ */
+export declare function TODAY(): Volatile<number>;
+/**
+ * How WEEKDAY numbers the days of the week.
+ *
+ * @remarks
+ * Declared `ReportType`, as every numeric built-in enum is: Excel TRUNCATES this argument (`2.9`
+ * is 2) and answers #NUM! outside the set, which an enum's gate does not, so the body keeps the
+ * verdict. Members that mean the same thing share Excel's label (2 and 11, 1 and 17), and so share
+ * one descriptor entry.
  */
-export declare function TODAY(): number;
+declare enum WeekdayType {
+    /**
+     * Sunday is 1 and Saturday is 7.
+     * @name Sunday (1) through Saturday (7)
+     */
+    SundayFirst = 1,
+    /**
+     * Monday is 1 and Sunday is 7.
+     * @name Monday (1) through Sunday (7)
+     */
+    MondayFirst = 2,
+    /**
+     * Monday is 0 and Sunday is 6.
+     * @name Monday (0) through Sunday (6)
+     */
+    MondayZero = 3,
+    /**
+     * Monday is 1 and Sunday is 7.
+     * @name Monday (1) through Sunday (7)
+     */
+    MondayOne = 11,
+    /**
+     * Tuesday is 1 and Monday is 7.
+     * @name Tuesday (1) through Monday (7)
+     */
+    TuesdayOne = 12,
+    /**
+     * Wednesday is 1 and Tuesday is 7.
+     * @name Wednesday (1) through Tuesday (7)
+     */
+    WednesdayOne = 13,
+    /**
+     * Thursday is 1 and Wednesday is 7.
+     * @name Thursday (1) through Wednesday (7)
+     */
+    ThursdayOne = 14,
+    /**
+     * Friday is 1 and Thursday is 7.
+     * @name Friday (1) through Thursday (7)
+     */
+    FridayOne = 15,
+    /**
+     * Saturday is 1 and Friday is 7.
+     * @name Saturday (1) through Friday (7)
+     */
+    SaturdayOne = 16,
+    /**
+     * Sunday is 1 and Saturday is 7.
+     * @name Sunday (1) through Saturday (7)
+     */
+    SundayOne = 17
+}
 /**
- * @summary Returns a number from 1 to 7 identifying the day of the week of a date.
+ * Returns a number from 1 to 7 identifying the day of the week of a date.
  * @param serialNumber is a number that represents a date.
  * @param returnType is a number: for Sunday=1 through Saturday=7, use 1; for Monday=1 through Sunday=7, use 2; for Monday=0 through Sunday=6, use 3.
  */
 export declare function WEEKDAY(serialNumber: number, // date
-returnType?: number): number;
+returnType?: ReportType<WeekdayType>): number;
+/**
+ * The day a week begins on, for WEEKNUM.
+ *
+ * @remarks
+ * Documents the values only: the slot is `WeekNumType | Scalar`, because the body reads the raw
+ * argument itself (ATP coercion) — truncating, and answering #NUM! outside the set. No gate.
+ * Members that mean the same thing share a label (2 and 11, 1 and 17).
+ */
+declare enum WeekNumType {
+    /**
+     * Weeks begin on Sunday; week 1 is the week containing January 1.
+     * @name Week begins on Sunday
+     */
+    Sunday = 1,
+    /**
+     * Weeks begin on Monday; week 1 is the week containing January 1.
+     * @name Week begins on Monday
+     */
+    Monday = 2,
+    /**
+     * Weeks begin on Monday; week 1 is the week containing January 1.
+     * @name Week begins on Monday
+     */
+    MondayStart = 11,
+    /**
+     * Weeks begin on Tuesday; week 1 is the week containing January 1.
+     * @name Week begins on Tuesday
+     */
+    TuesdayStart = 12,
+    /**
+     * Weeks begin on Wednesday; week 1 is the week containing January 1.
+     * @name Week begins on Wednesday
+     */
+    WednesdayStart = 13,
+    /**
+     * Weeks begin on Thursday; week 1 is the week containing January 1.
+     * @name Week begins on Thursday
+     */
+    ThursdayStart = 14,
+    /**
+     * Weeks begin on Friday; week 1 is the week containing January 1.
+     * @name Week begins on Friday
+     */
+    FridayStart = 15,
+    /**
+     * Weeks begin on Saturday; week 1 is the week containing January 1.
+     * @name Week begins on Saturday
+     */
+    SaturdayStart = 16,
+    /**
+     * Weeks begin on Sunday; week 1 is the week containing January 1.
+     * @name Week begins on Sunday
+     */
+    SundayStart = 17,
+    /**
+     * Weeks begin on Monday; week 1 is the week containing the first Thursday of the year.
+     * @name Week begins on Monday (ISO 8601)
+     */
+    Iso = 21
+}
 /**
- * @summary Returns the week number in the year.
+ * Returns the week number in the year.
  * @param serialNumber is the date-time code used for date and time calculation.
  * @param returnType is a number (1 or 2) that determines the type of the return value.
+ * @remarks
+ * The ATP refusal is WEEKNUM's alone in this category: `WEEKNUM(A1:A3,1)` is `#VALUE!` while
+ * `ISOWEEKNUM(A1:A3)`, `WEEKDAY(A1:A3,1)` and `DAYS(A1:A3,x)` all spill, and an ARRAY constant
+ * still lifts here (`WEEKNUM({43496;43497},1)` spills two).
  */
-export declare function WEEKNUM(serialNumber: Omittable<Scalar>, returnType?: Omittable<Scalar>): number;
+export declare function WEEKNUM(serialNumber: NoLift<Omittable<Scalar>>, returnType?: NoLift<Omittable<WeekNumType | Scalar>>): number;
 /**
- * @summary Returns the serial number of the date before or after a specified number of workdays.
+ * Returns the serial number of the date before or after a specified number of workdays.
  * @param startDate is a serial date number that represents the start date.
  * @param days is the number of nonweekend and non-holiday days before or after startDate.
  * @param holidays is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.
  */
-export declare function WORKDAY(startDate: number, // date
-days: number, holidays?: Omittable<Flatten<Scalar>>): number;
+export declare function WORKDAY(startDate: NoLift<Omittable<Scalar>>, // date
+days: NoLift<Omittable<Scalar>>, holidays?: Omittable<Flatten<Scalar>>): number;
 /**
+ * Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters.
  * @name WORKDAY.INTL
- * @summary Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters.
  * @param startDate is a serial date number that represents the start date.
  * @param days is the number of nonweekend and non-holiday days before or after startDate.
  * @param weekend is a number or string specifying when weekends occur.
  * @param holidays is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.
  */
-export declare function WORKDAY_INTL(startDate: number, // date
-days: number, weekend?: Omittable<AcceptError<Scalar>>, holidays?: Omittable<Flatten<Scalar>>): number;
+export declare function WORKDAY_INTL(startDate: NoLift<Omittable<Scalar>>, // date
+days: NoLift<Omittable<Scalar>>, weekend?: NoLift<Omittable<AcceptError<Weekend | Scalar>>>, holidays?: Omittable<Flatten<Scalar>>): number;
 /**
- * @summary Returns the year of a date, an integer in the range 1900 - 9999.
+ * Returns the year of a date, an integer in the range 1900 - 9999.
  * @param serialNumber is a number in the date-time code used for date and time calculation.
  */
 export declare function YEAR(serialNumber: number): number;
+export {};
 //# sourceMappingURL=Date.d.ts.map