Welcome to the node-proxmox wiki!
the documentation file includes all needed documentation, and the readme provides a quick overlook of what is in the api.