@e4ia/usedatefns

A utility package that simplifies working with date-fns in React projects. This library offers reusable date manipulation functions, making it easier to handle common date and time operations.

🌟 Features

• 🚀 Simplified date manipulation: Perform operations like formatting, parsing, adding, and subtracting dates with ease.
• 📦 Small footprint: Built on the efficient date-fns library, keeping your bundle size low.
• ⚛️ React-friendly: Designed to integrate seamlessly with React components.
• 🔗 TypeScript support: Fully typed for a smooth development experience.

🛠️ Installation

Install the package via npm or yarn:

npm install @e4ia/usedatefns

Or with yarn:

yarn add @e4ia/usedatefns

⚡ Peer Dependencies

Make sure the following peer dependencies are installed:

"peerDependencies": { "date-fns": "2.28.0", "react": "^16.8.0 || ^17.0.0", "react-dom": "^16.8.0 || ^17.0.0" }

Install them if not already present:

npm install date-fns react react-dom

📚 Usage

📅 Example: Formatting Dates

import { formatDate } from '@e4ia/usedatefns';

const Example = () => { const today = new Date(); const formattedDate = formatDate(today, 'yyyy-MM-dd'); // Outputs: "2024-12-31"

return Today's date: {formattedDate}; };

➕ Example: Adding Days to a Date

import { addDaysToDate } from '@e4ia/usedatefns';

const Example = () => { const today = new Date(); const futureDate = addDaysToDate(today, 7); // Adds 7 days to today's date

return One week later: {futureDate.toString()}; };

📖 API

formatDate(date: Date, format: string): string

Formats a date using a date-fns-style format string.

• Parameters:
  • date: The date to format.
  • format: The desired format string (e.g., yyyy-MM-dd).

addDaysToDate(date: Date, days: number): Date

Adds a specified number of days to a date.

• Parameters:
  • date: The starting date.
  • days: The number of days to add.

subtractDaysFromDate(date: Date, days: number): Date

Subtracts a specified number of days from a date.

• Parameters:
  • date: The starting date.
  • days: The number of days to subtract.

🏗️ Development

🛠️ Build the Project

Use the following command to build the project:

npm run build

✅ Run Tests

Use the following command to run the test suite:

npm test

🤝 Contributing

Contributions are welcome! If you have an idea or find an issue, feel free to open a pull request or create an issue. 💡

📜 License

This package is private and available under a custom license.