scdate 2.1.1 → 3.1.0

package/README.md

@@ -29,7 +29,20 @@ yarn add scdate
 ## Basic Usage
 
 ```typescript
-import { sDate, sTime, sTimestamp, sWeekdays, Weekday } from 'scdate'
+import {
+  sDate,
+  sTime,
+  sTimestamp,
+  sWeekdays,
+  Weekday,
+  getDateToday,
+  getNextDateByWeekday,
+  getTimeNow,
+  addMinutesToTime,
+  getTimestampNow,
+  getTimestampFromDateAndTime,
+  getWeekdaysFromWeekdayFlags,
+} from 'scdate'
 
 // Working with dates
 const today = getDateToday('America/Puerto_Rico')
@@ -59,7 +72,7 @@ const businessDays = getWeekdaysFromWeekdayFlags(
 ```typescript
 // Creating dates
 const date1 = sDate('2023-12-25') // From ISO string
-const date2 = getDateToday('America/Puerto_Rico') // Current date in timezone
+const date2 = getDateToday('America/Puerto_Rico') // Current date in time zone
 const date3 = getDateForFirstDayOfMonth(date1) // First day of month
 const date4 = getDateForLastDayOfMonth(date1) // Last day of month
 
@@ -81,7 +94,7 @@ const prevFriday = getPreviousDateByWeekday(date1, Weekday.Fri)
 // Date calculations
 const daysBetween = getDaysBetweenDates(date1, date2) // Days between dates (positive if date2 is later)
 const utcMs = getUTCMillisecondsFromDate(date1, 'America/Puerto_Rico') // Convert to UTC milliseconds
-const zonedDate = getTimeZonedDateFromDate(date1, 'America/Puerto_Rico') // Get timezone-adjusted Date
+const zonedDate = getTimeZonedDateFromDate(date1, 'America/Puerto_Rico') // Get time-zone-adjusted Date
 
 // Date comparison
 const isEqual = isSameDate(date1, date2)
