Home

nut-client Wiki

Welcome to the nut-client documentation. This wiki provides in-depth guides and advanced usage beyond the README.

Quick Navigation

• API Reference — Complete method signatures and types
• Monitor Guide — Event-based monitoring patterns
• Command Tracking — Long-running operations with polling
• Migration to v1.0 — Breaking changes and upgrade guide

For Getting Started

If you're new to nut-client, start with the README which covers:

• Installation
• Basic usage examples
• Quick start guide
• Feature overview

What's in the Wiki?

This wiki focuses on:

• Detailed API documentation with all parameters and return types
• Advanced patterns for monitoring, tracking, and error handling
• Migration guides for version upgrades
• Troubleshooting common issues

External Resources

• npm Package
• TypeDoc API
• NUT Protocol Documentation