studiokit-scaffolding-js 4.3.20 → 4.3.21

package/lib/utils/date.d.ts

@@ -1,162 +1,162 @@
-import moment from 'moment-timezone';
-/**
- * When a GroupAssessment comes in the door, it includes the current UTC datetime. This method is
- * used to update the difference between the (accurate) server time and the browser time
- */
-export declare const setClockOffset: (offset: number) => void;
-/**
- * Get the current UTC time, calibrated to the API server's clock
- */
-export declare const getServerNowUtc: () => Date;
-/**
- * Return the provided date, offset by the clockOffset
- */
-export declare const getOffsetDate: (date: Date) => Date;
-export declare const getZonedMomentFromUtc: (dateTimeUtc?: string, timeZoneId?: string) => moment.Moment;
-export declare const getZonedMomentFromUtcInDefaultZone: (dateTimeUtc?: string) => moment.Moment;
-export declare const getZonedMomentFromLocalDateTime: (localDateTime: Date | string, timeZoneId?: string) => moment.Moment;
-export declare const getLocalMomentFromUtc: (dateTimeUtc?: string, timeZoneId?: string) => moment.Moment;
-export declare const getLocalDateTimeFromUtc: (dateTimeUtc: string) => Date;
-export declare const getDateMinusTime: (dateTime: Date) => Date;
-export declare function getEndOfDay(dateTimeUtc: string): Date;
-export declare function getEndOfMinute(dateTimeUtc: string): Date;
-/**
- * Is the current time, "now", **after or equal to** the given date.
- *
- * @param dateTimeUtc The date to compare the current time, "now", as an ISO date string.
- * @param nowUtc Optional. The current time, "now", as an ISO date string.
- *
- * @returns Whether or not "now" is **after or equal to** `dateTimeUtc`
- */
-export declare function isNowEqualOrAfterDate(dateTimeUtc?: string, nowUtc?: string): boolean;
-/**
- * Is the current time, "now", **before or equal to** the given date.
- *
- * @param dateTimeUtc The date to compare the current time, "now", as an ISO date string.
- * @param nowUtc Optional. The current time, "now", as an ISO date string.
- *
- * @returns Whether or not "now" is **before or equal to** `dateTimeUtc`.
- */
-export declare function isNowEqualOrBeforeDate(dateTimeUtc?: string, nowUtc?: string): boolean;
-/**
- * Is the current time, "now", **after** the given date.
- *
- * @param dateTimeUtc The date to compare the current time, "now", as an ISO date string.
- * @param nowUtc Optional. The current time, "now", as an ISO date string.
- *
- * @returns Whether or not "now" is **after** `dateTimeUtc`.
- */
-export declare function isNowAfterDate(dateTimeUtc?: string, nowUtc?: string): boolean;
-/**
- * Is the current time, "now", **before** the given date.
- *
- * @param dateTimeUtc The date to compare the current time, "now", as an ISO date string.
- * @param nowUtc Optional. The current time, "now", as an ISO date string.
- *
- * @returns Whether or not "now" is **before** `dateTimeUtc`.
- */
-export declare function isNowBeforeDate(dateTimeUtc?: string, nowUtc?: string): boolean;
-/**
- * Returns a date and time string with full date, e.g. `March 5, 2018 @ 4:05 PM EDT`
- * @param dateTimeUtc A UTC date time string
- * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
- */
-export declare function getFormattedFullDateAndTime(dateTimeUtc: string, withTimeZone?: boolean): string;
-/**
- * Returns a date and time string with day of week and American slash dates, e.g. `Mon, 3/5/2018 @ 4:05 PM EDT`
- * @param dateTimeUtc A UTC date time string
- * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
- */
-export declare function getFormattedFullDateWithWeek(dateTimeUtc: string, withTimeZone?: boolean): string;
-/**
- * Returns a date and time string with American slash dates, and no leading zeroes, e.g. `3/5/18 4:05 PM EDT`
- * @param dateTimeUtc A UTC date time string
- * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
- */
-export declare function getFormattedNumberedDateAndTime(dateTimeUtc: string, withTimeZone?: boolean): string;
-/**
- * Returns a date and time string with American slash dates, no leading zeroes, and no year, e.g. `3/5 4:05 PM EDT`
- * @param dateTimeUtc A UTC date time string
- * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
- */
-export declare function getFormattedNumberedDateAndTimeWithoutYear(dateTimeUtc: string, withTimeZone?: boolean): string;
-/**
- * Returns a date string with short month and full year, e.g. `Mar 5, 2018`
- * @param dateTimeUtc A UTC date time string
- */
-export declare function getFormattedSimplifiedDate(dateTimeUtc: string): string;
-/**
- * Returns a date string with short month and no year, e.g. `Mar 5`
- * @param dateTimeUtc A UTC date time string
- */
-export declare function getFormattedSimplifiedDateWithoutYear(dateTimeUtc: string): string;
-/**
- * Returns a date string as either 'MMM D, YYYY' or 'MMM D' if the date's year is the same as the current year
- * @param dateTimeUtc A UTC date time string
- * @param nowUtc (optional) A UTC date time string of "now". Used for testing.
- */
-export declare function getFormattedSimplifiedDateWithYearIfNotCurrent(dateTimeUtc: string, nowUtc?: string): string;
-/**
- * Returns a date string with American slash dates, no leading zeroes, and short year, e.g. `3/5/18`
- * @param dateTimeUtc A UTC date time string
- */
-export declare function getFormattedNumberedDate(dateTimeUtc: string): string;
-/**
- * Returns a date string with American slash dates, no leading zeroes, and full year, e.g. `3/5/2018`
- * @param dateTimeUtc A UTC date time string
- */
-export declare function getFormattedNumberedDateWithFullYear(dateTimeUtc: string): string;
-/**
- * Returns a date string for use in HTML inputs, e.g. `2018-03-05`
- * @param dateTimeUtc A UTC date time string
- */
-export declare function getFormattedNumberedDateForInput(dateTimeUtc: string): string;
-/**
- * Returns a date string with American slash dates and no year and no leading zeroes, e.g. `3/5`
- * @param dateTimeUtc A UTC date time string
- */
-export declare function getFormattedNumberedDateWithoutYear(dateTimeUtc: string): string;
-/**
- * Returns a time string, e.g. `4:05 PM EDT`
- * @param dateTimeUtc A UTC date time string
- * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
- */
-export declare function getFormattedNumberedTime(dateTimeUtc: string, withTimeZone?: boolean): string;
-/**
- * Returns a time string with possibly full time zone name, e.g. `4:05 PM EDT` or `4:05 PM CST (Asia/Taipei)`
- * @param dateTimeUtc A UTC date time string
- * @param showEasternZoneId (optional) Whether or not to include the timeZoneId in the result for EST/EDT. Defaults to `false`.
- * @param timeZoneId (optional) A time zone Id. Defaults to the current time zone id, using `guessTimeZoneId()`.
- */
-export declare function getFormattedNumberedTimeWithFullZone(dateTimeUtc: string, showEasternZoneId?: boolean, timeZoneId?: string): string;
-/**
- * Returns a time string without time zone, e.g. `4:05 PM`
- * @param dateTimeUtc A UTC date time string
- */
-export declare function getFormattedNumberedTimeWithoutZone(dateTimeUtc: string): string;
-/**
- * Returns a time string without time zone, in 24 hr time, e.g. `16:05`
- * @param dateTimeUtc A UTC date time string
- */
-export declare function getFormattedNumberedTimeWithoutZoneOrMeridian(dateTimeUtc: string): string;
-/**
- * Returns a full formatted time zone string for the given `timeZoneId`.
- *
- * Combines all possible abbreviations for the zone and the timeZoneId, e.g. `EST/EDT`, `PST/PDT (America/Los Angeles)` or `CST (Asia/Taipei)`
- *
- * If abbreviations are not alpha characters, e.g. `-04`, then only the timeZoneId is returned.
- *
- * @param timeZoneId (optional) A time zone Id. Defaults to the current time zone id, using `guessTimeZoneId()`.
- * @param showEasternZoneId (optional) Whether or not to include the timeZoneId in the result for EST/EDT. Defaults to `false`.
- * @param nowUtc (optional) The current time, "now", as an ISO date string.
- */
-export declare function getFullFormattedTimeZone(timeZoneId?: string, showEasternZoneId?: boolean, nowUtc?: string): string;
-/**
- * Returns the basic time zone abbreviation for the given date, e.g. `EDT`.
- *
- * @param dateTimeUtc The date to format.
- */
-export declare function getFormattedTimeZone(dateTimeUtc: string): string;
-export declare const isDateInputSupported: boolean;
-export declare const isTimeInputSupported: boolean;
-export declare function isDateTimeValid(dateTime: string | Date): boolean;
+import moment from 'moment-timezone';
+/**
+ * When a GroupAssessment comes in the door, it includes the current UTC datetime. This method is
+ * used to update the difference between the (accurate) server time and the browser time
+ */
+export declare const setClockOffset: (offset: number) => void;
+/**
+ * Get the current UTC time, calibrated to the API server's clock
+ */
+export declare const getServerNowUtc: () => Date;
+/**
+ * Return the provided date, offset by the clockOffset
+ */
+export declare const getOffsetDate: (date: Date) => Date;
+export declare const getZonedMomentFromUtc: (dateTimeUtc?: string, timeZoneId?: string) => moment.Moment;
+export declare const getZonedMomentFromUtcInDefaultZone: (dateTimeUtc?: string) => moment.Moment;
+export declare const getZonedMomentFromLocalDateTime: (localDateTime: Date | string, timeZoneId?: string) => moment.Moment;
+export declare const getLocalMomentFromUtc: (dateTimeUtc?: string, timeZoneId?: string) => moment.Moment;
+export declare const getLocalDateTimeFromUtc: (dateTimeUtc: string) => Date;
+export declare const getDateMinusTime: (dateTime: Date) => Date;
+export declare function getEndOfDay(dateTimeUtc: string): Date;
+export declare function getEndOfMinute(dateTimeUtc: string): Date;
+/**
+ * Is the current time, "now", **after or equal to** the given date.
+ *
+ * @param dateTimeUtc The date to compare the current time, "now", as an ISO date string.
+ * @param nowUtc Optional. The current time, "now", as an ISO date string.
+ *
+ * @returns Whether or not "now" is **after or equal to** `dateTimeUtc`
+ */
+export declare function isNowEqualOrAfterDate(dateTimeUtc?: string, nowUtc?: string): boolean;
+/**
+ * Is the current time, "now", **before or equal to** the given date.
+ *
+ * @param dateTimeUtc The date to compare the current time, "now", as an ISO date string.
+ * @param nowUtc Optional. The current time, "now", as an ISO date string.
+ *
+ * @returns Whether or not "now" is **before or equal to** `dateTimeUtc`.
+ */
+export declare function isNowEqualOrBeforeDate(dateTimeUtc?: string, nowUtc?: string): boolean;
+/**
+ * Is the current time, "now", **after** the given date.
+ *
+ * @param dateTimeUtc The date to compare the current time, "now", as an ISO date string.
+ * @param nowUtc Optional. The current time, "now", as an ISO date string.
+ *
+ * @returns Whether or not "now" is **after** `dateTimeUtc`.
+ */
+export declare function isNowAfterDate(dateTimeUtc?: string, nowUtc?: string): boolean;
+/**
+ * Is the current time, "now", **before** the given date.
+ *
+ * @param dateTimeUtc The date to compare the current time, "now", as an ISO date string.
+ * @param nowUtc Optional. The current time, "now", as an ISO date string.
+ *
+ * @returns Whether or not "now" is **before** `dateTimeUtc`.
+ */
+export declare function isNowBeforeDate(dateTimeUtc?: string, nowUtc?: string): boolean;
+/**
+ * Returns a date and time string with full date, e.g. `March 5, 2018 @ 4:05 PM EDT`
+ * @param dateTimeUtc A UTC date time string
+ * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
+ */
+export declare function getFormattedFullDateAndTime(dateTimeUtc: string, withTimeZone?: boolean): string;
+/**
+ * Returns a date and time string with day of week and American slash dates, e.g. `Mon, 3/5/2018 @ 4:05 PM EDT`
+ * @param dateTimeUtc A UTC date time string
+ * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
+ */
+export declare function getFormattedFullDateWithWeek(dateTimeUtc: string, withTimeZone?: boolean): string;
+/**
+ * Returns a date and time string with American slash dates, and no leading zeroes, e.g. `3/5/18 4:05 PM EDT`
+ * @param dateTimeUtc A UTC date time string
+ * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
+ */
+export declare function getFormattedNumberedDateAndTime(dateTimeUtc: string, withTimeZone?: boolean): string;
+/**
+ * Returns a date and time string with American slash dates, no leading zeroes, and no year, e.g. `3/5 4:05 PM EDT`
+ * @param dateTimeUtc A UTC date time string
+ * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
+ */
+export declare function getFormattedNumberedDateAndTimeWithoutYear(dateTimeUtc: string, withTimeZone?: boolean): string;
+/**
+ * Returns a date string with short month and full year, e.g. `Mar 5, 2018`
+ * @param dateTimeUtc A UTC date time string
+ */
+export declare function getFormattedSimplifiedDate(dateTimeUtc: string): string;
+/**
+ * Returns a date string with short month and no year, e.g. `Mar 5`
+ * @param dateTimeUtc A UTC date time string
+ */
+export declare function getFormattedSimplifiedDateWithoutYear(dateTimeUtc: string): string;
+/**
+ * Returns a date string as either 'MMM D, YYYY' or 'MMM D' if the date's year is the same as the current year
+ * @param dateTimeUtc A UTC date time string
+ * @param nowUtc (optional) A UTC date time string of "now". Used for testing.
+ */
+export declare function getFormattedSimplifiedDateWithYearIfNotCurrent(dateTimeUtc: string, nowUtc?: string): string;
+/**
+ * Returns a date string with American slash dates, no leading zeroes, and short year, e.g. `3/5/18`
+ * @param dateTimeUtc A UTC date time string
+ */
+export declare function getFormattedNumberedDate(dateTimeUtc: string): string;
+/**
+ * Returns a date string with American slash dates, no leading zeroes, and full year, e.g. `3/5/2018`
+ * @param dateTimeUtc A UTC date time string
+ */
+export declare function getFormattedNumberedDateWithFullYear(dateTimeUtc: string): string;
+/**
+ * Returns a date string for use in HTML inputs, e.g. `2018-03-05`
+ * @param dateTimeUtc A UTC date time string
+ */
+export declare function getFormattedNumberedDateForInput(dateTimeUtc: string): string;
+/**
+ * Returns a date string with American slash dates and no year and no leading zeroes, e.g. `3/5`
+ * @param dateTimeUtc A UTC date time string
+ */
+export declare function getFormattedNumberedDateWithoutYear(dateTimeUtc: string): string;
+/**
+ * Returns a time string, e.g. `4:05 PM EDT`
+ * @param dateTimeUtc A UTC date time string
+ * @param withTimeZone (optional) Whether to include the time zone abbreviation. Defaults to `true`.
+ */
+export declare function getFormattedNumberedTime(dateTimeUtc: string, withTimeZone?: boolean): string;
+/**
+ * Returns a time string with possibly full time zone name, e.g. `4:05 PM EDT` or `4:05 PM CST (Asia/Taipei)`
+ * @param dateTimeUtc A UTC date time string
+ * @param showEasternZoneId (optional) Whether or not to include the timeZoneId in the result for EST/EDT. Defaults to `false`.
+ * @param timeZoneId (optional) A time zone Id. Defaults to the current time zone id, using `guessTimeZoneId()`.
+ */
+export declare function getFormattedNumberedTimeWithFullZone(dateTimeUtc: string, showEasternZoneId?: boolean, timeZoneId?: string): string;
+/**
+ * Returns a time string without time zone, e.g. `4:05 PM`
+ * @param dateTimeUtc A UTC date time string
+ */
+export declare function getFormattedNumberedTimeWithoutZone(dateTimeUtc: string): string;
+/**
+ * Returns a time string without time zone, in 24 hr time, e.g. `16:05`
+ * @param dateTimeUtc A UTC date time string
+ */
+export declare function getFormattedNumberedTimeWithoutZoneOrMeridian(dateTimeUtc: string): string;
+/**
+ * Returns a full formatted time zone string for the given `timeZoneId`.
+ *
+ * Combines all possible abbreviations for the zone and the timeZoneId, e.g. `EST/EDT`, `PST/PDT (America/Los Angeles)` or `CST (Asia/Taipei)`
+ *
+ * If abbreviations are not alpha characters, e.g. `-04`, then only the timeZoneId is returned.
+ *
+ * @param timeZoneId (optional) A time zone Id. Defaults to the current time zone id, using `guessTimeZoneId()`.
+ * @param showEasternZoneId (optional) Whether or not to include the timeZoneId in the result for EST/EDT. Defaults to `false`.
+ * @param nowUtc (optional) The current time, "now", as an ISO date string.
+ */
+export declare function getFullFormattedTimeZone(timeZoneId?: string, showEasternZoneId?: boolean, nowUtc?: string): string;
+/**
+ * Returns the basic time zone abbreviation for the given date, e.g. `EDT`.
+ *
+ * @param dateTimeUtc The date to format.
+ */
+export declare function getFormattedTimeZone(dateTimeUtc: string): string;
+export declare const isDateInputSupported: boolean;
+export declare const isTimeInputSupported: boolean;
+export declare function isDateTimeValid(dateTime: string | Date): boolean;