docs

Documentation Structure

This directory contains comprehensive documentation for @usex/rule-engine.

📚 Documentation Files

File	Description	Key Topics
index.md	Documentation hub	Overview, quick links, navigation
api-reference.md	Complete API documentation	Classes, methods, interfaces, types
operators.md	All 126 operators reference	Detailed operator guide with examples
best-practices.md	Production best practices	Performance, security, testing, patterns
migration-guide.md	Migration from other engines	json-rules-engine, node-rules, custom code

🎯 Quick Navigation

For New Users

1. Start with the main README
2. Review operators for available operations
3. Check examples for common patterns

For Developers

1. API Reference for detailed method documentation
2. Best Practices for production guidance
3. TypeScript examples for type safety

For Migration

1. Migration Guide for switching from other engines
2. Common patterns for code conversion

📖 Documentation Coverage

Core Concepts ✅

• Rule structure and types
• Conditions and constraints
• Logical operators (and/or/none)
• Result handling
• Default values

API Coverage ✅

• RuleEngine class (static & instance methods)
• ObjectDiscovery utilities
• Builder pattern API
• Mutation system
• Validation & introspection

Operators ✅

• 126 operators documented
• Categorized by type
• Usage examples for each
• Common patterns

Best Practices ✅

• Performance optimization
• Error handling strategies
• Security considerations
• Testing approaches
• Maintenance tips

Migration Paths ✅

• From json-rules-engine
• From node-rules
• From business-rules-engine
• From custom implementations

🔍 Finding Information

By Topic

Topic	Location
Installation	README
Quick Start	README
JSONPath Usage	README
Date Operations	Operators
Array Operations	Operators
Performance Tips	Best Practices
Testing Strategies	Best Practices
Security	Best Practices

By Use Case

Use Case	Documentation
Form Validation	Examples
Access Control	Examples
Discount Rules	Examples
Complex Conditions	Best Practices
Batch Processing	API Reference

💡 Tips for Reading

1. Start Simple: Begin with basic examples and gradually explore advanced features
2. Use Search: Use your editor's search to find specific operators or methods
3. Check Examples: Most concepts include practical examples
4. Follow Links: Documentation is interconnected for easy navigation
5. Try It Out: Best way to learn is to experiment with the code

🤝 Contributing to Docs

See CONTRIBUTING.md for guidelines on improving documentation.

---

Generated with ❤️ for the @usex/rule-engine community