import { WsKit } from "websocketkit";
import Pusher from 'pusher-js';
 
declare module 'websocketkit' {
  interface ChannelRegistry {
    'application': {
      type: 'public';
      params: {};
      events: {
        newVersionAvailable: {
          version: string,
          timestamp: string,
        }
      };
    };
  }
}
 
const pusher = new Pusher('TEST', {cluster: 'mt1'});
const wskit = new WsKit(pusher);
// ---cut---
 

Public channel

Public channels should be used for publicly accessible data as they do not require any form of authorization in order to be subscribed to.

You can subscribe and unsubscribe from channels at any time. There’s no need to wait for the Channels to finish connecting first.

Subscribe

Create a subscription to a specific channel. Provide any required parameters for public, private or presence channels.

const sub = wskit.subscribe('application', { type:'public', params: {} })

Unsubscribe

Stop receiving events and clear all listeners from the subscription.

sub.dispose();

Events

Listen for an event

Subscribe to a specific event on the channel.

sub.on('newVersionAvailable', (event) => {
  /** Do something with the event **/
})

Stop listening for an event

Remove a specific listener using either the returned unsubscribe function or the original callback reference.

const unsub = sub.on('newVersionAvailable', (event) => {
  /** Do something with the event **/
})
 
// Later
unsub();

/** You have to explicitly define the type of the event **/
const newVersionAvailableHandler = (event: { version: string, timestamp: string }) => {
  /** Do something with the event **/
};
 
sub.on('newVersionAvailable', newVersionAvailableHandler)
 
// Later
sub.off('newVersionAvailable', newVersionAvailableHandler);

Notifications

Listen for a notification

Listen for .Illuminate\\Notifications\\Events\\BroadcastNotificationCreated event on a channel.

sub.notification((notif) => {
  /** Do something with a notification event **/
});

Stop listening for a notification

// Using returned unsubscribe function
const unsub = sub.notification((notif) => {
  /** Do something with a notification event **/
});
 
unsub()

Internal Events

Subscription succeeded

Triggered when the subscription is successfully established.

sub.subscribed(() => {
  /** Do something after successful subscription **/
})