@@ -137,7 +150,7 @@ const shortDateStr = getShortDateString(date1, 'America/Puerto_Rico', 'en-US', {
 ```typescript
 // Creating times
 const time1 = sTime('14:30') // From ISO string
-const time2 = getTimeNow('America/Puerto_Rico') // Current time in timezone
+const time2 = getTimeNow('America/Puerto_Rico') // Current time in time zone
 const time3 = getTimeAtMidnight() // 00:00
 const time4 = getTimeFromMinutes(60) // 01:00 (60 minutes after midnight)
 
@@ -182,7 +195,7 @@ const isPM = isTimePM(time1)
 ```typescript
 // Creating timestamps
 const ts1 = sTimestamp('2023-12-25T14:30') // From ISO string
-const ts2 = getTimestampNow('America/Puerto_Rico') // Current timestamp in timezone
+const ts2 = getTimestampNow('America/Puerto_Rico') // Current timestamp in time zone
 const ts3 = getTimestampFromDateAndTime(date1, time1) // From date and time
 const ts4 = getTimestampFromUTCMilliseconds(
   1640444400000,
@@ -251,9 +264,15 @@ const filteredWeekdays = filterWeekdaysForDates(
 )
 const updatedWeekdays = addWeekdayToWeekdays(weekdays5, Weekday.Fri) // Add Friday to pattern
 
+// Weekday navigation
+const previousDay = getPreviousWeekday(Weekday.Mon) // Returns Weekday.Sun
+const nextDay = getNextWeekday(Weekday.Mon) // Returns Weekday.Tue
+
 // Weekday queries
 const includesMonday = doesWeekdaysIncludeWeekday(weekdays2, Weekday.Mon)
 const hasOverlap = doesWeekdaysHaveOverlapWithWeekdays(weekdays2, weekdays3)
+const areEqual = areWeekdaysEqual(weekdays1, weekdays4) // true (both all days)
+const isEmpty = isWeekdaysEmpty(weekdays5) // true (no days)
 ```
 
 #### Important Behaviors and Edge Cases
@@ -292,7 +311,14 @@ scDate intentionally omits seconds and milliseconds from time representations. T
 - Simpler time representations lead to more intuitive API and usage patterns
 - Performance is optimized by avoiding unnecessary precision
 
-## Time zones
+## Time Zones
+
+```typescript
+import { isValidTimeZone } from 'scdate'
+
+isValidTimeZone('America/New_York') // true
+isValidTimeZone('Invalid/Timezone') // false
+```
 
 For a list of valid time zones run `Intl.supportedValuesOf('timeZone')` in your environment.
 

package/dist/constants.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Weekday flags for use with bitwise operations. Each value is a power of 2,
+ * allowing multiple days to be combined using the bitwise OR operator.
+ *
+ * @example
+ * ```ts
+ * // Combine weekdays with bitwise OR
+ * const weekendDays = Weekday.Sat | Weekday.Sun
+ *
+ * // Business days
+ * const businessDays =
+ *   Weekday.Mon | Weekday.Tue | Weekday.Wed | Weekday.Thu | Weekday.Fri
+ * ```
+ */
 export declare enum Weekday {
     Sun = 1,
     Mon = 2,

package/dist/constants.js

@@ -1,3 +1,17 @@
+/**
+ * Weekday flags for use with bitwise operations. Each value is a power of 2,
+ * allowing multiple days to be combined using the bitwise OR operator.
+ *
+ * @example
+ * ```ts
+ * // Combine weekdays with bitwise OR
+ * const weekendDays = Weekday.Sat | Weekday.Sun
+ *
+ * // Business days
+ * const businessDays =
+ *   Weekday.Mon | Weekday.Tue | Weekday.Wed | Weekday.Thu | Weekday.Fri
+ * ```
+ */
 export var Weekday;
 (function (Weekday) {
     Weekday[Weekday["Sun"] = 1] = "Sun";

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './constants.js';
+export * from './isValidTimeZone.js';
 export * from './sDate.js';
 export * from './sTime.js';
 export * from './sTimestamp.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './constants.js';
+export * from './isValidTimeZone.js';
 export * from './sDate.js';
 export * from './sTime.js';
 export * from './sTimestamp.js';

package/dist/isValidTimeZone.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Checks if a string is a valid IANA time zone identifier.
+ *
+ * @param timeZone The string to validate as an IANA time zone identifier.
+ */
+export declare const isValidTimeZone: (timeZone: string) => boolean;

package/dist/isValidTimeZone.js

@@ -0,0 +1,14 @@
+/**
+ * Checks if a string is a valid IANA time zone identifier.
+ *
+ * @param timeZone The string to validate as an IANA time zone identifier.
+ */
+export const isValidTimeZone = (timeZone) => {
+    try {
+        const validTimeZones = Intl.supportedValuesOf('timeZone');
+        return validTimeZones.includes(timeZone);
+    }
+    catch {
+        return false;
+    }
+};

package/dist/sDate.d.ts

@@ -1,7 +1,15 @@
 import { Weekday } from './constants.js';
 import { SDate } from './internal/SDate.js';
+/**
+ * Options for customizing the short date string representation.
+ */
 export interface SDateShortStringOptions {
+    /** Whether to include the abbreviated weekday name in the output. */
     includeWeekday: boolean;
+    /**
+     * Called when the date is today. Return value is used as the display
+     * text.
+     */
     onTodayText: () => string;
 }
 /**
@@ -25,7 +33,7 @@ export declare const sDate: (date: string | SDate) => SDate;
 export declare const getDateToday: (timeZone: string) => SDate;
 /**
  * Returns a new SDate instance set to the next date after the provided date
- * that match the given weekday.
+ * that matches the given weekday.
  *
  * @param date The date to start from (not included). It can be an SDate or a
  * string in the YYYY-MM-DD format.
@@ -33,12 +41,12 @@ export declare const getDateToday: (timeZone: string) => SDate;
  */
 export declare const getNextDateByWeekday: (date: string | SDate, weekday: Weekday) => SDate;
 /**
- * Returns a new SDate instance set to date that is before the provided date and
- * matches the given weekday.
+ * Returns a new SDate instance set to the date that is before the provided date
+ * and matches the given weekday.
  *
- * @param date The date to start from (not included).
- * @param weekday The weekday to find the previous date for. It can be an SDate
- * or a string in the YYYY-MM-DD format.
+ * @param date The date to start from (not included). It can be an SDate or a
+ * string in the YYYY-MM-DD format.
+ * @param weekday The weekday to find the previous date for.
  */
 export declare const getPreviousDateByWeekday: (date: string | SDate, weekday: Weekday) => SDate;
 /**
@@ -53,8 +61,8 @@ export declare const getDateForFirstDayOfMonth: (date: string | SDate) => SDate;
  * Returns a new SDate instance set to the last day of the month for the
  * provided date.
  *
- * @param date The date to get the last day of the month for. It can be an SDate
- * or a string in the YYYY-MM-DD format.
+ * @param date The date to get the last day of the month for. It can be an
+ * SDate or a string in the YYYY-MM-DD format.
  */
 export declare const getDateForLastDayOfMonth: (date: string | SDate) => SDate;
 /**
@@ -63,31 +71,31 @@ export declare const getDateForLastDayOfMonth: (date: string | SDate) => SDate;
 /**
  * Returns the year from the given date.
  *
- * @param date The date to get the year from. It can be an SDate or a string in
- * the YYYY-MM-DD format.
+ * @param date The date to get the year from. It can be an SDate or a string
+ * in the YYYY-MM-DD format.
  */
 export declare const getYearFromDate: (date: string | SDate) => number;
 /**
- * Returns the month from the given date. Returns a 0-index value (i.e. Janary
+ * Returns the month from the given date. Returns a 0-index value (i.e. January
  * is 0 and December is 11) to match the result from native Date object.
  *
- * @param date The date to get the month from. It can be an SDate or a string in
- * the YYYY-MM-DD format.
+ * @param date The date to get the month from. It can be an SDate or a string
+ * in the YYYY-MM-DD format.
  */
 export declare const getMonthFromDate: (date: string | SDate) => number;
 /**
  * Returns the day of the month from the given date.
  *
- * @param date The date to get the day from. It can be an SDate or a string in
- * the YYYY-MM-DD format.
+ * @param date The date to get the day from. It can be an SDate or a string
+ * in the YYYY-MM-DD format.
  */
 export declare const getDateFromDate: (date: string | SDate) => number;
 /**
  * Returns the day of the week from the given date (Sunday to Saturday / 0 to
  * 6).
  *
- * @param date The date to get the weekday from. It can be an SDate or a string
- * in the YYYY-MM-DD format.
+ * @param date The date to get the weekday from. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  */
 export declare const getWeekdayFromDate: (date: string | SDate) => number;
 /**
@@ -104,8 +112,8 @@ export declare const getUTCMillisecondsFromDate: (date: string | SDate, timeZone
  * Returns a native Date adjusted so that the local time of that date matches
  * the local time at the specified time zone.
  *
- * @param date The date to get the time zoned date from. It can be an SDate or a
- * string in the YYYY-MM-DD format.
+ * @param date The date to get the time zoned date from. It can be an SDate
+ * or a string in the YYYY-MM-DD format.
  * @param timeZone The time zone to adjust the date to. See
  * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
  */
@@ -117,18 +125,18 @@ export declare const getTimeZonedDateFromDate: (date: string | SDate, timeZone:
  * and not full 24-hour periods which could be different due to daylight saving
  * adjustments.
  *
- * @param date1 The first date to get the days between. It can be an SDate or a
- * string in the YYYY-MM-DD format.
- * @param date2 The second date to get the days between. It can be an SDate or a
- * string in the YYYY-MM-DD format.
+ * @param date1 The first date to get the days between. It can be an SDate or
+ * a string in the YYYY-MM-DD format.
+ * @param date2 The second date to get the days between. It can be an SDate
+ * or a string in the YYYY-MM-DD format.
  */
 export declare const getDaysBetweenDates: (date1: string | SDate, date2: string | SDate) => number;
 /**
  * Returns a string representation that includes all of the date components of
  * the given date formatted according to the given locale.
  *
- * @param date The date to get the full string representation for. It can be an
- * SDate or a string in the YYYY-MM-DD format.
+ * @param date The date to get the full string representation for. It can be
+ * an SDate or a string in the YYYY-MM-DD format.
  * @param locale The locale to use for the string representation.
  *
  * @example
@@ -147,10 +155,10 @@ export declare const getFullDateString: (date: string | SDate, locale: Intl.Loca
 /**
  * Get the short string representation of the given date in the given locale.
  *
- * @param date The date to get the short string representation for. It can be an
- * SDate or a string in the YYYY-MM-DD format.
- * @param timeZone The time zone used to determine if in the current year. See
- * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
+ * @param date The date to get the short string representation for. It can be
+ * an SDate or a string in the YYYY-MM-DD format.
+ * @param timeZone The time zone used to determine if in the current year.
+ * See `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
  * @param locale The locale to use for the string representation.
  * @param options The options to customize the short string representation.
  *
@@ -177,7 +185,7 @@ export declare const getShortDateString: (date: string | SDate, timeZone: string
  * --- Operations ---
  */
 /**
- * Returns a new SDates instance with the date resulting from adding the given
+ * Returns a new SDate instance with the date resulting from adding the given
  * number of days to the given date. Because it adds calendar days rather than
  * 24-hour days, this operation is not affected by time zones.
  *
@@ -252,8 +260,8 @@ export declare const addYearsToDate: (date: string | SDate, years: number) => SD
  * Returns true when the two given dates represent the same day and false
  * otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a string in
+ * the YYYY-MM-DD format.
  * @param date2 The second date to compare. It can be an SDate or a string in
  * the YYYY-MM-DD format.
  */
@@ -262,8 +270,8 @@ export declare const isSameDate: (date1: string | SDate, date2: string | SDate)
  * Returns true when the first date represents a date before the second date and
  * false otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a string in
+ * the YYYY-MM-DD format.
  * @param date2 The second date to compare. It can be an SDate or a string in
  * the YYYY-MM-DD format.
  */

package/dist/sDate.js

@@ -36,7 +36,7 @@ export const getDateToday = (timeZone) => {
 };
 /**
  * Returns a new SDate instance set to the next date after the provided date
- * that match the given weekday.
+ * that matches the given weekday.
  *
  * @param date The date to start from (not included). It can be an SDate or a
  * string in the YYYY-MM-DD format.
@@ -54,12 +54,12 @@ export const getNextDateByWeekday = (date, weekday) => {
     return addDaysToDate(sDateValue, adjustment);
 };
 /**
- * Returns a new SDate instance set to date that is before the provided date and
- * matches the given weekday.
+ * Returns a new SDate instance set to the date that is before the provided date
+ * and matches the given weekday.
  *
- * @param date The date to start from (not included).
- * @param weekday The weekday to find the previous date for. It can be an SDate
- * or a string in the YYYY-MM-DD format.
+ * @param date The date to start from (not included). It can be an SDate or a
+ * string in the YYYY-MM-DD format.
+ * @param weekday The weekday to find the previous date for.
  */
 export const getPreviousDateByWeekday = (date, weekday) => {
     const sDateValue = sDate(date);
@@ -89,8 +89,8 @@ export const getDateForFirstDayOfMonth = (date) => {
  * Returns a new SDate instance set to the last day of the month for the
  * provided date.
  *
- * @param date The date to get the last day of the month for. It can be an SDate
- * or a string in the YYYY-MM-DD format.
+ * @param date The date to get the last day of the month for. It can be an
+ * SDate or a string in the YYYY-MM-DD format.
  */
 export const getDateForLastDayOfMonth = (date) => {
     const sDateValue = sDate(date);
@@ -105,19 +105,19 @@ export const getDateForLastDayOfMonth = (date) => {
 /**
  * Returns the year from the given date.
  *
- * @param date The date to get the year from. It can be an SDate or a string in
- * the YYYY-MM-DD format.
+ * @param date The date to get the year from. It can be an SDate or a string
+ * in the YYYY-MM-DD format.
  */
 export const getYearFromDate = (date) => {
     const sDateValue = sDate(date);
     return Number(getISOYearFromISODate(sDateValue.date));
 };
 /**
- * Returns the month from the given date. Returns a 0-index value (i.e. Janary
+ * Returns the month from the given date. Returns a 0-index value (i.e. January
  * is 0 and December is 11) to match the result from native Date object.
  *
- * @param date The date to get the month from. It can be an SDate or a string in
- * the YYYY-MM-DD format.
+ * @param date The date to get the month from. It can be an SDate or a string
+ * in the YYYY-MM-DD format.
  */
 export const getMonthFromDate = (date) => {
     const sDateValue = sDate(date);
@@ -126,8 +126,8 @@ export const getMonthFromDate = (date) => {
 /**
  * Returns the day of the month from the given date.
  *
- * @param date The date to get the day from. It can be an SDate or a string in
- * the YYYY-MM-DD format.
+ * @param date The date to get the day from. It can be an SDate or a string
+ * in the YYYY-MM-DD format.
  */
 export const getDateFromDate = (date) => {
     const sDateValue = sDate(date);
@@ -137,8 +137,8 @@ export const getDateFromDate = (date) => {
  * Returns the day of the week from the given date (Sunday to Saturday / 0 to
  * 6).
  *
- * @param date The date to get the weekday from. It can be an SDate or a string
- * in the YYYY-MM-DD format.
+ * @param date The date to get the weekday from. It can be an SDate or a
+ * string in the YYYY-MM-DD format.
  */
 export const getWeekdayFromDate = (date) => {
     const sDateValue = sDate(date);
@@ -167,8 +167,8 @@ export const getUTCMillisecondsFromDate = (date, timeZone) => {
  * Returns a native Date adjusted so that the local time of that date matches
  * the local time at the specified time zone.
  *
- * @param date The date to get the time zoned date from. It can be an SDate or a
- * string in the YYYY-MM-DD format.
+ * @param date The date to get the time zoned date from. It can be an SDate
+ * or a string in the YYYY-MM-DD format.
  * @param timeZone The time zone to adjust the date to. See
  * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
  */
@@ -185,10 +185,10 @@ export const getTimeZonedDateFromDate = (date, timeZone) => {
  * and not full 24-hour periods which could be different due to daylight saving
  * adjustments.
  *
- * @param date1 The first date to get the days between. It can be an SDate or a
- * string in the YYYY-MM-DD format.
- * @param date2 The second date to get the days between. It can be an SDate or a
- * string in the YYYY-MM-DD format.
+ * @param date1 The first date to get the days between. It can be an SDate or
+ * a string in the YYYY-MM-DD format.
+ * @param date2 The second date to get the days between. It can be an SDate
+ * or a string in the YYYY-MM-DD format.
  */
 export const getDaysBetweenDates = (date1, date2) => {
     const sDate1 = sDate(date1);
@@ -201,8 +201,8 @@ export const getDaysBetweenDates = (date1, date2) => {
  * Returns a string representation that includes all of the date components of
  * the given date formatted according to the given locale.
  *
- * @param date The date to get the full string representation for. It can be an
- * SDate or a string in the YYYY-MM-DD format.
+ * @param date The date to get the full string representation for. It can be
+ * an SDate or a string in the YYYY-MM-DD format.
  * @param locale The locale to use for the string representation.
  *
  * @example
@@ -228,10 +228,10 @@ export const getFullDateString = (date, locale) => {
 /**
  * Get the short string representation of the given date in the given locale.
  *
- * @param date The date to get the short string representation for. It can be an
- * SDate or a string in the YYYY-MM-DD format.
- * @param timeZone The time zone used to determine if in the current year. See
- * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
+ * @param date The date to get the short string representation for. It can be
+ * an SDate or a string in the YYYY-MM-DD format.
+ * @param timeZone The time zone used to determine if in the current year.
+ * See `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
  * @param locale The locale to use for the string representation.
  * @param options The options to customize the short string representation.
  *
@@ -272,7 +272,7 @@ export const getShortDateString = (date, timeZone, locale, options) => {
  * --- Operations ---
  */
 /**
- * Returns a new SDates instance with the date resulting from adding the given
+ * Returns a new SDate instance with the date resulting from adding the given
  * number of days to the given date. Because it adds calendar days rather than
  * 24-hour days, this operation is not affected by time zones.
  *
@@ -376,8 +376,8 @@ export const addYearsToDate = (date, years) => {
  * Returns true when the two given dates represent the same day and false
  * otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a string in
+ * the YYYY-MM-DD format.
  * @param date2 The second date to compare. It can be an SDate or a string in
  * the YYYY-MM-DD format.
  */
@@ -390,8 +390,8 @@ export const isSameDate = (date1, date2) => {
  * Returns true when the first date represents a date before the second date and
  * false otherwise.
  *
- * @param date1 The first date to compare. It can be an SDate or a string in the
- * YYYY-MM-DD format.
+ * @param date1 The first date to compare. It can be an SDate or a string in
+ * the YYYY-MM-DD format.
  * @param date2 The second date to compare. It can be an SDate or a string in
  * the YYYY-MM-DD format.
  */

package/dist/sTime.d.ts

@@ -5,7 +5,7 @@ import { STime } from './internal/STime.js';
 /**
  * Returns a new STime instance.
  *
- * @param time And instance of STime or a string in the format 'HH:MM'.
+ * @param time An instance of STime or a string in the format 'HH:MM'.
  */
 export declare const sTime: (time: string | STime) => STime;
 /**

package/dist/sTime.js

@@ -8,7 +8,7 @@ import { getTimeZonedDate } from './internal/zoned.js';
 /**
  * Returns a new STime instance.
  *
- * @param time And instance of STime or a string in the format 'HH:MM'.
+ * @param time An instance of STime or a string in the format 'HH:MM'.
  */
 export const sTime = (time) => {
     if (time instanceof STime) {

package/dist/sTimestamp.d.ts

@@ -1,8 +1,15 @@
 import { SDate } from './internal/SDate.js';
 import { STime } from './internal/STime.js';
 import { STimestamp } from './internal/STimestamp.js';
+/**
+ * Options for customizing the short timestamp string representation.
+ */
 export interface STimestampShortStringOptions {
+    /** Whether to include the abbreviated weekday name in the output. */
     includeWeekday: boolean;
+    /**
+     * Called when the timestamp is today. Return value is used as prefix text.
+     */
     onTodayAtText: () => string;
 }
 /**
@@ -66,9 +73,9 @@ export declare const getUTCMillisecondsFromTimestamp: (timestamp: string | STime
  * Returns a native Date adjusted so that the local time of that date matches
  * the local timestamp at the specified time zone.
  *
- * @param date The date to get the time zoned date from. It can be an SDate or a
- * string in the YYYY-MM-DD format.
- * @param timeZone The time zone to adjust the date to. See
+ * @param timestamp The timestamp to get the time zoned date from. It can be
+ * an STimestamp or a string in the YYYY-MM-DDTHH:MM format.
+ * @param timeZone The time zone to adjust the timestamp to. See
  * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
  */
 export declare const getTimeZonedDateFromTimestamp: (timestamp: string | STimestamp, timeZone: string) => Date;
@@ -230,7 +237,7 @@ export declare const addDaysToTimestamp: (timestamp: string | STimestamp, days:
  * 2024-03-10T02:00 (a time that technically does not exist on a watch that
  * automatically adjusts for Daylight Saving) will result in 2024-03-10T01:01.
  * This is because 2024-03-10T02:00 is converted to 2024-03-10T06:00 UTC (due
- * to timezone offset being -4 starting from 02:00 local time) and one minute
+ * to time zone offset being -4 starting from 02:00 local time) and one minute
  * later would be 2024-03-10T06:01 UTC  which would be 2024-03-10T01:01 in
  * `America/New_York`. A similar situation happens when the time zone
  * transitions from Daylight Saving Time to Standard Time as can be derived from

package/dist/sTimestamp.js

@@ -57,8 +57,8 @@ export const getTimestampNow = (timeZone) => {
  */
 export const getTimestampFromDateAndTime = (date, time) => {
     const sDateValue = sDate(date);
-    const sDimeValue = sTime(time);
-    return sTimestamp(`${sDateValue.date}T${sDimeValue.time}`);
+    const sTimeValue = sTime(time);
+    return sTimestamp(`${sDateValue.date}T${sTimeValue.time}`);
 };
 /**
  * --- Getters ---
@@ -88,9 +88,9 @@ export const getUTCMillisecondsFromTimestamp = (timestamp, timeZone) => {
  * Returns a native Date adjusted so that the local time of that date matches
  * the local timestamp at the specified time zone.
  *
- * @param date The date to get the time zoned date from. It can be an SDate or a
- * string in the YYYY-MM-DD format.
- * @param timeZone The time zone to adjust the date to. See
+ * @param timestamp The timestamp to get the time zoned date from. It can be
+ * an STimestamp or a string in the YYYY-MM-DDTHH:MM format.
+ * @param timeZone The time zone to adjust the timestamp to. See
  * `Intl.supportedValuesOf('timeZone')` for a list of valid time zones.
  */
 export const getTimeZonedDateFromTimestamp = (timestamp, timeZone) => {
@@ -282,7 +282,7 @@ export const addDaysToTimestamp = (timestamp, days) => {
  * 2024-03-10T02:00 (a time that technically does not exist on a watch that
  * automatically adjusts for Daylight Saving) will result in 2024-03-10T01:01.
  * This is because 2024-03-10T02:00 is converted to 2024-03-10T06:00 UTC (due
- * to timezone offset being -4 starting from 02:00 local time) and one minute
+ * to time zone offset being -4 starting from 02:00 local time) and one minute
  * later would be 2024-03-10T06:01 UTC  which would be 2024-03-10T01:01 in
  * `America/New_York`. A similar situation happens when the time zone
  * transitions from Daylight Saving Time to Standard Time as can be derived from

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scdate",
-  "version": "2.1.1",
+  "version": "3.1.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js"