@autometa/datetime 0.1.16 → 1.0.0-rc.0

package/dist/index.d.cts

@@ -1,219 +0,0 @@
-import { TimeUnit } from '@autometa/phrases';
-
-type TimeShortcut = "now" | "beforeYesterday" | "yesterday" | "today" | "tomorrow" | "afterTomorrow" | "midnight" | "lastWeek" | "nextWeek" | "lastFortnight" | "nextFortnight";
-declare class DateFactory {
-    #private;
-    phraseMap: Map<TimeShortcut, () => Date>;
-    find(name: TimeShortcut): Date;
-    fromPhraseSafe(phrase: string): Date | undefined;
-    fromPhrase(phrase: string): Date;
-    make(timeOffset: number, timeunit: TimeUnit): Date;
-}
-
-declare class IsoDateFactory {
-    readonly dateFactory: DateFactory;
-    constructor(dateFactory: DateFactory);
-    phraseMap: Map<string, string>;
-    make(daysOffset: number, timeunit: TimeUnit): string;
-    /**
-     * Attempts to parse a phrase into a date.
-     * @param phrase
-     * @returns
-     */
-    fromPhrase(phrase: string): string;
-    /**
-     * Returns the date and time of the day before yesterday
-     */
-    get beforeYesterday(): string | undefined;
-    /**
-     * Returns the date and time of yesterday
-     */
-    get yesterday(): string | undefined;
-    /**
-     * Returns the date and time of today
-     */
-    get today(): string | undefined;
-    /**
-     * Returns the date and time of tomorrow
-     */
-    get tomorrow(): string | undefined;
-    /**
-     * Returns the date and time of the day after tomorrow
-     */
-    get afterTomorrow(): string | undefined;
-    /**
-     * Returns the date and time of midnight today
-     */
-    get midnight(): string | undefined;
-    /**
-     * Returns the date and time of today 1 week ago
-     */
-    get lastWeek(): string | undefined;
-    /**
-     * Returns the date and time of today 1 week from now
-     */
-    get nextWeek(): string | undefined;
-    get lastFortnight(): string | undefined;
-    /**
-     * Returns the date and time of today 1 fortnight from now
-     */
-    get nextFortnight(): string | undefined;
-}
-
-declare class FmtDateFactory {
-    readonly dateFactory: DateFactory;
-    constructor(dateFactory: DateFactory);
-    phraseMap: Map<string, string>;
-    make(daysOffset: number, timeunit: TimeUnit): string;
-    /**
-     * Attempts to parse a phrase into a date.
-     * @param phrase
-     * @returns
-     */
-    fromPhrase(phrase: string): string;
-    /**
-     * Returns the date and time of the day before yesterday
-     */
-    get beforeYesterday(): string | undefined;
-    /**
-     * Returns the date and time of yesterday
-     */
-    get yesterday(): string | undefined;
-    /**
-     * Returns the date and time of today
-     */
-    get today(): string | undefined;
-    /**
-     * Returns the date and time of tomorrow
-     */
-    get tomorrow(): string | undefined;
-    /**
-     * Returns the date and time of the day after tomorrow
-     */
-    get afterTomorrow(): string | undefined;
-    /**
-     * Returns the date and time of midnight today
-     */
-    get midnight(): string | undefined;
-    /**
-     * Returns the date and time of today 1 week ago
-     */
-    get lastWeek(): string | undefined;
-    /**
-     * Returns the date and time of today 1 week from now
-     */
-    get nextWeek(): string | undefined;
-    /**
-     * Returns the date and time of today 1 fortnight ago
-     */
-    get lastFortnight(): string | undefined;
-    /**
-     * Returns the date and time of today 1 fortnight from now
-     */
-    get nextFortnight(): string | undefined;
-}
-
-declare class DatesObject {
-    #private;
-    /**
-     * Switches to the ISO factory, which offers an identical interface
-     * but returns ISO strings instead of Date objects.
-     *
-     * Example: `2020-01-01T00:00:00.000Z`
-     */
-    get iso(): IsoDateFactory;
-    /**
-     * Switches to the formatted factory, which offers an identical interface
-     * but returns formatted strings instead of Date objects.
-     *
-     * Example: `2020-01-01`
-     */
-    get fmt(): FmtDateFactory;
-    /**
-     * Returns the current date and time.
-     */
-    get now(): Date;
-    /**
-     * Returns the date and time of the day before yesterday
-     */
-    get beforeYesterday(): Date;
-    /**
-     * Returns the date and time of yesterday
-     */
-    get yesterday(): Date;
-    /**
-     * Returns the date and time of today
-     */
-    get today(): Date;
-    /**
-     * Returns the date and time of tomorrow
-     */
-    get tomorrow(): Date;
-    /**
-     * Returns the date and time of the day after tomorrow
-     */
-    get afterTomorrow(): Date;
-    /**
-     * Returns the date and time of midnight today
-     */
-    get midnight(): Date;
-    /**
-     * Returns the date and time of today 1 week ago
-     */
-    get lastWeek(): Date;
-    /**
-     * Returns the date and time of today 1 week from now
-     */
-    get nextWeek(): Date;
-    /**
-     * Returns the date and time of today 2 weeks ago
-     */
-    get lastFortnight(): Date;
-    /**
-     * Returns the date and time of today 2 weeks from now
-     */
-    get nextFortnight(): Date;
-    /**
-     * Attempts to parse a phrase into a date.
-     * @param phrase
-     * @returns
-     */
-    fromPhrase(phrase: string): Date;
-    /**
-     * Attempts to parse a phrase into a date.
-     * If the phrase is invalid, it will return an invalid date instead of throwing.
-     * @param phrase
-     * @returns
-     */
-    fromPhraseSafe(phrase: string): Date | undefined;
-    make(timeOffset: number, timeUnit: TimeUnit): Date;
-}
-/**
- * Date utility option to easily generate common
- * dates around the current date, like 'today', 'midnight',
- * 'tomorrow', 'nextWeek', etc.
- *
- * The Dates utility also supports certain language phrases
- * that might be natural in Cucumber's gherkin syntax, like
- * 'next week', 'last week', 'next fortnight', etc. as well
- * as more dynamic phrases like `1 day ago`, `2 weeks from now`,
- */
-declare const Dates: DatesObject;
-
-type TimeDiffFn = (date1: Date, date2: Date) => number;
-declare class TimeDiff {
-    minutes(date1: Date, date2: Date): number;
-    seconds(date1: Date, date2: Date): number;
-    millis(date1: Date, date2: Date): number;
-    days(date1: Date, date2: Date): number;
-    hours(date1: Date, date2: Date): number;
-    weeks(date1: Date, date2: Date): number;
-    fromPhrase(phrase: string): TimeDiffFn;
-}
-declare class TimeObject {
-    #private;
-    get diff(): TimeDiff;
-}
-declare const Time: TimeObject;
-
-export { DateFactory, Dates, FmtDateFactory, IsoDateFactory, Time, TimeDiff, TimeObject };

package/tsup.config.ts

@@ -1,14 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig({
-  clean: true, // clean up the dist folder
-  sourcemap:true, // generate sourcemaps
-  format: ["cjs", "esm"], // generate cjs and esm files
-  dts: true,
-  skipNodeModulesBundle: true,
-  entryPoints: ["src/index.ts"],
-  target: "es2020",
-  outDir: "dist",
-  legacyOutput: true,
-  external: ["dist"],
-});