Static Methods

use()

Injects a plugin into the Chronos system. This enables dynamic extension of the Chronos class at runtime by registering external functionality as methods on its prototype.

One-time Injection

A plugin is only injected once per runtime. Re-registering the same plugin has no effect.

Signature

static use(plugin: ChronosPlugin): void

Parameters

Name	Type	Description
plugin	ChronosPlugin	A plugin function that receives the Chronos class constructor and augments it.

Example

import { Chronos } from 'nhb-toolbox';
import { timeZonePlugin } from 'nhb-toolbox/plugins/timeZonePlugin';

Chronos.use(timeZonePlugin); // Injects timeZone() method

Once injected, the plugin methods become available on all Chronos instances:

const c = Chronos.now();
c.timeZone('UTC+06:00');

Notes

info

• Plugins should be injected before any instance creation.
• Internally, Chronos maintains a #plugins set to prevent duplicate injections.
• This system is ideal for modular features like seasons, zodiac, or timeZone etc. support.

---

parse()

Signature

static parse(dateStr: string, format: string): Chronos

Parameters

• dateStr: Date string to parse
• format: Format string

Return Type

Chronos - Parsed date

Supported Tokens

• YYYY, YY - Year
• MM, M - Month
• DD, D - Day
• HH, H - Hour
• mm, m - Minute
• ss, s - Second

Example

Chronos.parse('15-01-2025', 'DD-MM-YYYY'); // Jan 15 2025

---

today()

Signature

static today(options?: FormatOptions): string

Parameters

• options: Formatting options

interface FormatOptions {
  format?: string;
  useUTC?: boolean;
}

Return Type

string - Formatted current date

Example

Chronos.today({format: 'YYYY-MM-DD'}); // "2025-07-20"

yesterday()

Signature

static yesterday(): Chronos

Return Type

Chronos - Yesterday's date

Example

Chronos.yesterday(); // Chronos instance for yesterday

---

tomorrow()

Signature

static tomorrow(): Chronos

Return Type

Chronos - Tomorrow's date

Example

Chronos.tomorrow(); // Chronos instance for tomorrow

---

now()

Signature

static now(): number

Return Type

number - Current timestamp

Notes

• Same as Date.now()

Example

Chronos.now(); // 1689876543210

---

utc()

Signature

static utc(dateLike?: ChronosInput): Chronos

Parameters

• dateLike (optional) – The date input to create a UTC-based time. If omitted, the current system date and time is used.

Return Type

Chronos — A new Chronos instance representing the UTC equivalent of the given (or current) date.

Notes

• Creates a Chronos instance based on Coordinated Universal Time (UTC).
• If no dateLike (string/number/object) is provided, it uses the current date and time.
• This UTC instance is considered the base time, meaning all time zone conversions are derived from this reference point and not the local time.

info

Internally, this method adjusts the local time to its UTC equivalent by removing the time zone offset.

Example

// Using a specific date string
const utcChronos = Chronos.utc('2025-01-15T12:00:00');
// Using the current system time
const nowUTC = Chronos.utc();

---

formatTimePart()

Signature

static formatTimePart(time: string, format?: TimeParts): string

Parameters

• time: Time string to be formatted.Supported formats include:

• HH:mm → e.g., '14:50'

• HH:mm:ss → e.g., '14:50:00'

• HH:mm:ss.mss → e.g., '14:50:00.800'

• HH:mm+TimeZoneOffset(HH) → e.g., '14:50-06'

• HH:mm:ss+TimeZoneOffset(HH) → e.g., '14:50:00+06'

• HH:mm:ss.mss+TimeZoneOffset(HH) → e.g., '14:50:00.800-06'

• HH:mm+TimeZoneOffset(HH:mm) → e.g., '14:50+06:00'

• HH:mm:ss+TimeZoneOffset(HH:mm) → e.g., '14:50:00+05:30'

• HH:mm:ss.mss+TimeZoneOffset(HH:mm) → e.g., '14:50:00.800+06:30'

caution

If no offset is provided with time string, local (system) timezone will be used. The current date will be used as the base date for the time internally.

• format: Format string accepted by the formatStrict() method for TimeParts. Default: 'hh:mm:ss a' → e.g., "02:33:36 pm"

Return Type

string – Formatted time string in local system time.

Example

Chronos.formatTimePart('14:50'); 
// "02:50:00 pm"

