@thi.ng/date 2.1.2 → 2.1.5

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-11-21T17:09:28Z
+- **Last updated**: 2022-03-11T12:13:49Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -451,4 +451,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2020 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2020 - 2022 Karsten Schmidt // Apache Software License 2.0

package/checks.d.ts

@@ -2,13 +2,13 @@ import type { MaybeDate } from "./api.js";
 /**
  * Coerces `x` to a native JS `Date` instance.
  *
- * @param x
+ * @param x -
  */
 export declare const ensureDate: (x: MaybeDate) => Date;
 /**
  * Coerces `x` to a timestamp.
  *
- * @param x
+ * @param x -
  */
 export declare const ensureEpoch: (x: MaybeDate) => number;
 export declare const isLeapYear: (year: number) => boolean;

package/checks.js

@@ -4,7 +4,7 @@ import { isString } from "@thi.ng/checks/is-string";
 /**
  * Coerces `x` to a native JS `Date` instance.
  *
- * @param x
+ * @param x -
  */
 export const ensureDate = (x) => isString(x) || isNumber(x)
     ? new Date(x)
@@ -14,7 +14,7 @@ export const ensureDate = (x) => isString(x) || isNumber(x)
 /**
  * Coerces `x` to a timestamp.
  *
- * @param x
+ * @param x -
  */
 export const ensureEpoch = (x) => (implementsFunction(x, "getTime") ? x : ensureDate(x)).getTime();
 export const isLeapYear = (year) => !(year % 4) && (!!(year % 100) || !(year % 400));

package/datetime.d.ts

@@ -38,14 +38,14 @@ export declare class DateTime implements ICopy<DateTime>, ICompare<MaybeDate>, I
      * Returns true if this instance is before the given date, i.e. if
      * `this.compare(d) < 0`.
      *
-     * @param d
+     * @param d -
      */
     isBefore(d: MaybeDate): boolean;
     /**
      * Returns true if this instance is before the given date, i.e. if
      * `this.compare(d) > 0`.
      *
-     * @param d
+     * @param d -
      */
     isAfter(d: MaybeDate): boolean;
     equiv(o: any): boolean;
@@ -88,8 +88,8 @@ export declare class DateTime implements ICopy<DateTime>, ICompare<MaybeDate>, I
      * Returns a new `DateTime` instance relative to this date, but with given
      * period added/subtracted.
      *
-     * @param x
-     * @param prec
+     * @param x -
+     * @param prec -
      */
     add(x: number, prec: Period): DateTime;
     toDate(): Date;
@@ -110,13 +110,13 @@ export declare class DateTime implements ICopy<DateTime>, ICompare<MaybeDate>, I
 /**
  * Coerces `x` to a {@link DateTime} instance.
  *
- * @param x
+ * @param x -
  */
 export declare const ensureDateTime: (x: MaybeDate, prec?: Precision) => DateTime;
 /**
  * Returns true if `x` is a {@link MaybeDate}.
  *
- * @param x
+ * @param x -
  */
 export declare const maybeIsDate: (x: any) => boolean;
 //# sourceMappingURL=datetime.d.ts.map

package/datetime.js

