PubNub JavaScript SDK (V4)

......This is the official PubNub JavaScript SDK repository.

PubNub takes care of the infrastructure and APIs needed for the realtime communication layer of your application. Work on your app's logic and let PubNub handle sending and receiving data across the world in less than 100ms.

Get keys

You will need the publish and subscribe keys to authenticate your app. Get your keys from the Admin Portal.

Tutorial Video

Watch Getting Started with PubNub JS SDK on Dashcam

Configure PubNub

1. Integrate the JavaScript SDK into your project:

   • use npm:

     npm install pubnub
     

   • or download one of our builds from our CDN:
     • https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.4.js
     • https://cdn.pubnub.com/sdk/javascript/pubnub.8.2.4.min.js

2. Configure your keys:

pubnub = new PubNub({
  publishKey : "myPublishKey",
  subscribeKey : "mySubscribeKey",
  uuid: "myUniqueUUID"
})

Add event listeners

pubnub.addListener({
  message: function (m) {
    // handle messages
  },
  presence: function (p) {
    // handle presence  
  },
  signal: function (s) {
    // handle signals
  },
  objects: (objectEvent) => {
    // handle objects
  },
  messageAction: function (ma) {
    // handle message actions
  },
  file: function (event) {
    // handle files  
  },
  status: function (s) {
  // handle status  
  },
});

Publish/subscribe

var publishPayload = {
    channel : "hello_world",
    message: {
        title: "greeting",
        description: "This is my first message!"
    }
}

pubnub.publish(publishPayload, function(status, response) {
    console.log(status, response);
})

pubnub.subscribe({
    channels: ["hello_world"]
});

Documentation

• Build your first realtime JS app with PubNub
• API reference for JavaScript (web)
• API reference for JavaScript (Node.js)

Support

If you need help or have a general question, contact [email protected].