node-supervisord
v1.0.6-rc.2
Published
A Node.js library for communicating with the Supervisord XML-RPC API
Downloads
124
Maintainers
Readme
Installation & Usage
Install node-supervisord using npm:
npm install --save node-supervisord
Install node-supervisord using yarn:
yarn add node-supervisord
Example usage :
import { SupervisordClient } from "node-supervisord";
// Without authentication options
const client = new SupervisordClient("http://localhost:9001");
// With authentication options
const client = new SupervisordClient("http://localhost:9001", {
username: "your-username",
password: "your-passwword",
});
// Example get api version
const version = await client.getAPIVersion();
console.log(version);
To see the available methods, you can visit http://supervisord.org/api.html
Contributing
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Releasing
- Go to Publish Release page, click Run workflow
- Fill the vendor version and then run the flow
- GitHub Actions will take care of the rest
License
This project is licensed under the MIT License - see the LICENSE.md file for details.
Acknowledgments
Inspiration, code snippets, icon, etc.
- Template Typescript by Malang.dev.