📆 weekedays

Get an array of weekday names in any language, order, format.

Supports:

• Languages: Any locale supported by Intl.DateTimeFormat
• Order: Start from any day (Sunday, Monday, or even "current")
• Format:
  • Style: "long", "short", "narrow"
  • Case: "capital", "upper", "lower"

📦 Installation

npm install @navigatrum/weekdays
# or
yarn add @navigatrum/weekdays
#or
pnpm add @navigatrum/weekdays

🚀 Usage

import { weekdays } from "weekdays";

📚 Examples

// Weekdays in the current locale, starting from Sunday, using native casing
weekdays();
// ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']

// French weekdays, starting from Sunday, using native casing
weekdays({ locales: "fr" });
// ['dimanche', 'lundi', 'mardi', 'mercredi', 'jeudi', 'vendredi', 'samedi']

// Arabic weekdays starting from Saturday
weekdays({ first: 6, locales: "ar" });
// ['السبت', 'الأحد', 'الاثنين', 'الثلاثاء', 'الأربعاء', 'الخميس', 'الجمعة']

// Spanish weekdays starting from current day (e.g. Friday), capitalized, in short form
weekdays({
  first: "current",
  case: "capital",
  style: "short",
  locales: "es-ES",
});
// ['Vie', 'Sáb', 'Dom', 'Lun', 'Mar', 'Mié', 'Jue']

// Chinese weekdays in short form, starting from Monday
weekdays({ locales: "zh-CN", first: 1, style: "short" });
// ['周一', '周二', '周三', '周四', '周五', '周六', '周日']

🛠️ Options

type WeekdaysOptions = {
  locales?: string | string[]; // default: system/browser locale
  style?: "long" | "short" | "narrow"; // default: "long"
  case?: "capital" | "upper" | "lower"; // default: native casing
  first?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | "current"; // default: 0 (Sunday)
};