The Pulsar Node.js client can be used to create Pulsar producers and consumers in Node.js.

Pulsar Node.js client library is based on the C++ client library. Follow the instructions for C++ library for installing the binaries through RPM, Deb or Homebrew packages.

(Note: you will need to install not only the pulsar-client library but also the pulsar-client-dev library)

Also, this library works only in Node.js 10.x or later because it uses the node-addon-api module to wrap the C++ library.

Compatibility between each version of the Node.js client and the C++ client is as follows:

If an incompatible version of the C++ client is installed, you may fail to build or run this library.

1. Build the Pulsar C++ client on windows.

cmake \
 -A x64 \
 -DBUILD_PYTHON_WRAPPER=OFF -DBUILD_TESTS=OFF \
 -DVCPKG_TRIPLET=x64-windows \
 -DCMAKE_BUILD_TYPE=Release \
 -S .
cmake --config Release

2. Set the variable PULSAR_CPP_DIR with the pulsar-client-cpp path in a Windows command tool.

# for example
set PULSAR_CPP_DIR=C:\pulsar\pulsar-client-cpp

3. Set the variable OS_ARCH in a Windows command tool, OS_ARCH is related to the configuration of VCPKG_TRIPLET on the command line above.(Optional)

set OS_ARCH=x64-windows

$ npm install pulsar-client

Please refer to examples.

$ git clone https://github.com/apache/pulsar-client-node.git
$ cd pulsar-client-node
$ npm install

Note

If you build pulsar-client-node on windows, you need to set the variable PULSAR_CPP_DIR first, then install npm (run the command npm install) in a Windows command-line tool.

$ npm run build