virtualizorjs 1.0.2 → 1.0.3

package/README.md

@@ -4,7 +4,7 @@ Since there is no SDK's for Node.js for the Virtualizor API, I decided to create
 
 VirtualizorJS simplifies the management of Virtualizor servers with a streamlined and developer-friendly API for Node.js. Perform actions such as creating, starting, stopping, and restarting virtual servers effortlessly. Ideal for seamless integration into your Node.js applications, providing a powerful toolkit for Virtualizor server management.
 
-[![npm version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=js&r=r&ts=1683906897&type=6e&v=1.0.1&x2=0)](https://badge.fury.io/js/virtualizorjs)
+[![npm version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=js&r=r&ts=1683906897&type=6e&v=1.0.2&x2=0)](https://badge.fury.io/js/virtualizorjs)
 
 ## Important
  - This library is still in development and there is more to add but for now it's stable and ready to use, all the methods have been tested and work as expected.
@@ -51,20 +51,21 @@ ListVPS().then((data) => {
 
 VirtualizorJS uses the [EventEmitter](https://nodejs.org/api/events.html) class to handle events. You can attach **`Event Listeners`** to different events provided by the VirtualizorClient.
 
-- Note: We define the "on" method as "eventOn" to avoid confusion with the EventEmitter's "on" method, However you can do it however you want this is just an example.
+- Note: To use **`Event Listeners`** we need to define the **`VirtualizorClient`** as a `const` named preferably **`Client`** and then use **`Client.on()`** to attach **`Event Listeners`** to different events.
 
 ```javascript
 const VirtualizorClient = require('virtualizorjs'); 
 
-// We define the "on" method as "eventOn" to avoid confusion with the EventEmitter's "on" method, However you can do it however you want this is just an example.
-// The "eventOn" method is used to attach Event Listeners to different events provided by the VirtualizorClient.
-const { on: eventOn } = new VirtualizorClient({
+const Client = new VirtualizorClient({
   host: '< IP or Hostname of Virtualizor Server >',
   port: 4085,
   adminapikey: "< Your API KEY >",
   adminapipass: "< Your API PASS >",
 });
 
+//Get the methods you need
+const { StartVPS } = Client;
+
 // - Event Types - :
 // 1. vpsCreated
 // 2. vpsStarted
@@ -72,22 +73,22 @@ const { on: eventOn } = new VirtualizorClient({
 // 4. vpsRestarted
 
 // Event listener for when a virtual server is created
-eventOn('vpsCreated', (response) => {
+Client.on('vpsCreated', (response) => {
   console.log(`Virtual Server Created! Details:`, response);
 });
 
 // Event listener for when a virtual server is started
-eventOn('vpsStarted', (response) => {
+Client.on('vpsStarted', (response) => {
   console.log(`Virtual Server Started! Details:`, response);
 });
 
 // Event listener for when a virtual server is stopped
-eventOn('vpsStopped', (response) => {
+Client.on('vpsStopped', (response) => {
   console.log(`Virtual Server Stopped! Details:`, response);
 });
 
 // Event listener for when a virtual server is restarted
-eventOn('vpsRestarted', (response) => {
+Client.on('vpsRestarted', (response) => {
   console.log(`Virtual Server Restarted! Details:`, response);
 });
 ```

package/examples/eventhandling.js

@@ -1,32 +1,36 @@
 const VirtualizorClient = require('virtualizorjs'); 
 
-const { on: eventOn } = new VirtualizorClient({
+const Client = new VirtualizorClient({
   host: '< IP or Hostname of Virtualizor Server >',
   port: 4085,
   adminapikey: "< Your API KEY >",
   adminapipass: "< Your API PASS >",
 });
 
+const { StartVPS } = Client;
+
+StartVPS(1);
+
 // Event listener for when a virtual server is created
-eventOn('vpsCreated', (response) => {
+Client.on('vpsCreated', (response) => {
   console.log(`Virtual Server Created! Details:`, response);
   // Output: Virtual Server Created! Details: { ...virtualizorResponse }
 });
 
 // Event listener for when a virtual server is started
-eventOn('vpsStarted', (response) => {
+Client.on('vpsStarted', (response) => {
   console.log(`Virtual Server Started! Details:`, response);
   // Output: Virtual Server Started! Details: { ...virtualizorResponse }
 });
 
 // Event listener for when a virtual server is stopped
-eventOn('vpsStopped', (response) => {
+Client.on('vpsStopped', (response) => {
   console.log(`Virtual Server Stopped! Details:`, response);
     // Output: Virtual Server Stopped! Details: { ...virtualizorResponse }
 });
 
 // Event listener for when a virtual server is restarted
-eventOn('vpsRestarted', (response) => {
+Client.on('vpsRestarted', (response) => {
   console.log(`Virtual Server Restarted! Details:`, response);
     // Output: Virtual Server Restarted! Details: { ...virtualizorResponse }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "virtualizorjs",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "VirtualizorJS simplifies the management of Virtualizor servers with a streamlined and developer-friendly API for Node.js. Perform actions such as creating, starting, stopping, and restarting virtual servers effortlessly. Ideal for seamless integration into your Node.js applications, providing a powerful toolkit for Virtualizor server management.",
   "main": "./src/VirtualizorClient.js",
   "scripts": {},