Ngememoize: Angular Memoization Library

Easily boost the performance of your Angular applications by memoizing functions and getters with this lightweight and simple-to-use library.

✨ Features

• Memoize Functions: Cache function results for improved performance.
• Memoize Getters: Optimize computed properties with caching.
• Lightweight: Designed for efficiency without adding unnecessary overhead.
• Decorator Support: Memoization is as simple as adding a decorator.
• Angular Compatible: Fully supports Angular 18 and later.
• Tree Shakable: Only include what you need.

📦 Installation

To get started, install Ngememoize via npm:

npm install ngememoize

Or, if you use Yarn or PNPM:

yarn add ngememoize
# or
pnpm add ngememoize

🚀 Quick Start

Memoize a Function

import { Ngememoize } from 'ngememoize';

// Method example
@Ngememoize({
  debugLabel: 'processData'
})
processData(value: number): number {
  console.log('Processing...');
  return value * 2;
}

// Async method example
@Ngememoize({
  debugLabel: 'fetchData',
  maxAge: 5000
})
async fetchData(id: string): Promise<string> {
  console.log('Fetching...');
  return new Promise(resolve =>
    setTimeout(() => resolve(`Data for ${id}`), 1000)
  );
}

For more examples on how to use Ngememoize, please refer to the /projects/example directory.

🧪 Testing

To ensure everything works perfectly, tests are included. Run the following commands:

npm test

📚 Documentation

Memoization Decorator

• @Ngememoize: Use this decorator on functions or getters to enable memoization.

Cache Behavior

• Cached results are invalidated when parameters or getter states change.

🎯 Benefits

• Performance Boost: Reduce redundant computations.
• Cleaner Code: Simplify logic by reducing manual caching.
• Angular Ready: Seamlessly integrates with your Angular projects.

🔧 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository.
2. Create a feature branch: git checkout -b feature/awesome-feature
3. Commit your changes: git commit -m 'Add awesome feature'
4. Push to the branch: git push origin feature/awesome-feature
5. Open a Pull Request.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

🤩 Credits

Ngememoize was built with ❤️ by developers who love Angular and believe in the power of simplicity and efficiency.

🌟 Support

If you find this library helpful, consider giving it a ⭐ on GitHub. Your support means a lot!

Now go forth and memoize your way to blazing-fast Angular apps! 🚀