Google Git
Sign in
apache / pulsar-client-node / refs/tags/v1.7.0-rc.1
tag41f3cf475a1e459fa7e952b843a100b5a8222bf0
taggeryfuruta <yfuruta@yahoo-corp.jp>Mon Oct 03 12:54:28 2022 +0900
objectd1e9f1c94f2963d5d62ab9a9d8ac0179e8a13d51 
Release v1.7.0-rc.1
commitd1e9f1c94f2963d5d62ab9a9d8ac0179e8a13d51[log] [tgz]
authoryfuruta <yfuruta@yahoo-corp.jp>Mon Oct 03 12:54:11 2022 +0900
committeryfuruta <yfuruta@yahoo-corp.jp>Mon Oct 03 12:54:11 2022 +0900
tree87ebe688cce6433ec6dc0361d751cd56fc0384e8
parent73d2715d7a0c75fc91ee9b6a6eb6c478a738ff6f [diff]
Release v1.7.0
2 files changed
tree: 87ebe688cce6433ec6dc0361d751cd56fc0384e8
  1. .github/
  2. examples/
  3. perf/
  4. src/
  5. tests/
  6. .asf.yaml
  7. .clang-format
  8. .eslintignore
  9. .eslintrc.json
  10. .gitignore
  11. binding.gyp
  12. docker-tests.sh
  13. Gruntfile.js
  14. index.d.ts
  15. index.js
  16. LICENSE
  17. license-header.txt
  18. package-lock.json
  19. package.json
  20. pulsar-test-service-start.sh
  21. pulsar-test-service-stop.sh
  22. pulsar-version.txt
  23. README.md
  24. run-unit-tests.sh
  25. tsconfig.json
  26. tslint.json
  27. tstest.ts
README.md

Pulsar Node.js client library

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

Requirements

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

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

Node.js clientC++ client
1.0.x2.3.0 or later
1.1.x2.4.0 or later
1.2.x2.5.0 or later
1.3.x2.7.0 or later
1.4.x - 1.6.x2.8.0 or later
1.7.x2.10.1 or later

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

How to install

Install on windows

  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
  1. 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
  1. 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 on mac

  1. Install the Pulsar C++ client on mac.
brew install libpulsar
  1. Get the installation path of libpulsar
brew info libpulsar
  1. Set the variable PULSAR_CPP_DIR with the pulsar-client-cpp path in a mac command tool.
# for example
## Intel x86_64
export PULSAR_CPP_DIR=/usr/local/Cellar/libpulsar/2.9.1_1

## Apple Silicon and Homebrew since 3.0.0
## cf. https://brew.sh/2021/02/05/homebrew-3.0.0/
export PULSAR_CPP_DIR=/opt/homebrew/Cellar/libpulsar/2.9.1_1

Install on Linux

  1. Require g++ and make commands to install pulsar-client
# rpm
$ yum install gcc-c++ make

# debian
$ apt-get install g++ make
  1. Download rpm or debian packages.
# Set the version of Pulsar C++ client to install
$ PULSAR_CPP_CLIENT_VERSION=2.9.1

# rpm
$ wget https://archive.apache.org/dist/pulsar/pulsar-${PULSAR_CPP_CLIENT_VERSION}/RPMS/apache-pulsar-client-${PULSAR_CPP_CLIENT_VERSION}-1.x86_64.rpm
$ wget https://archive.apache.org/dist/pulsar/pulsar-${PULSAR_CPP_CLIENT_VERSION}/RPMS/apache-pulsar-client-devel-${PULSAR_CPP_CLIENT_VERSION}-1.x86_64.rpm

# debian
$ wget https://archive.apache.org/dist/pulsar/pulsar-${PULSAR_CPP_CLIENT_VERSION}/DEB/apache-pulsar-client.deb
$ wget https://archive.apache.org/dist/pulsar/pulsar-${PULSAR_CPP_CLIENT_VERSION}/DEB/apache-pulsar-client-dev.deb
  1. Install the Pulsar C++ client.
# rpm
$ rpm -ivh apache-pulsar-client*.rpm

# debian
$ apt install ./apache-pulsar-client*.deb

Install pulsar-client to your project

$ npm install pulsar-client

Sample code

Please refer to examples.

How to build

Install dependent npm modules and build Pulsar client library:

$ 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.

Rebuild Pulsar client library:

$ npm run build

Documentation