📊 arul-expense-tracker

A simple and lightweight expense tracker npm package with CRUD operations and utilities for managing expenses by date, month, and category.

🚀 Installation

npm install arul-expense-tracker

📦 Usage

import { 
  addExpense, 
  getExpenses, 
  getTotalExpense, 
  getTotalExpenseByCategory 
} from "arul-expense-tracker";

// Add expenses
addExpense("Food", 150);
addExpense("Transport", 50);
addExpense("Entertainment", 200);
addExpense("Food", 100);

// Get all expenses
console.log(getExpenses());

// Get totals
console.log(getTotalExpense()); // e.g., 500
console.log(getTotalExpenseByCategory("Food")); // e.g., 250

✨ Features

• ➕ Add expenses with category, amount, and auto-generated date
• 🔍 Retrieve expenses by id, category, date, or month
• ✏️ Update existing expenses (only provided fields are updated)
• ❌ Delete expenses by id, category, date, or month
• 📊 Calculate totals by all-time, month, category, or date

📂 API Reference

Expense Functions

• addExpense(category, amount) → add a new expense
• getExpenses() → get all expenses
• getExpenseById(id) → get expense by ID
• updateExpense(id, category?, amount?, date?) → update an expense (keeps old values if not provided)
• deleteExpense(id) → delete expense by ID

Totals

• getTotalExpense() → total of all expenses
• getTotalExpenseByMonth(month, year)
• getTotalExpenseByCategory(category)
• getTotalExpenseByDate(date)

By Date

• getExpensesByDate(date)
• deleteExpensesByDate(date)
• getExpensesByMonth(month, year)
• deleteExpensesByMonth(month, year)

By Category

• getExpenseByCategory(category)
• deleteExpenseByCategory(category)

📂 Project Structure

arul-expense-tracker/
 ├─ main/
 │   ├─ expense.js      # CRUD (add, update, delete, get)
 │   ├─ total.js        # Totals by date, month, category
 │   ├─ date.js         # Get/delete by date or month
 │   ├─ category.js     # Get/delete by category
 ├─ index.js            # Re-exports everything
 ├─ package.json
 └─ README.md

⚠️ Note

• This package stores expenses in memory. Once the program exits, data is lost.
• For persistence, extend it to use a JSON file or database.

📜 License

ISC © 2025 Arul