Pushgor Library

Pushgor is a Node.js library for real-time messaging using Socket.IO. It provides a simple interface for subscribing to channels, unsubscribing, triggering events, and managing connections.

Features

• Subscribe and unsubscribe from channels
• Trigger events in channels
• Manage user connections and disconnections
• Simple setup with Socket.IO

Installation

You can install Pushgor via npm. Run the following command to add it to your project:

npm install pushgor

Usage
Basic Usage
1. Require and create an instance of Pushgor:

const Pushgor = require('pushgor');
const pushgor = new Pushgor({ port: 4005 });

2. Start the Pushgor server:

pushgor.start();

3. Trigger events:

To trigger an event on a specific channel:
pushgor.trigger('channel-name', 'event-name', 'message');

Example
Here's an example of how you might use Pushgor in a script:

const Pushgor = require('pushgor');

const pushgor = new Pushgor({ port: 4005 });

pushgor.start();

pushgor.trigger('test-channel', 'test-event', 'Hello, world!');

Testing
To run the tests, ensure you have the dependencies installed and use:
npm test


This will run the test suite and ensure everything is working correctly.

API
Pushgor(options)
options.port: Port number for the server (default: 5000)
pushgor.start()
Starts the server and begins listening for connections.

pushgor.trigger(channel, event, message)
Triggers an event on a specific channel with a message.

pushgor.server.close(callback)
Closes the server. This is used in the tests to ensure the server is properly closed after running.

License
MIT License. See the LICENSE file for details.

Contributing
Feel free to submit issues or pull requests. We welcome contributions to improve the library!


Dengan `npm install pushgor`, pengguna dapat menambahkan library ke proyek mereka dengan mudah. Pastikan untuk menyesuaikan URL dan informasi lainnya jika diperlukan.