@@ -79,7 +79,7 @@ export class DateTime {
      * Returns true if this instance is before the given date, i.e. if
      * `this.compare(d) < 0`.
      *
-     * @param d
+     * @param d -
      */
     isBefore(d) {
         return this.compare(d) < 0;
@@ -88,7 +88,7 @@ export class DateTime {
      * Returns true if this instance is before the given date, i.e. if
      * `this.compare(d) > 0`.
      *
-     * @param d
+     * @param d -
      */
     isAfter(d) {
         return this.compare(d) > 0;
@@ -252,8 +252,8 @@ export class DateTime {
      * Returns a new `DateTime` instance relative to this date, but with given
      * period added/subtracted.
      *
-     * @param x
-     * @param prec
+     * @param x -
+     * @param prec -
      */
     add(x, prec) {
         if (prec === "w")
@@ -312,12 +312,12 @@ export class DateTime {
 /**
  * Coerces `x` to a {@link DateTime} instance.
  *
- * @param x
+ * @param x -
  */
 export const ensureDateTime = (x, prec = "t") => x instanceof DateTime ? x : new DateTime(x, prec);
 /**
  * Returns true if `x` is a {@link MaybeDate}.
  *
- * @param x
+ * @param x -
  */
 export const maybeIsDate = (x) => x instanceof DateTime || x instanceof Date || isNumber(x) || isString(x);

package/format.d.ts

@@ -21,7 +21,7 @@ export declare const FORMATTERS: Record<string, FormatFn>;
  * // "yyyy"
  * ```
  *
- * @param fmt
+ * @param fmt -
  */
 export declare const defFormat: (fmt: (string | FormatFn)[]) => (x: MaybeDate, utc?: boolean) => string;
 /**

package/format.js

@@ -121,7 +121,7 @@ export const FORMATTERS = {
      * Returns literal `"Z"` iff timezone offset is zero (UTC), else the same as
      * `Z` formatter.
      *
-     * @param d
+     * @param d -
      */
     ZZ: (d, utc = false) => (utc ? "Z" : FORMATTERS.Z(d, utc)),
     /**
@@ -162,7 +162,7 @@ export const FORMATTERS = {
  * // "yyyy"
  * ```
  *
- * @param fmt
+ * @param fmt -
  */
 export const defFormat = (fmt) => (x, utc = false) => {
     let d = ensureDate(x);

package/i18n.d.ts

@@ -4,7 +4,7 @@ import type { Locale, LocaleSpec, LocaleUnit, Precision } from "./api.js";
  * Sets {@link LOCALE} for formatting and fills in missing default values.
  * Unless called explicitly, the package uses {@link EN_SHORT} by default.
  *
- * @param locale
+ * @param locale -
  */
 export declare const setLocale: (locale: LocaleSpec) => Locale;
 /**
@@ -14,8 +14,8 @@ export declare const setLocale: (locale: LocaleSpec) => Locale;
  * `fn` will be called within a try/catch block and the previous locale will be
  * restored even if `fn` throws an error.
  *
- * @param locale
- * @param fn
+ * @param locale -
+ * @param fn -
  */
 export declare const withLocale: <T>(locale: LocaleSpec, fn: Fn0<T>) => T;
 export declare let LOCALE: Locale;
@@ -57,10 +57,10 @@ export declare const monthNames: () => string[];
  * // "2 Jahren"
  * ```
  *
- * @param x
- * @param unit
- * @param isDativ
- * @param unitsOnly
+ * @param x -
+ * @param unit -
+ * @param isDativ -
+ * @param unitsOnly -
  */
 export declare const units: (x: number, unit: Precision | LocaleUnit, isDativ?: boolean, unitsOnly?: boolean) => string;
 /**
@@ -73,18 +73,17 @@ export declare const units: (x: number, unit: Precision | LocaleUnit, isDativ?:
  * // "weniger als 1 Jahr"
  * ```
  *
- * @param x
- * @param unit
- * @param isDativ
+ * @param x -
+ * @param unit -
+ * @param isDativ -
  */
 export declare const unitsLessThan: (x: number, unit: Precision | LocaleUnit, isDativ?: boolean) => string;
 /**
  * Wraps given (presumably localized) string in current {@link LOCALE}'s `past`
  * or `future` phrases, depending on given `sign`.
  *
- * @param sign
- * @param res
- * @returns
+ * @param sign -
+ * @param res -
  */
 export declare const tense: (sign: number, res: string) => string;
 //# sourceMappingURL=i18n.d.ts.map

package/i18n.js

@@ -18,7 +18,7 @@ const prepLocale = (spec) => {
  * Sets {@link LOCALE} for formatting and fills in missing default values.
  * Unless called explicitly, the package uses {@link EN_SHORT} by default.
  *
- * @param locale
+ * @param locale -
  */
 export const setLocale = (locale) => (LOCALE = prepLocale(locale));
 /**
@@ -28,8 +28,8 @@ export const setLocale = (locale) => (LOCALE = prepLocale(locale));
  * `fn` will be called within a try/catch block and the previous locale will be
  * restored even if `fn` throws an error.
  *
- * @param locale
- * @param fn
+ * @param locale -
+ * @param fn -
  */
 export const withLocale = (locale, fn) => {
     const old = LOCALE;
@@ -83,10 +83,10 @@ export const monthNames = () => LOCALE.months.slice();
  * // "2 Jahren"
  * ```
  *
- * @param x
- * @param unit
- * @param isDativ
- * @param unitsOnly
+ * @param x -
+ * @param unit -
+ * @param isDativ -
+ * @param unitsOnly -
  */
 export const units = (x, unit, isDativ = false, unitsOnly = false) => {
     unit = isString(unit) ? LOCALE.units[unit] : unit;
@@ -109,17 +109,16 @@ export const units = (x, unit, isDativ = false, unitsOnly = false) => {
  * // "weniger als 1 Jahr"
  * ```
  *
- * @param x
- * @param unit
- * @param isDativ
+ * @param x -
+ * @param unit -
+ * @param isDativ -
  */
 export const unitsLessThan = (x, unit, isDativ = false) => `${LOCALE.less.replace("%s", String(x))} ${units(Math.max(x, 1), unit, isDativ, true)}`;
 /**
  * Wraps given (presumably localized) string in current {@link LOCALE}'s `past`
  * or `future` phrases, depending on given `sign`.
  *
- * @param sign
- * @param res
- * @returns
+ * @param sign -
+ * @param res -
  */
 export const tense = (sign, res) => (sign < 0 ? LOCALE.past : LOCALE.future).replace("%s", res);

package/internal/precision.d.ts

@@ -2,7 +2,7 @@ import type { Precision } from "../api.js";
 /**
  * Converts a {@link Precision} into a numeric ID.
  *
- * @param prec
+ * @param prec -
  *
  * @internal
  */
@@ -10,7 +10,7 @@ export declare const __precisionToID: (prec: Precision) => number;
 /**
  * Inverse op of {@link __precisionToID}.
  *
- * @param id
+ * @param id -
  *
  * @internal
  */

package/internal/precision.js

@@ -1,7 +1,7 @@
 /**
  * Converts a {@link Precision} into a numeric ID.
  *
- * @param prec
+ * @param prec -
  *
  * @internal
  */
@@ -9,7 +9,7 @@ export const __precisionToID = (prec) => "yMdhmst".indexOf(prec);
 /**
  * Inverse op of {@link __precisionToID}.
  *
- * @param id
+ * @param id -
  *
  * @internal
  */

package/iterators.d.ts

@@ -5,16 +5,16 @@ import { DateTime } from "./datetime.js";
  * Higher-order epoch iterator factory. Returns iterator with configured
  * precision and `tick` fn.
  *
- * @param prec
- * @param tick
+ * @param prec -
+ * @param tick -
  */
 export declare const defIterator: (prec: Precision | Fn<number, DateTime>, tick: Fn<DateTime, void>) => EpochIteratorConstructor;
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in yearly
  * precision (each timestamp is at beginning of each year).
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const years: EpochIteratorConstructor;
 /**
@@ -22,16 +22,16 @@ export declare const years: EpochIteratorConstructor;
  * precision (each timestamp is at beginning of a month), but spaced at 3 month
  * intervals.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const quarters: EpochIteratorConstructor;
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in monthly
  * precision (each timestamp is at beginning of each month).
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const months: EpochIteratorConstructor;
 /**
@@ -39,48 +39,48 @@ export declare const months: EpochIteratorConstructor;
  * precision (each timestamp is 7 days apart). As per ISO8601, weeks start on
  * Mondays.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const weeks: EpochIteratorConstructor;
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in daily
  * precision (each timestamp is at midnight/beginning of each day).
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const days: EpochIteratorConstructor;
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in hourly
  * precision.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const hours: EpochIteratorConstructor;
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in minute
  * precision.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const minutes: EpochIteratorConstructor;
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in second
  * precision.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const seconds: EpochIteratorConstructor;
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in millisecond
  * precision.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export declare const milliseconds: EpochIteratorConstructor;
 //# sourceMappingURL=iterators.d.ts.map

package/iterators.js

@@ -5,8 +5,8 @@ import { floorQuarter, floorWeek } from "./round.js";
  * Higher-order epoch iterator factory. Returns iterator with configured
  * precision and `tick` fn.
  *
- * @param prec
- * @param tick
+ * @param prec -
+ * @param tick -
  */
 export const defIterator = (prec, tick) => {
     return function* (...xs) {
@@ -25,8 +25,8 @@ export const defIterator = (prec, tick) => {
  * Yields iterator of UTC timestamps in given semi-open interval in yearly
  * precision (each timestamp is at beginning of each year).
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const years = defIterator("y", (d) => d.incYear());
 /**
@@ -34,16 +34,16 @@ export const years = defIterator("y", (d) => d.incYear());
  * precision (each timestamp is at beginning of a month), but spaced at 3 month
  * intervals.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const quarters = defIterator((from) => new DateTime(floorQuarter(from)), (d) => d.incQuarter());
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in monthly
  * precision (each timestamp is at beginning of each month).
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const months = defIterator("M", (d) => d.incMonth());
 /**
@@ -51,47 +51,47 @@ export const months = defIterator("M", (d) => d.incMonth());
  * precision (each timestamp is 7 days apart). As per ISO8601, weeks start on
  * Mondays.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const weeks = defIterator((from) => new DateTime(floorWeek(from)), (d) => d.incWeek());
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in daily
  * precision (each timestamp is at midnight/beginning of each day).
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const days = defIterator("d", (d) => d.incDay());
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in hourly
  * precision.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const hours = defIterator("h", (d) => d.incHour());
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in minute
  * precision.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const minutes = defIterator("m", (d) => d.incMinute());
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in second
  * precision.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const seconds = defIterator("s", (d) => d.incSecond());
 /**
  * Yields iterator of UTC timestamps in given semi-open interval in millisecond
  * precision.
  *
- * @param from
- * @param to
+ * @param from -
+ * @param to -
  */
 export const milliseconds = defIterator("t", (d) => d.incMillisecond());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/date",
-  "version": "2.1.2",
+  "version": "2.1.5",
   "description": "Datetime types, relative dates, math, iterators, composable formatters, locales",
   "type": "module",
   "module": "./index.js",
@@ -34,17 +34,17 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.2",
-    "@thi.ng/checks": "^3.1.2",
-    "@thi.ng/strings": "^3.2.2"
+    "@thi.ng/api": "^8.3.4",
+    "@thi.ng/checks": "^3.1.4",
+    "@thi.ng/strings": "^3.3.2"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.19",
-    "@thi.ng/testament": "^0.2.2",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.4",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.9",
-    "typescript": "^4.5.2"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "datastructure",
@@ -129,5 +129,5 @@
   "thi.ng": {
     "year": 2020
   },
-  "gitHead": "e8a7c2a40191b391cef182c2978e5a6c85987a87\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }

package/relative.d.ts

@@ -34,8 +34,8 @@ import { DateTime } from "./datetime.js";
  *   - `q` / `quarter` / `quarters`
  *   - `y` / `year` / `years`
  *
- * @param offset
- * @param base
+ * @param offset -
+ * @param base -
  */
 export declare const parseRelative: (offset: string, base?: MaybeDate | undefined) => DateTime | undefined;
 /**
@@ -43,18 +43,17 @@ export declare const parseRelative: (offset: string, base?: MaybeDate | undefine
  * optionally given `base` date (default: now). If `num < 0` the result date
  * will be in the past (relative to `base`).
  *
- * @param num
- * @param period
- * @param base
- * @returns
+ * @param num -
+ * @param period -
+ * @param base -
  */
 export declare const relative: (num: number, period: Period, base?: MaybeDate) => DateTime;
 /**
  * Returns the signed difference in milliseconds between given two dates `a` and
  * `b`.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const difference: (a: MaybeDate, b: MaybeDate) => number;
 /**
@@ -63,8 +62,8 @@ export declare const difference: (a: MaybeDate, b: MaybeDate) => number;
  * to indicate the relative order of `a` compared to `b`, i.e. same contract as
  * {@link @thi.ng/api#ICompare}.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare const decomposeDifference: (a: MaybeDate, b?: MaybeDate) => number[];
 /**
@@ -93,10 +92,10 @@ export declare const decomposeDifference: (a: MaybeDate, b?: MaybeDate) => numbe
  * // "in 18 minutes"
  * ```
  *
- * @param date
- * @param base
- * @param prec
- * @param eps
+ * @param date -
+ * @param base -
+ * @param prec -
+ * @param eps -
  */
 export declare const formatRelative: (date: MaybeDate, base?: MaybeDate, prec?: number, eps?: number) => string;
 /**
@@ -124,10 +123,10 @@ export declare const formatRelative: (date: MaybeDate, base?: MaybeDate, prec?:
  * // "in less than a day"
  * ```
  *
- * @param date
- * @param base
- * @param prec
- * @param eps
+ * @param date -
+ * @param base -
+ * @param prec -
+ * @param eps -
  */
 export declare const formatRelativeParts: (date: MaybeDate, base?: MaybeDate, prec?: Precision, eps?: number) => string;
 //# sourceMappingURL=relative.d.ts.map

package/relative.js

@@ -38,8 +38,8 @@ import { __idToPrecision, __precisionToID } from "./internal/precision.js";
  *   - `q` / `quarter` / `quarters`
  *   - `y` / `year` / `years`
  *
- * @param offset
- * @param base
+ * @param offset -
+ * @param base -
  */
 export const parseRelative = (offset, base) => {
     offset = offset.toLowerCase();
@@ -100,18 +100,17 @@ const parsePeriod = (x) => {
  * optionally given `base` date (default: now). If `num < 0` the result date
  * will be in the past (relative to `base`).
  *
- * @param num
- * @param period
- * @param base
- * @returns
+ * @param num -
+ * @param period -
+ * @param base -
  */
 export const relative = (num, period, base = dateTime()) => dateTime(base).add(num, period);
 /**
  * Returns the signed difference in milliseconds between given two dates `a` and
  * `b`.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const difference = (a, b) => ensureEpoch(a) - ensureEpoch(b);
 /**
@@ -120,8 +119,8 @@ export const difference = (a, b) => ensureEpoch(a) - ensureEpoch(b);
  * to indicate the relative order of `a` compared to `b`, i.e. same contract as
  * {@link @thi.ng/api#ICompare}.
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export const decomposeDifference = (a, b = new Date()) => {
     const dur = ensureEpoch(a) - ensureEpoch(b);
@@ -191,10 +190,10 @@ export const decomposeDifference = (a, b = new Date()) => {
  * // "in 18 minutes"
  * ```
  *
- * @param date
- * @param base
- * @param prec
- * @param eps
+ * @param date -
+ * @param base -
+ * @param prec -
+ * @param eps -
  */
 export const formatRelative = (date, base = new Date(), prec = 0, eps = 100) => {
     const delta = difference(date, base);
@@ -258,10 +257,10 @@ export const formatRelative = (date, base = new Date(), prec = 0, eps = 100) =>
  * // "in less than a day"
  * ```
  *
- * @param date
- * @param base
- * @param prec
- * @param eps
+ * @param date -
+ * @param base -
+ * @param prec -
+ * @param eps -
  */
 export const formatRelativeParts = (date, base = Date.now(), prec = "s", eps = 1000) => {
     date = ensureEpoch(date);

package/round.d.ts

@@ -2,99 +2,99 @@ import { RoundingFn } from "./api.js";
 /**
  * Rounds down `epoch` to minute precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const floorSecond: RoundingFn;
 /**
  * Rounds down `epoch` to minute precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const floorMinute: RoundingFn;
 /**
  * Rounds down `epoch` to hour precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const floorHour: RoundingFn;
 /**
  * Rounds down `epoch` to day precision
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const floorDay: RoundingFn;
 /**
  * Rounds down `epoch` to week precision. Assumes ISO8601 week logic, i.e. weeks
  * start on Monday.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const floorWeek: RoundingFn;
 /**
  * Rounds down `epoch` to month precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const floorMonth: RoundingFn;
 /**
  * Rounds down `epoch` to month precision, but at beginning of a quarter.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const floorQuarter: RoundingFn;
 /**
  * Rounds down `epoch` to year precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const floorYear: RoundingFn;
 /**
  * Rounds up `epoch` to minute precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const ceilSecond: RoundingFn;
 /**
  * Rounds up `epoch` to minute precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const ceilMinute: RoundingFn;
 /**
  * Rounds up `epoch` to hour precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const ceilHour: RoundingFn;
 /**
  * Rounds up `epoch` to day precision
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const ceilDay: RoundingFn;
 /**
  * Rounds up `epoch` to week precision. Assumes ISO8601 week logic, i.e. weeks
  * start on Monday.
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const ceilWeek: RoundingFn;
 /**
  * Rounds up `epoch` to month precision
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const ceilMonth: RoundingFn;
 /**
  * Rounds up `epoch` to month precision (beginning of next quarter)
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const ceilQuarter: RoundingFn;
 /**
  * Rounds up `epoch` to year precision
  *
- * @param epoch
+ * @param epoch -
  */
 export declare const ceilYear: RoundingFn;
 //# sourceMappingURL=round.d.ts.map

package/round.js

@@ -3,7 +3,7 @@ import { ensureDate } from "./checks.js";
 /**
  * Rounds down `epoch` to minute precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export const floorSecond = (epoch) => {
     const d = ensureDate(epoch);
@@ -12,7 +12,7 @@ export const floorSecond = (epoch) => {
 /**
  * Rounds down `epoch` to minute precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export const floorMinute = (epoch) => {
     const d = ensureDate(epoch);
@@ -21,7 +21,7 @@ export const floorMinute = (epoch) => {
 /**
  * Rounds down `epoch` to hour precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export const floorHour = (epoch) => {
     const d = ensureDate(epoch);
@@ -30,7 +30,7 @@ export const floorHour = (epoch) => {
 /**
  * Rounds down `epoch` to day precision
  *
- * @param epoch
+ * @param epoch -
  */
 export const floorDay = (epoch) => {
     const d = ensureDate(epoch);
@@ -40,7 +40,7 @@ export const floorDay = (epoch) => {
  * Rounds down `epoch` to week precision. Assumes ISO8601 week logic, i.e. weeks
  * start on Monday.
  *
- * @param epoch
+ * @param epoch -
  */
 export const floorWeek = (epoch) => {
     const d = ensureDate(epoch);
@@ -51,7 +51,7 @@ export const floorWeek = (epoch) => {
 /**
  * Rounds down `epoch` to month precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export const floorMonth = (epoch) => {
     const d = ensureDate(epoch);
@@ -60,7 +60,7 @@ export const floorMonth = (epoch) => {
 /**
  * Rounds down `epoch` to month precision, but at beginning of a quarter.
  *
- * @param epoch
+ * @param epoch -
  */
 export const floorQuarter = (epoch) => {
     const d = ensureDate(epoch);
@@ -69,44 +69,44 @@ export const floorQuarter = (epoch) => {
 /**
  * Rounds down `epoch` to year precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export const floorYear = (epoch) => Date.UTC(ensureDate(epoch).getUTCFullYear(), 0);
 /**
  * Rounds up `epoch` to minute precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export const ceilSecond = (epoch) => floorSecond(ensureDate(epoch).getTime() + SECOND);
 /**
  * Rounds up `epoch` to minute precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export const ceilMinute = (epoch) => floorMinute(ensureDate(epoch).getTime() + MINUTE);
 /**
  * Rounds up `epoch` to hour precision.
  *
- * @param epoch
+ * @param epoch -
  */
 export const ceilHour = (epoch) => floorHour(ensureDate(epoch).getTime() + HOUR);
 /**
  * Rounds up `epoch` to day precision
  *
- * @param epoch
+ * @param epoch -
  */
 export const ceilDay = (epoch) => floorDay(ensureDate(epoch).getTime() + DAY);
 /**
  * Rounds up `epoch` to week precision. Assumes ISO8601 week logic, i.e. weeks
  * start on Monday.
  *
- * @param epoch
+ * @param epoch -
  */
 export const ceilWeek = (epoch) => floorWeek(ensureDate(epoch).getTime() + WEEK);
 /**
  * Rounds up `epoch` to month precision
  *
- * @param epoch
+ * @param epoch -
  */
 export const ceilMonth = (epoch) => {
     const d = ensureDate(epoch);
@@ -118,7 +118,7 @@ export const ceilMonth = (epoch) => {
 /**
  * Rounds up `epoch` to month precision (beginning of next quarter)
  *
- * @param epoch
+ * @param epoch -
  */
 export const ceilQuarter = (epoch) => {
     const d = ensureDate(epoch);
@@ -130,6 +130,6 @@ export const ceilQuarter = (epoch) => {
 /**
  * Rounds up `epoch` to year precision
  *
- * @param epoch
+ * @param epoch -
  */
 export const ceilYear = (epoch) => Date.UTC(ensureDate(epoch).getUTCFullYear() + 1, 0);

package/timecode.d.ts

@@ -22,15 +22,15 @@
  * // "01d 01h 02' 03" 29"
  * ```
  *
- * @param fps
- * @param sep
+ * @param fps -
+ * @param sep -
  */
 export declare const defTimecode: (fps: number, sep?: ArrayLike<string>) => (t: number) => string;
 /**
  * Decomposes given duration (in milliseconds) into a tuple of: `[year, month,
  * day, hour, minute, second, millis]`.
  *
- * @param dur
+ * @param dur -
  */
 export declare const decomposeDuration: (dur: number) => number[];
 //# sourceMappingURL=timecode.d.ts.map

package/timecode.js

@@ -24,8 +24,8 @@ import { DAY, HOUR, MINUTE, MONTH, SECOND, YEAR } from "./api.js";
  * // "01d 01h 02' 03" 29"
  * ```
  *
- * @param fps
- * @param sep
+ * @param fps -
+ * @param sep -
  */
 export const defTimecode = (fps, sep = "::::") => {
     const frame = 1000 / fps;
@@ -48,7 +48,7 @@ export const defTimecode = (fps, sep = "::::") => {
  * Decomposes given duration (in milliseconds) into a tuple of: `[year, month,
  * day, hour, minute, second, millis]`.
  *
- * @param dur
+ * @param dur -
  */
 export const decomposeDuration = (dur) => {
     const year = (dur / YEAR) | 0;