@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/Utility/rockDateTime.d.ts

@@ -1,341 +1,342 @@
-import { DayOfWeek } from "@Obsidian/Enums/Controls/dayOfWeek";
-/**
- * The days of the week that are used by RockDateTime.
- */
-export { DayOfWeek } from "@Obsidian/Enums/Controls/dayOfWeek";
-/**
- * The various date and time formats supported by the formatting methods.
- */
-export declare const DateTimeFormat: Record<string, Intl.DateTimeFormatOptions>;
-/**
- * A date and time object that handles time zones and formatting. This class is
- * immutable and cannot be modified. All modifications are performed by returning
- * a new RockDateTime instance.
- */
-export declare class RockDateTime {
-    /** The internal DateTime object that holds our date information. */
-    private dateTime;
-    /**
-     * Creates a new instance of RockDateTime.
-     *
-     * @param dateTime The Luxon DateTime object that is used to track the internal state.
-     */
-    private constructor();
-    /**
-     * Creates a new instance of RockDateTime from the given date and time parts.
-     *
-     * @param year The year of the new date.
-     * @param month The month of the new date (1-12).
-     * @param day The day of month of the new date.
-     * @param hour The hour of the day.
-     * @param minute The minute of the hour.
-     * @param second The second of the minute.
-     * @param millisecond The millisecond of the second.
-     * @param zone The time zone offset to construct the date in.
-     *
-     * @returns A RockDateTime instance or null if the requested date was not valid.
-     */
-    static fromParts(year: number, month: number, day: number, hour?: number, minute?: number, second?: number, millisecond?: number, zone?: number | string): RockDateTime | null;
-    /**
-     * Creates a new instance of RockDateTime that represents the time specified
-     * as the Javascript milliseconds value. The time zone is set to the browser
-     * time zone.
-     *
-     * @param milliseconds The time in milliseconds since the epoch.
-     *
-     * @returns A new RockDateTime instance or null if the specified date was not valid.
-     */
-    static fromMilliseconds(milliseconds: number): RockDateTime | null;
-    /**
-     * Construct a new RockDateTime instance from a Javascript Date object.
-     *
-     * @param date The Javascript date object that contains the date information.
-     *
-     * @returns A RockDateTime instance or null if the date was not valid.
-     */
-    static fromJSDate(date: Date): RockDateTime | null;
-    /**
-     * Constructs a new RockDateTime instance by parsing the given string from
-     * ISO 8601 format.
-     *
-     * @param dateString The string that contains the ISO 8601 formatted text.
-     *
-     * @returns A new RockDateTime instance or null if the date was not valid.
-     */
-    static parseISO(dateString: string): RockDateTime | null;
-    /**
-     * Constructs a new RockDateTime instance by parsing the given string from
-     * RFC 1123 format. This is common in HTTP headers.
-     *
-     * @param dateString The string that contains the RFC 1123 formatted text.
-     *
-     * @returns A new RockDateTime instance or null if the date was not valid.
-     */
-    static parseHTTP(dateString: string): RockDateTime | null;
-    /**
-     * Creates a new RockDateTime instance that represents the current date and time.
-     *
-     * @returns A RockDateTime instance.
-     */
-    static now(): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the current time in UTC.
-     *
-     * @returns A new RockDateTime instance in the UTC time zone.
-     */
-    static utcNow(): RockDateTime;
-    /**
-     * The Date portion of this RockDateTime instance. All time properties of
-     * the returned instance will be set to 0.
-     */
-    get date(): RockDateTime;
-    /**
-     * The raw date with no offset applied to it. Use this method when you only
-     * care about comparing explicit dates without the time zone, as we do within
-     * the grid's date column filter.
-     *
-     * This API is internal to Rock, and is not subject to the same compatibility
-     * standards as public APIs. It may be changed or removed without notice in any
-     * release. You should not use this API directly in any plug-ins. Doing so can
-     * result in application failures when updating to a new Rock release.
-     */
-    get rawDate(): RockDateTime;
-    /**
-     * The day of the month represented by this instance.
-     */
-    get day(): number;
-    /**
-     * The day of the week represented by this instance.
-     */
-    get dayOfWeek(): DayOfWeek;
-    /**
-     * The day of the year represented by this instance.
-     */
-    get dayOfYear(): number;
-    /**
-     * The hour of the day represented by this instance.
-     */
-    get hour(): number;
-    /**
-     * The millisecond of the second represented by this instance.
-     */
-    get millisecond(): number;
-    /**
-     * The minute of the hour represented by this instance.
-     */
-    get minute(): number;
-    /**
-     * The month of the year represented by this instance (1-12).
-     */
-    get month(): number;
-    /**
-     * The offset from UTC represented by this instance. If the timezone of this
-     * instance is UTC-7 then the value returned is -420.
-     */
-    get offset(): number;
-    /**
-     * The second of the minute represented by this instance.
-     */
-    get second(): number;
-    /**
-     * The year represented by this instance.
-     */
-    get year(): number;
-    /**
-     * Creates a new RockDateTime instance that represents the same point in
-     * time represented in the local browser time zone.
-     */
-    get localDateTime(): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the same point in
-     * time represented in the organization time zone.
-     */
-    get organizationDateTime(): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the same point in
-     * time represented in UTC.
-     */
-    get universalDateTime(): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the date and time
-     * after adding the number of days to this instance.
-     *
-     * @param days The number of days to add.
-     *
-     * @returns A new instance of RockDateTime that represents the new date and time.
-     */
-    addDays(days: number): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the last millisecond
-     * of the end of the month for this instance.
-     *
-     * @example
-     * RockDateTime.fromJSDate(new Date(2014, 3, 3)).endOfMonth().toISOString(); //=> '2014-03-31T23:59:59.999-05:00'
-     */
-    endOfMonth(): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the date and time
-     * after adding the number of hours to this instance.
-     *
-     * @param days The number of hours to add.
-     *
-     * @returns A new instance of RockDateTime that represents the new date and time.
-     */
-    addHours(hours: number): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the date and time
-     * after adding the number of milliseconds to this instance.
-     *
-     * @param days The number of milliseconds to add.
-     *
-     * @returns A new instance of RockDateTime that represents the new date and time.
-     */
-    addMilliseconds(milliseconds: number): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the date and time
-     * after adding the number of minutes to this instance.
-     *
-     * @param days The number of minutes to add.
-     *
-     * @returns A new instance of RockDateTime that represents the new date and time.
-     */
-    addMinutes(minutes: number): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the date and time
-     * after adding the number of months to this instance.
-     *
-     * @param days The number of months to add.
-     *
-     * @returns A new instance of RockDateTime that represents the new date and time.
-     */
-    addMonths(months: number): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the date and time
-     * after adding the number of seconds to this instance.
-     *
-     * @param days The number of seconds to add.
-     *
-     * @returns A new instance of RockDateTime that represents the new date and time.
-     */
-    addSeconds(seconds: number): RockDateTime;
-    /**
-     * Creates a new RockDateTime instance that represents the date and time
-     * after adding the number of years to this instance.
-     *
-     * @param days The number of years to add.
-     *
-     * @returns A new instance of RockDateTime that represents the new date and time.
-     */
-    addYears(years: number): RockDateTime;
-    /**
-     * Converts the date time representation into the number of milliseconds
-     * that have elapsed since the epoch (1970-01-01T00:00:00Z).
-     *
-     * @returns The number of milliseconds since the epoch.
-     */
-    toMilliseconds(): number;
-    /**
-     * Creates a new instance of RockDateTime that represents the same point
-     * in time as represented by the specified time zone offset.
-     *
-     * @param zone The time zone offset as a number or string such as "UTC+4".
-     *
-     * @returns A new RockDateTime instance that represents the specified time zone.
-     */
-    toOffset(zone: number | string): RockDateTime;
-    /**
-     * Formats this instance according to C# formatting rules.
-     *
-     * @param format The string that specifies the format to use.
-     *
-     * @returns A string representing this instance in the given format.
-     */
-    toASPString(format: string): string;
-    /**
-     * Creates a string representation of this instance in ISO8601 format.
-     *
-     * @returns An ISO8601 formatted string.
-     */
-    toISOString(): string;
-    /**
-     * Formats this instance using standard locale formatting rules to display
-     * a date and time in the browsers specified locale.
-     *
-     * @param format The format to use when generating the string.
-     *
-     * @returns A string that represents the date and time in then specified format.
-     */
-    toLocaleString(format: Intl.DateTimeFormatOptions): string;
-    /**
-     * Transforms the date into a human friendly elapsed time string.
-     *
-     * @example
-     * // Returns "21yrs"
-     * RockDateTime.fromParts(2000, 3, 4).toElapsedString();
-     *
-     * @returns A string that represents the amount of time that has elapsed.
-     */
-    toElapsedString(currentDateTime?: RockDateTime): string;
-    /**
-     * Formats this instance as a string that can be used in HTTP headers and
-     * cookies.
-     *
-     * @returns A new string that conforms to RFC 1123
-     */
-    toHTTPString(): string;
-    /**
-     * Get the value of the date and time in a format that can be used in
-     * comparisons.
-     *
-     * @returns A number that represents the date and time.
-     */
-    valueOf(): number;
-    /**
-     * Creates a standard string representation of the date and time.
-     *
-     * @returns A string representation of the date and time.
-     */
-    toString(): string;
-    /**
-     * Checks if this instance is equal to another RockDateTime instance. This
-     * will return true if the two instances represent the same point in time,
-     * even if they have been associated with different time zones. In other
-     * words "2021-09-08 12:00:00 Z" == "2021-09-08 14:00:00 UTC+2".
-     *
-     * @param otherDateTime The other RockDateTime to be compared against.
-     *
-     * @returns True if the two instances represent the same point in time.
-     */
-    isEqualTo(otherDateTime: RockDateTime): boolean;
-    /**
-     * Checks if this instance is later than another RockDateTime instance.
-     *
-     * @param otherDateTime The other RockDateTime to be compared against.
-     *
-     * @returns True if this instance represents a point in time that occurred after another point in time, regardless of time zone.
-     */
-    isLaterThan(otherDateTime: RockDateTime): boolean;
-    /**
-     * Checks if this instance is earlier than another RockDateTime instance.
-     *
-     * @param otherDateTime The other RockDateTime to be compared against.
-     *
-     * @returns True if this instance represents a point in time that occurred before another point in time, regardless of time zone.
-     */
-    isEarlierThan(otherDateTime: RockDateTime): boolean;
-    /**
-     * Calculates the elapsed time between this date and the reference date and
-     * returns that difference in a human friendly way.
-     *
-     * @param otherDateTime The reference date and time. If not specified then 'now' is used.
-     *
-     * @returns A string that represents the elapsed time.
-     */
-    humanizeElapsed(otherDateTime?: RockDateTime): string;
-    /**
-     * The total number of months between the two dates.
-     * @param otherDateTime The reference date and time.
-     * @returns An int that represents the number of months between the two dates.
-     */
-    totalMonths(otherDateTime: RockDateTime): number;
-}
+import { DayOfWeek } from "@Obsidian/Enums/Controls/dayOfWeek";
+/**
+ * The days of the week that are used by RockDateTime.
+ */
+export { DayOfWeek } from "@Obsidian/Enums/Controls/dayOfWeek";
+/**
+ * The various date and time formats supported by the formatting methods.
+ */
+export declare const DateTimeFormat: Record<string, Intl.DateTimeFormatOptions>;
+/**
+ * A date and time object that handles time zones and formatting. This class is
+ * immutable and cannot be modified. All modifications are performed by returning
+ * a new RockDateTime instance.
+ */
+export declare class RockDateTime {
+    /** The internal DateTime object that holds our date information. */
+    private dateTime;
+    /**
+     * Creates a new instance of RockDateTime.
+     *
+     * @param dateTime The Luxon DateTime object that is used to track the internal state.
+     */
+    private constructor();
+    /**
+     * Creates a new instance of RockDateTime from the given date and time parts.
+     *
+     * @param year The year of the new date.
+     * @param month The month of the new date (1-12).
+     * @param day The day of month of the new date.
+     * @param hour The hour of the day.
+     * @param minute The minute of the hour.
+     * @param second The second of the minute.
+     * @param millisecond The millisecond of the second.
+     * @param zone The time zone offset to construct the date in.
+     *
+     * @returns A RockDateTime instance or null if the requested date was not valid.
+     */
+    static fromParts(year: number, month: number, day: number, hour?: number, minute?: number, second?: number, millisecond?: number, zone?: number | string): RockDateTime | null;
+    /**
+     * Creates a new instance of RockDateTime that represents the time specified
+     * as the Javascript milliseconds value. The time zone is set to the browser
+     * time zone.
+     *
+     * @param milliseconds The time in milliseconds since the epoch.
+     *
+     * @returns A new RockDateTime instance or null if the specified date was not valid.
+     */
+    static fromMilliseconds(milliseconds: number): RockDateTime | null;
+    /**
+     * Construct a new RockDateTime instance from a Javascript Date object.
+     *
+     * @param date The Javascript date object that contains the date information.
+     *
+     * @returns A RockDateTime instance or null if the date was not valid.
+     */
+    static fromJSDate(date: Date): RockDateTime | null;
+    /**
+     * Constructs a new RockDateTime instance by parsing the given string from
+     * ISO 8601 format.
+     *
+     * @param dateString The string that contains the ISO 8601 formatted text.
+     *
+     * @returns A new RockDateTime instance or null if the date was not valid.
+     */
+    static parseISO(dateString: string): RockDateTime | null;
+    /**
+     * Constructs a new RockDateTime instance by parsing the given string from
+     * RFC 1123 format. This is common in HTTP headers.
+     *
+     * @param dateString The string that contains the RFC 1123 formatted text.
+     *
+     * @returns A new RockDateTime instance or null if the date was not valid.
+     */
+    static parseHTTP(dateString: string): RockDateTime | null;
+    /**
+     * Creates a new RockDateTime instance that represents the current date and time.
+     *
+     * @returns A RockDateTime instance.
+     */
+    static now(): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the current time in UTC.
+     *
+     * @returns A new RockDateTime instance in the UTC time zone.
+     */
+    static utcNow(): RockDateTime;
+    /**
+     * The Date portion of this RockDateTime instance. All time properties of
+     * the returned instance will be set to 0.
+     */
+    get date(): RockDateTime;
+    /**
+     * The raw date with no offset applied to it. Use this method when you only
+     * care about comparing explicit dates without the time zone, as we do within
+     * the grid's date column filter.
+     *
+     * This API is internal to Rock, and is not subject to the same compatibility
+     * standards as public APIs. It may be changed or removed without notice in any
+     * release. You should not use this API directly in any plug-ins. Doing so can
+     * result in application failures when updating to a new Rock release.
+     */
+    get rawDate(): RockDateTime;
+    /**
+     * The day of the month represented by this instance.
+     */
+    get day(): number;
+    /**
+     * The day of the week represented by this instance.
+     */
+    get dayOfWeek(): DayOfWeek;
+    /**
+     * The day of the year represented by this instance.
+     */
+    get dayOfYear(): number;
+    /**
+     * The hour of the day represented by this instance.
+     */
+    get hour(): number;
+    /**
+     * The millisecond of the second represented by this instance.
+     */
+    get millisecond(): number;
+    /**
+     * The minute of the hour represented by this instance.
+     */
+    get minute(): number;
+    /**
+     * The month of the year represented by this instance (1-12).
+     */
+    get month(): number;
+    /**
+     * The offset from UTC represented by this instance. If the timezone of this
+     * instance is UTC-7 then the value returned is -420.
+     */
+    get offset(): number;
+    /**
+     * The second of the minute represented by this instance.
+     */
+    get second(): number;
+    /**
+     * The year represented by this instance.
+     */
+    get year(): number;
+    /**
+     * Creates a new RockDateTime instance that represents the same point in
+     * time represented in the local browser time zone.
+     */
+    get localDateTime(): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the same point in
+     * time represented in the organization time zone.
+     */
+    get organizationDateTime(): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the same point in
+     * time represented in UTC.
+     */
+    get universalDateTime(): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the date and time
+     * after adding the number of days to this instance.
+     *
+     * @param days The number of days to add.
+     *
+     * @returns A new instance of RockDateTime that represents the new date and time.
+     */
+    addDays(days: number): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the last millisecond
+     * of the end of the month for this instance.
+     *
+     * @example
+     * RockDateTime.fromJSDate(new Date(2014, 3, 3)).endOfMonth().toISOString(); //=> '2014-03-31T23:59:59.999-05:00'
+     */
+    endOfMonth(): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the date and time
+     * after adding the number of hours to this instance.
+     *
+     * @param days The number of hours to add.
+     *
+     * @returns A new instance of RockDateTime that represents the new date and time.
+     */
+    addHours(hours: number): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the date and time
+     * after adding the number of milliseconds to this instance.
+     *
+     * @param days The number of milliseconds to add.
+     *
+     * @returns A new instance of RockDateTime that represents the new date and time.
+     */
+    addMilliseconds(milliseconds: number): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the date and time
+     * after adding the number of minutes to this instance.
+     *
+     * @param days The number of minutes to add.
+     *
+     * @returns A new instance of RockDateTime that represents the new date and time.
+     */
+    addMinutes(minutes: number): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the date and time
+     * after adding the number of months to this instance.
+     *
+     * @param days The number of months to add.
+     *
+     * @returns A new instance of RockDateTime that represents the new date and time.
+     */
+    addMonths(months: number): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the date and time
+     * after adding the number of seconds to this instance.
+     *
+     * @param days The number of seconds to add.
+     *
+     * @returns A new instance of RockDateTime that represents the new date and time.
+     */
+    addSeconds(seconds: number): RockDateTime;
+    /**
+     * Creates a new RockDateTime instance that represents the date and time
+     * after adding the number of years to this instance.
+     *
+     * @param days The number of years to add.
+     *
+     * @returns A new instance of RockDateTime that represents the new date and time.
+     */
+    addYears(years: number): RockDateTime;
+    /**
+     * Converts the date time representation into the number of milliseconds
+     * that have elapsed since the epoch (1970-01-01T00:00:00Z).
+     *
+     * @returns The number of milliseconds since the epoch.
+     */
+    toMilliseconds(): number;
+    /**
+     * Creates a new instance of RockDateTime that represents the same point
+     * in time as represented by the specified time zone offset.
+     *
+     * @param zone The time zone offset as a number or string such as "UTC+4".
+     *
+     * @returns A new RockDateTime instance that represents the specified time zone.
+     */
+    toOffset(zone: number | string): RockDateTime;
+    /**
+     * Formats this instance according to C# formatting rules.
+     *
+     * @param format The string that specifies the format to use.
+     *
+     * @returns A string representing this instance in the given format.
+     */
+    toASPString(format: string): string;
+    /**
+     * Creates a string representation of this instance in ISO8601 format.
+     *
+     * @returns An ISO8601 formatted string.
+     */
+    toISOString(): string;
+    /**
+     * Formats this instance using standard locale formatting rules to display
+     * a date and time in the browsers specified locale.
+     *
+     * @param format The format to use when generating the string.
+     *
+     * @returns A string that represents the date and time in then specified format.
+     */
+    toLocaleString(format: Intl.DateTimeFormatOptions): string;
+    /**
+     * Transforms the date into a human friendly elapsed time string.
+     *
+     * @example
+     * // Returns "21yrs"
+     * RockDateTime.fromParts(2000, 3, 4).toElapsedString();
+     *
+     * @returns A string that represents the amount of time that has elapsed.
+     */
+    toElapsedString(currentDateTime?: RockDateTime): string;
+    /**
+     * Formats this instance as a string that can be used in HTTP headers and
+     * cookies.
+     *
+     * @returns A new string that conforms to RFC 1123
+     */
+    toHTTPString(): string;
+    /**
+     * Get the value of the date and time in a format that can be used in
+     * comparisons.
+     *
+     * @returns A number that represents the date and time.
+     */
+    valueOf(): number;
+    /**
+     * Creates a standard string representation of the date and time.
+     *
+     * @returns A string representation of the date and time.
+     */
+    toString(): string;
+    /**
+     * Checks if this instance is equal to another RockDateTime instance. This
+     * will return true if the two instances represent the same point in time,
+     * even if they have been associated with different time zones. In other
+     * words "2021-09-08 12:00:00 Z" == "2021-09-08 14:00:00 UTC+2".
+     *
+     * @param otherDateTime The other RockDateTime to be compared against.
+     *
+     * @returns True if the two instances represent the same point in time.
+     */
+    isEqualTo(otherDateTime: RockDateTime): boolean;
+    /**
+     * Checks if this instance is later than another RockDateTime instance.
+     *
+     * @param otherDateTime The other RockDateTime to be compared against.
+     *
+     * @returns True if this instance represents a point in time that occurred after another point in time, regardless of time zone.
+     */
+    isLaterThan(otherDateTime: RockDateTime): boolean;
+    /**
+     * Checks if this instance is earlier than another RockDateTime instance.
+     *
+     * @param otherDateTime The other RockDateTime to be compared against.
+     *
+     * @returns True if this instance represents a point in time that occurred before another point in time, regardless of time zone.
+     */
+    isEarlierThan(otherDateTime: RockDateTime): boolean;
+    /**
+     * Obsolete. Use toElapsedString instead.
+     * Calculates the elapsed time between this date and the reference date and
+     * returns that difference in a human friendly way.
+     *
+     * @param otherDateTime The reference date and time. If not specified then 'now' is used.
+     *
+     * @returns A string that represents the elapsed time.
+     */
+    humanizeElapsed(otherDateTime?: RockDateTime): string;
+    /**
+     * The total number of months between the two dates.
+     * @param otherDateTime The reference date and time.
+     * @returns An int that represents the number of months between the two dates.
+     */
+    totalMonths(otherDateTime: RockDateTime): number;
+}