pushgorjs

📡 Pushgor Library

Pushgor adalah library WebSocket sederhana yang memungkinkan komunikasi real-time menggunakan channel dan event. Bisa digunakan di frontend, backend, dan aplikasi lain.

---

📦 Instalasi

1. Instalasi di Node.js/Frontend:

   Gunakan salah satu perintah berikut untuk menginstal Pushgor:

   bun add pushgorjs
   # atau
   npm install pushgorjs
   # atau
   yarn add pushgorjs

---

🚀 Menjalankan WebSocket Server

1. Menjalankan WebSocket Server

Untuk menjalankan server Pushgor di Node.js:

// server.ts
import { Pushgor } from 'pushgorjs'

const server = new Pushgor({ port: 6060 })

// Trigger event ke semua client yang subscribe ke channel tertentu
server.trigger('chat-room', 'message', { user: 'bot', text: 'Hello World!' })

• Port default: 5050 (bisa diubah dengan opsi port).

Server ini akan berjalan pada ws://localhost:6060 atau sesuai dengan port yang kamu tentukan.

---

🧑‍💻 Penggunaan Client

2. Menggunakan Client di Frontend / Backend

Di frontend atau backend, kamu bisa menggunakan PushgorClient untuk terhubung ke server.

// client.ts
import { PushgorClient } from 'pushgorjs'

const client = new PushgorClient('ws://localhost:6060')

// Saat koneksi berhasil
client.onOpen(() => {
  console.log('Connected to Pushgor server')

  // Subscribe ke channel tertentu
  client.subscribe('chat-room')

  // Tangkap event dari server
  client.bind('message', (data) => {
    console.log('Message from server:', data)
  })
})

---

📡 API Client

• onOpen(callback): Dipanggil saat koneksi berhasil.
• subscribe(channel): Subscribe ke channel tertentu.
• bind(event, callback): Bind event untuk menerima pesan dari server.
• unsubscribe(channel): Unsubscribe dari channel.
• disconnect(): Menutup koneksi WebSocket.

---

💻 Menggunakan Pushgor di Laravel

Untuk menggunakan Pushgor di Laravel, kamu bisa membuat endpoint di backend (misalnya Node.js) untuk memicu event WebSocket dari server.

Contoh Penggunaan di Laravel

1. Kirim Request ke WebSocket Server dari Laravel

Di backend Laravel, kamu bisa mengirim HTTP POST request untuk memicu event Pushgor:

// Laravel Controller
use Illuminate\Support\Facades\Http;

public function triggerEvent() {
    Http::post('http://localhost:6060/trigger', [
        'channel' => 'chat-room',
        'event' => 'message',
        'data' => ['user' => 'Laravel', 'text' => 'Hello from Laravel!'],
    ]);
}

2. Trigger Event di Server Node.js

Di server Node.js (Pushgor), buat route untuk menerima request dan mengirimkan event melalui WebSocket:

// server.ts (Node.js)
import { Pushgor } from 'pushgorjs'
import express from 'express'

const app = express()
const server = new Pushgor({ port: 6060 })

app.use(express.json())

app.post('/trigger', (req, res) => {
  const { channel, event, data } = req.body
  server.trigger(channel, event, data)
  res.status(200).send('Event Triggered')
})

app.listen(3000, () => {
  console.log('Backend listening on http://localhost:3000')
})

---

🧰 API Referensi

Pushgor (Server)

new Pushgor(options?: { port?: number })

• port: Port WebSocket yang akan dijalankan (default: 5050).

trigger(channel: string, event: string, data: any)

• Kirim pesan ke semua client yang subscribe ke channel tertentu.

---

PushgorClient (Client)

new PushgorClient(url: string)

• url: Alamat WebSocket server (contoh: 'ws://localhost:6060').

onOpen(callback: () => void)

• Dipanggil saat koneksi ke server berhasil.

subscribe(channel: string)

• Subscribe ke channel tertentu.

bind(event: string, callback: (data: any) => void)

• Menangani event dari server berdasarkan event.

disconnect()

• Menutup koneksi WebSocket.

---

📜 License

MIT