@swaray21/date-utils 0.0.0-stage → 1.0.1

package/README.md

@@ -1,3 +1,80 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# Date Utils
+
+A lightweight JavaScript package that provides simple date and time utility functions.
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install @swaray21/date-utils
+```
+
+## Usage
+
+Import the functions into your JavaScript project:
+
+```javascript
+const {
+    formatDate,
+    calculateAge,
+    getDaysBetween,
+    isWeekend,
+    addDays
+} = require("@swaray21/date-utils");
+```
+
+## Available Functions
+
+### 1. formatDate(date)
+
+Formats a date into DD/MM/YYYY.
+
+```javascript
+formatDate("2026-10-31");
+// Output: 31/10/2026
+```
+
+### 2. calculateAge(dateOfBirth)
+
+Calculates a person's age from their date of birth.
+
+```javascript
+calculateAge("2000-01-01");
+```
+
+### 3. getDaysBetween(startDate, endDate)
+
+Calculates the number of days between two dates.
+
+```javascript
+getDaysBetween("2026-10-01", "2026-10-31");
+// Output: 30
+```
+
+### 4. isWeekend(date)
+
+Checks whether a date falls on Saturday or Sunday.
+
+```javascript
+isWeekend("2026-10-31");
+// Output: true
+```
+
+### 5. addDays(date, days)
+
+Adds a specified number of days to a date.
+
+```javascript
+addDays("2026-10-31", 5);
+// Returns a Date object representing November 5, 2026.
+```
+
+## Requirements
+
+- Node.js
+- npm
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,86 @@
+// Format a date into DD/MM/YYYY
+function formatDate(date) {
+    const newDate = new Date(date);
+
+    if (isNaN(newDate.getTime())) {
+        return "Invalid Date";
+    }
+
+    const day = String(newDate.getDate()).padStart(2, "0");
+    const month = String(newDate.getMonth() + 1).padStart(2, "0");
+    const year = newDate.getFullYear();
+
+    return `${day}/${month}/${year}`;
+}
+
+// Calculate age from date of birth
+function calculateAge(dateOfBirth) {
+    const birthDate = new Date(dateOfBirth);
+
+    if (isNaN(birthDate.getTime())) {
+        return null;
+    }
+
+    const today = new Date();
+    let age = today.getFullYear() - birthDate.getFullYear();
+
+    const hasBirthdayPassed =
+        today.getMonth() > birthDate.getMonth() ||
+        (today.getMonth() === birthDate.getMonth() &&
+         today.getDate() >= birthDate.getDate());
+
+    if (!hasBirthdayPassed) {
+        age--;
+    }
+
+    return age;
+}
+
+// Calculate the number of days between two dates
+function getDaysBetween(startDate, endDate) {
+    const start = new Date(startDate);
+    const end = new Date(endDate);
+
+    if (isNaN(start.getTime()) || isNaN(end.getTime())) {
+        return null;
+    }
+
+    const difference = Math.abs(end - start);
+
+    return Math.floor(difference / (1000 * 60 * 60 * 24));
+}
+
+// Check whether a date is a weekend
+function isWeekend(date) {
+    const selectedDate = new Date(date);
+
+    if (isNaN(selectedDate.getTime())) {
+        return false;
+    }
+
+    const day = selectedDate.getDay();
+
+    return day === 0 || day === 6;
+}
+
+// Add days to a date
+function addDays(date, days) {
+    const result = new Date(date);
+
+    if (isNaN(result.getTime()) || !Number.isInteger(days)) {
+        return null;
+    }
+
+    result.setDate(result.getDate() + days);
+
+    return result;
+}
+
+// Make functions available to other projects
+module.exports = {
+    formatDate,
+    calculateAge,
+    getDaysBetween,
+    isWeekend,
+    addDays
+};

package/package.json

@@ -1,6 +1,24 @@
 {
   "name": "@swaray21/date-utils",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.1",
+  "description": "A lightweight JavaScript date and time utility library",
+  "main": "index.js",
+  "type": "commonjs",
+  "scripts": {
+    "test": "node test/test.js"
+  },
+  "keywords": [
+    "date",
+    "time",
+    "javascript",
+    "utilities",
+    "date-utils"
+  ],
+  "author": "Lahai Simone Swaray",
+  "license": "MIT",
+  "files": [
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ]
+}