Chronos.formatTimePart('14:50:00.800+05:30', 'HH:mm:ss');
// "14:50:00"

---

getDatesForDay()

Signature

// Relative range signature
static getDatesForDay(day: WeekDay, options?: RelativeRangeOptions): string[];

// Absolute range signature
static getDatesForDay(day: WeekDay, options?: DateRangeOptions): string[];

// Implementation signature
static getDatesForDay(day: WeekDay, options?: WeekdayOptions): string[]

Parameters

Common Parameter

• day: The weekday to match (case-sensitive full day name)
  • Type: WeekDay ('Monday' | 'Tuesday' | ... | 'Sunday')
  • Example: 'Wednesday', 'Friday'

Options (Differ by Signature)

1. Relative Range Options (time span from now):

interface RelativeRangeOptions {
  span?: number;    // Duration quantity (default: 4)
  unit?: TimeUnit;  // 'day' | 'week' | 'month' | 'year' (default: 'week')
  format?: 'local' | 'utc'; // Output format (default: 'local')
}

2. Absolute Range Options (fixed date range):

interface DateRangeOptions {
  from: ChronosInput; // Start date (string/Date/Chronos)
  to: ChronosInput;   // End date (string/Date/Chronos)
  format?: 'local' | 'utc'; // Output format (default: 'local')
}

Return Type

string[] - Array of ISO-8601 formatted date strings

Behavior

• Finds all occurrences of the specified weekday within:
  • A relative time span from now (when using span/unit)
  • Or between two fixed dates (when using from/to)
• Returns dates in chronological order
• Empty array if no matches found in range

Examples

Relative Range Example (next 3 weeks):

// Get all Wednesdays in the next 3 weeks
Chronos.getDatesForDay('Wednesday', { 
  span: 3, 
  unit: 'week',
  format: 'utc' 
});
//=> ['2025-05-28T15:00:00.000Z', '2025-06-04T15:00:00.000Z', '2025-06-11T15:00:00.000Z']

Absolute Range Example (specific date range):

// Get all Fridays between two dates
Chronos.getDatesForDay('Friday', {
  from: '2025-06-01',
  to: '2025-06-30',
  format: 'local' // Includes timezone offset
});
//=> ['2025-06-06T21:16:06.198+06:00', '2025-06-13T21:16:06.198+06:00', ...]

Notes

• When format: 'local' (default):
  • Output includes local timezone offset (e.g., +06:00)
  • Uses toLocalISOString() internally
• When format: 'utc':
  • Output is in UTC/Zulu time (ends with Z)
  • Uses toISOString() internally
• The method always starts searching from:
  • Current date (for relative ranges)
  • The from date (for absolute ranges)
• Weekday matching is exact (case-sensitive full English day names)

---

min()

Signature

static min(...dates: ChronosInput[]): Chronos

Parameters

• dates: Dates to compare

Return Type

Chronos - Earliest date

Example

Chronos.min('2025-01-01', '2025-02-01'); // Jan 1

---

max()

Signature

static max(...dates: ChronosInput[]): Chronos

Parameters

• dates: Dates to compare

Return Type

Chronos - Latest date

Example

Chronos.max('2025-01-01', '2025-02-01'); // Feb 1

---

isLeapYear()

info

• A year is a leap year if it is divisible by 4.

• However, years divisible by 100 are not leap years unless they are also divisible by 400.

• For example:

  • 2000, 2400 → leap years ✅
  • 1900, 2100 → not leap years ❌s

Signature

static isLeapYear(date: ChronosInput): boolean

Parameters

• date: Date to check

Return Type

boolean - Whether year is leap

Example

Chronos.isLeapYear(2024); // true

---

isValidDate()

Signature

static isValidDate(value: unknown): value is Date

Parameters

• value: Value to check

Return Type

boolean - Whether valid Date

Example

Chronos.isValidDate(new Date()); // true

---

isDateString()

Signature

static isDateString(value: unknown): value is string

Parameters

• value: Value to check

Return Type

boolean - Whether valid date string

Example

Chronos.isDateString('2025-01-01'); // true

---

isValidChronos()

Signature

static isValidChronos(value: unknown): value is Chronos

Parameters

• value: Value to check

Return Type

boolean - Whether Chronos instance

Example

Chronos.isValidChronos(new Chronos()); // true