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:
Node.js client | C++ client |
---|---|
1.0.x | 2.3.0 or later |
1.1.x | 2.4.0 or later |
1.2.x | 2.5.0 or later |
1.3.x | 2.7.0 or later |
1.4.x - 1.5.x | 2.8.0 or later |
If an incompatible version of the C++ client is installed, you may fail to build or run this library.
- 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
- Set the variable
PULSAR_CPP_DIR
with thepulsar-client-cpp
path in a Windows command tool.
# for example
set PULSAR_CPP_DIR=C:\pulsar\pulsar-client-cpp
- 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
- Install the Pulsar C++ client on mac.
brew install libpulsar
- Get the installation path of libpulsar
brew info libpulsar
- Set the variable
PULSAR_CPP_DIR
with thepulsar-client-cpp
path in a mac command tool.
# for example
export PULSAR_CPP_DIR=/usr/local/Cellar/libpulsar/2.9.1_1
$ 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 variablePULSAR_CPP_DIR
first, then install npm (run the commandnpm install
) in a Windows command-line tool.
$ npm run build