react-native-reverb

React Native Reverb

A React Native TurboModule wrapper for Laravel Reverb WebSockets.
This package lets you connect to a Reverb server, subscribe/unsubscribe to channels, and listen for broadcasted events & notifications.

🚀 Installation

From npm (coming soon)

npm install react-native-reverb

From GitHub

npm install github:azlanali076/react-native-reverb

or with yarn:

yarn add github:azlanali076/react-native-reverb

📦 Setup

• Autolinking (React Native 0.71+) The package supports autolinking, no extra linking step required.

• iOS Install pods:

  cd ios && pod install
  

• Android Nothing extra required, autolinking will register the TurboModule.

🛠 Usage

import { ReverbClient } from 'react-native-reverb';

const client = new ReverbClient({
  appKey: '<YOUR_REVERB_APP_KEY>',
  scheme: 'https',
  url: '<YOUR_REVERB_HOST>',
  auth: {
    endpoint: '<YOUR_REVERB_AUTH_ENDPOINT>',
    headers: {
      Authorization: `Bearer <TOKEN>`,
    },
  },
});

// Connect to server
await client.connect();

// Subscribe to a channel
const channel = await client.private(`App.Models.Order.${orderId}`);

channel.listen('OrderUpdated', data => {
  console.log('Order updated:', data);
});

// Listen for Laravel notifications
channel.notifications(notification => {
  console.log('Notification received:', notification);
});

// Remove all Listeners and unsubscribe at once when leaving
await channel.removeAllListeners();

// Disconnect Websocket completely
await client.disconnect();

📚 API Reference

ReverbClient

• new ReverbClient(options: NativeReverbOptions) – create a client instance
• connect(): Promise<void> – connect to Reverb server
• disconnect(): Promise<void> – disconnect & cleanup
• channel(name: string): Promise<ReverbChannel> – subscribe to a public channel
• private(name: string): Promise<ReverbPrivateChannel> – subscribe to a private channel

ReverbChannel

• listen(event: string, callback: (data) => void) – listen for events
• notifications(callback: (data) => void) – listen for Laravel notifications
• removeListener(event: string) – stop listening to an event
• removeAllListeners() – stop listening from all events and unsusbcribe the channel
• unsubscribe() – unsubscribe from this channel

🧑‍💻 Development

Clone the repo and install dependencies:

git clone https://github.com/azlanali076/react-native-reverb.git
cd react-native-reverb
npm install

📄 License

MIT © Syed Azlan Ali