nhb-toolbox 4.26.0 → 4.26.1

package/CHANGELOG.md

@@ -6,7 +6,11 @@ All notable changes to the package will be documented here.
 
 ---
 
-## [4.26.00] - 2025-11-08
+## [4.26.1] - 2025-11-08
+
+- **Updated** *tsdoc* for some `Chronos` *methods* and *public properties*.
+
+## [4.26.0] - 2025-11-08
 
 ### 🕧 New in Chronos
 

package/dist/dts/date/Chronos.d.ts

@@ -38,14 +38,32 @@ export declare class Chronos {
      * - Also accessible via {@link toDate} instance method.
      */
     native: Date;
-    /** Current UTC offset in `UTC±HH:mm` format */
+    /**
+     * * Current UTC offset in `UTC±HH:mm` format.
+     *
+     * - Also accessible via {@link getUTCOffset} instance method without `UTC` prefix (`±HH:mm` format).
+     */
     utcOffset: UTCOffSet;
-    /** Current timezone name (e.g. `"Bangladesh Standard Time"`) or fallback to timezone identifier if name not found (e.g., `"Asia/Dhaka"`) */
+    /**
+     * Represents the current timezone name (e.g., `"Bangladesh Standard Time"`), or falls back to the corresponding timezone identifier (e.g., `"Asia/Dhaka"`) if no name can be resolved.
+     *
+     * @remarks
+     * - Invoking the {@link timeZone} method sets the timezone name that corresponds to the specified UTC offset, or the UTC offset itself if no name exists. For more details on this behavior, see {@link getTimeZoneName}.
+     * - To retrieve the local system’s native timezone name (or its identifier if the name is unavailable), use the {@link $getNativeTimeZone} instance method.
+     */
     timeZoneName: string;
-    /** Current timezone identifier, array of timezone identifiers or UTC offset.
-     * - `TimeZoneIdentifier`: (e.g., `"Asia/Dhaka"`)
-     * - Array of `TimeZoneIdentifier` (e.g., `['Asia/Kathmandu', 'Asia/Katmandu']` for timezones that share same UTC offset like `"UTC+05:45"`)
-     * - `UTCOffset` if no timezone identifier is found for specific UTC offset (e.g., `"UTC+05:45"`, `"UTC+02:15"` etc.) */
+    /**
+     * Represents the current timezone context, which can be a single identifier, an array of equivalent identifiers, or a UTC offset.
+     *
+     * - **`TimeZoneIdentifier`** — e.g., `"Asia/Dhaka"`. Returned when the {@link timeZone} method has not been invoked. It is default behaviour.
+     * - **Array of `TimeZoneIdentifier`** — e.g., `['Asia/Kathmandu', 'Asia/Katmandu']`, used when multiple timezones share the same UTC offset such as `"UTC+05:45"`.
+     * - **`UTCOffset`** — e.g., `"UTC+06:45"` or `"UTC+02:15"`, returned when no named timezone corresponds to a given offset.
+     *
+     * @remarks
+     * - By default, when {@link timeZone} is not applied, a single `TimeZoneIdentifier` string is provided.
+     * - When applied, it may instead return a single identifier string, an array of equivalent identifiers or a UTC offset string.
+     * - To retrieve the local system’s native timezone identifier, use the {@link $getNativeTimeZoneId} instance method.
+     */
     timeZoneId: TimeZoneId;
     /**
      * * Creates a new immutable `Chronos` instance.
@@ -136,15 +154,23 @@ export declare class Chronos {
     get [Symbol.toStringTag](): string;
     get [Symbol.isConcatSpreadable](): boolean;
     /**
-     * * Safely get the current timezone name (e.g. `"Bangladesh Standard Time"`) or fallback to timezone identifier if name not found (e.g., `"Asia/Dhaka"`) for the local machine's timezone.
+     * @instance Retrieves the local system’s current timezone name (e.g., `"Bangladesh Standard Time"`), or falls back to its corresponding IANA timezone identifier (e.g., `"Asia/Dhaka"`) if the name cannot be determined.
      *
-     * @remarks If {@link timeZone} or {@link utc}/{@link toUTC} method is applied, it still returns the local machine's timezone info. To access the modified timezone info use {@link timeZoneName} property.
+     * @remarks
+     * - This method always reflects the local machine’s timezone, regardless of whether {@link timeZone}, {@link utc}, or {@link toUTC} methods have been applied.
+     * - To access the timezone name of a modified or converted instance, use the {@link timeZoneName} public property instead.
+     *
+     * @returns The resolved timezone name or its IANA identifier as a fallback.
      */
     $getNativeTimeZone(): string;
     /**
-     * * Safely get the IANA timezone identifier (e.g. `"Asia/Dhaka"`, `"Africa/Harare"` etc.) for the local machine's timezone.
+     * @instance Retrieves the IANA time zone identifier (e.g., `"Asia/Dhaka"`, `"Africa/Harare"`) for the local system’s current time zone.
+     *
+     * @remarks
+     * - This method always returns the identifier of the local machine’s time zone, regardless of whether {@link timeZone}, {@link utc}, or {@link toUTC} methods have been applied.
+     * - To obtain the identifier(s) of a modified or converted instance, use the {@link timeZoneId} public property instead.
      *
-     * @remarks If {@link timeZone} or {@link utc}/{@link toUTC} method is applied, it still returns the local machine's timezone identifier. To access the modified timezone identifier(s) use {@link timeZoneId} property.
+     * @returns The local system’s IANA time zone identifier.
      */
     $getNativeTimeZoneId(): TimeZoneIdentifier;
     /** Gets the full year of the date. */
@@ -185,7 +211,7 @@ export declare class Chronos {
     toDate(): Date;
     /** @instance Returns a string representation of a date. */
     toString(): string;
-    /** @instance Returns ISO string with local machine's time zone offset. */
+    /** @instance Returns ISO string with local machine's timezone offset. */
     toLocalISOString(): string;
     /** @instance Returns a date as a string value in ISO format. Respects timezone. */
     toISOString(): string;
@@ -477,7 +503,7 @@ export declare class Chronos {
     /**
      * @instance Returns the system's current UTC offset formatted as `±HH:mm` (`+06:00` or `-07:00`).
      *
-     * - *Unlike JavaScript's {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset `Date.prototype.getTimezoneOffset()`}, which returns the offset in minutes **behind** UTC (positive for locations west of UTC and negative for east), this method returns the more intuitive sign format used in time zone representations (e.g., `+06:00` means 6 hours **ahead** of UTC).*
+     * - *Unlike JavaScript's {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset `Date.prototype.getTimezoneOffset()`}, which returns the offset in minutes **behind** UTC (positive for locations west of UTC and negative for east), this method returns the more intuitive sign format used in timezone representations (e.g., `+06:00` means 6 hours **ahead** of UTC).*
      *
      * @returns The (local) system's UTC offset in `±HH:mm` format.
      */
@@ -485,7 +511,7 @@ export declare class Chronos {
     /**
      * @instance Returns the timezone offset of this `Chronos` instance in `±HH:mm` format maintaining current timezone.
      *
-     * - *Unlike JavaScript's {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset Date.prototype.getTimezoneOffset()}, which returns the offset in minutes **behind** UTC (positive for locations west of UTC and negative for east), this method returns the more intuitive sign format used in time zone representations (e.g., `+06:00` means 6 hours **ahead** of UTC).*
+     * - *Unlike JavaScript's {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset Date.prototype.getTimezoneOffset()}, which returns the offset in minutes **behind** UTC (positive for locations west of UTC and negative for east), this method returns the more intuitive sign format used in timezone representations (e.g., `+06:00` means 6 hours **ahead** of UTC).*
      *
      * @returns The timezone offset string in `±HH:mm` format maintaining the current timezone regardless of system having different one.
      */
@@ -509,7 +535,7 @@ export declare class Chronos {
      * @returns The UTC offset in minutes maintaining the current timezone regardless of system having different one.
      */
     getTimeZoneOffsetMinutes(): number;
-    /** @instance Returns new `Chronos` instance in UTC */
+    /** @instance Returns new `Chronos` instance in UTC time */
     toUTC(): Chronos;
     /** @instance Returns new `Chronos` instance in local time */
     toLocal(): Chronos;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "4.26.0",
+  "version": "4.26.1",
   "description": "A versatile collection of smart, efficient, and reusable utility functions, classes and types for everyday development needs.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",