Season Plugin

Import & Usage

import { Chronos, chronos } from "chronos-date";
import { seasonPlugin } from 'chronos-date/plugins/seasonPlugin';

// Register the plugin globally
Chronos.use(seasonPlugin);
// or
chronos.use(seasonPlugin);
// or
Chronos.register(seasonPlugin);
// or
chronos.register(seasonPlugin);

const c = new Chronos();

const season = c.season();

console.log(season);

Example Usage

Overview

The seasonPlugin adds comprehensive season related functionalities to Chronos, enabling:

• Determining the current season based on either predefined regional presets or custom season definitions

Methods Added by the Plugin

API Reference

season()

Get season name

Signature

season(options?: SeasonOptions): string

Alias

• getSeasonName is an alias for season method.

Overview

The season() method determines the current season based on either predefined regional presets or custom season definitions. It supports both month-based and exact date-based season boundaries.

Usage

Configuration

SeasonOptions

interface SeasonOptions {
  seasons?: SeasonDefinition[];
  preset?: SeasonPreset;
}

• seasons: Custom array of season definitions (overrides preset if provided)
• preset: Name of predefined season configuration (default: 'default' - Western Seasons)

SeasonDefinition

interface SeasonDefinition {
  name: string;
  boundary: MonthBoundary | DateBoundary;
}

Boundary can be either:

• Month-based: { startMonth: 0-11, endMonth: 0-11 } (0=January)
• Date-based: { startDate: 'MM-DD', endDate: 'MM-DD' }

Available Presets

[
  { name: 'Spring', boundary: { startMonth: 2, endMonth: 4 } },  // Mar-May
  { name: 'Summer', boundary: { startMonth: 5, endMonth: 7 } },  // Jun-Aug
  { name: 'Autumn', boundary: { startMonth: 8, endMonth: 10 } }, // Sep-Nov
  { name: 'Winter', boundary: { startMonth: 11, endMonth: 1 } }  // Dec-Feb
]

const gamingSeasons = [
  { name: 'Pre-Season', boundary: { startMonth: 0, endMonth: 2 } },
  { name: 'Competitive', boundary: { startDate: '03-01', endDate: '09-30' } },
  { name: 'Off-Season', boundary: { startMonth: 10, endMonth: 11 } }
];

const currentSeason = new Chronos().season({ seasons: gamingSeasons });

Type Definitions

type SeasonPreset = 
  | 'default'
  | 'bangladesh'
  | 'india'
  | 'tamil'
  | 'vedic'
  | 'philippines'
  | 'academic_us'
  | 'japan'
  | 'australia'
  | 'ethiopia';

type MonthDateString = `${MonthString}-${DateString}`; // 'MM-DD' format

interface DateBoundary {
  startDate: MonthDateString;
  endDate: MonthDateString;
}

interface MonthBoundary {
  startMonth: number; // 0-11 (0=January)
  endMonth: number;   // 0-11
}