apiclient.xyz/docker
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(readme): Update README to document 3.0.0+ changes: architecture refactor, streaming improvements, health check and circular dependency fixes

Browse Source
This commit is contained in:
Jürgen Kunz
2025-11-24 13:09:00 +00:00
parent 2f31e14cbe
commit 5834721da8
3 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
readme.md
View File

@@ -904,15 +904,17 @@ async function healthCheckService() {
## 🆕 Recent Updates
### Version 2.1.0 - Architecture & Features
### Version 3.0.0+ - Architecture & Stability
- ✨ **Clean OOP Architecture**: Refactored to Facade pattern with DockerHost as single entry point
- ✨ **Container Streaming**: Added `streamLogs()`, `attach()`, and `exec()` methods
- ✨ **Flexible Descriptors**: Support both string references and class instances
- ✨ **Complete Container API**: All lifecycle methods (start, stop, remove, logs, inspect, stats)
- ✨ **DockerResource Base Class**: Consistent patterns across all resources
- 🔧 **Improved Type Safety**: Better TypeScript definitions throughout
- 📚 **Enhanced Documentation**: Comprehensive examples and migration guides
- ✨ **Container Streaming**: Real-time `streamLogs()`, `attach()`, and `exec()` methods for interactive containers
- ✨ **Flexible Descriptors**: Support both string references and class instances in all creation methods
- ✨ **Complete Container API**: Full lifecycle methods (start, stop, remove, logs, inspect, stats)
- ✨ **DockerResource Base Class**: Consistent patterns and type safety across all resources
- ✨ **Health Check Support**: New `ping()` method to verify Docker daemon availability
- 🐛 **Fixed Circular Dependencies**: Resolved Node.js module loading issues with type-only imports
- 🔧 **Improved Type Safety**: Better TypeScript definitions and interfaces throughout
- 📚 **Enhanced Documentation**: Comprehensive examples, migration guides, and real-world use cases
## License and Legal Information