Skip to content
Getting Started Samples for the Solace JavaScript API.
Branch: master
Clone or download
bczoma and mdspielman New feature tutorial and sample for Message Replay (#45)
* Added new sample code for message replay and initial document
Also updated Solace logo
Latest commit 72e9101 May 2, 2019

Getting Started Examples

Solace JavaScript API

The "Getting Started" tutorials will get you up to speed and sending messages with Solace technology as quickly as possible. There are three ways you can get started:

  • Follow these instructions to quickly spin up a cloud-based Solace messaging service for your applications.
  • Follow these instructions to start the Solace VMR in leading Clouds, Container Platforms or Hypervisors. The tutorials outline where to download and how to install the Solace VMR.
  • If your company has Solace message routers deployed, contact your middleware team to obtain the host name or IP address of a Solace message router to test against, a username and password to access it, and a VPN in which you can produce and consume messages.


This repository contains:

  • Code and matching tutorial walk throughs for five different basic Solace messaging patterns. For a nice introduction to the Solace API and associated tutorials, check out the tutorials home page.

    See the individual tutorials for details:

  • The following additional samples showing how to make use of advanced features of the Solace message router.

    • Secure Session: Learn how to use secure connection to the server and server and client certificate authentication.
    • Active Consumer Indication: Learn how multiple consumers can bind to an exclusive queue, but only one client at a time can actively receive messages.
    • Durable Topic Endpoint Consumer: Learn how to consume messages from a Durable Topic Endpoint (DTE).
    • Event Monitor: Learn how to monitor message router generated events.
    • GuaranteedRequestor/Replier: Learn how to set up guaranteed request/reply messaging.
    • NoLocal Pub-Sub: Learn how to prevent messages published on a session or consumer received on that same session or consumer.
    • Message Replay: Learn how to initiate and process the replay of previously published messages, as well as deal with an externally initiated replay.

Checking out

To check out the project, clone this GitHub repository:

git clone
cd solace-samples-javascript

Note: the code in the master branch of this repository depends on Solace JavaScript API version 10 or later. If you want to work with an older version clone the branch that corresponds your version.

Download the Solace JavaScript API

These samples depend on version 10 or later of the Solace JavaScript API library.

The Solace JavaScript API library can be downloaded here. The instructions in this tutorial assume you have downloaded the Web Messaging API for JavaScript library and unpacked it to a known location. The samples assume a lib directory containing the API libraries will be installed in the current solace-samples-javascript directory at the root of the cloned repo:

cp -R <path_to_unzipped_API_distribution_package>/lib/ .

Running the Samples

The samples are found in the src/basic-samples and src/features directories. Each sample is in it's own subdirectory. Within each sample subdirectory there is an html file which you load to launch the sample.

For example the TopicPublisher is found here: src/basic-samples/TopicPublisher

And it is launched by running the following in your browser:


See the tutorials for more details.


Please read for details on our code of conduct, and the process for submitting pull requests to us.


See the list of contributors who participated in this project.


This project is licensed under the Apache License, Version 2.0. - See the LICENSE file for details.


For more information try these resources:

You can’t perform that action at this time.