Document comprehensive signal handling for SIGTERM, CTRL+C, and other signals #129
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📋 Summary
This PR provides comprehensive documentation for signal handling in command-stream, specifically addressing issue #15 by documenting how to send SIGTERM, CTRL+C (SIGINT), and other signals to executed commands.
Fixes #15
🚀 What's Added
Enhanced README Documentation
runner.kill()with different signal typespingthat ignore stdin but respond to signalsNew Example Files
examples/signal-handling-demo.mjs- Comprehensive demonstration of all signal types with exit code validationexamples/sigterm-sigkill-escalation.mjs- Production-ready graceful shutdown patterns with configurable timeoutsexamples/ctrl-c-vs-sigterm.mjs- Detailed comparison explaining the semantic differences between SIGINT and SIGTERM📚 Documentation Coverage
Signal Types Documented
Usage Patterns Covered
🧪 Testing
🎯 Addresses Issue #15
This PR directly addresses the request in issue #15 to "Document how to send SIGTERM (CTRL+C) and other signals to executed command" by:
📖 Key Learning Points
The documentation now provides complete guidance on signal handling, making it easy for users to implement proper process lifecycle management in their applications.
🤖 Generated with Claude Code