Azure Web PubSub client library samples for JavaScript

These sample programs show how to use the JavaScript client libraries for Azure Web PubSub in some common scenarios.

File Name Description
broadcasting.js Demonstrates broadcasting messages to a hub and a group
directMessage.js Demonstrates sending messages directly to a user or connection.
managingGroups.js Demonstrates adding and removing users from groups

Prerequisites

The sample programs are compatible with Node.js >=12.0.0.

You need an Azure subscription to run these sample programs.

Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.

Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.

Setup

To run the samples using the published version of the package:

  1. Install the dependencies using npm:
npm install
  1. Edit the file sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file from sample.env to just .env. The sample programs will read this file automatically.

  2. Run whichever samples you like (note that some samples may require additional setup, see the table above):

node broadcasting.js

Alternatively, run a single sample with the correct environment variables set (setting up the .env file is not required if you do this), for example (cross-platform):

npx cross-env WPS_CONNECTION_STRING="<wps connection string>" node broadcasting.js