2 files changed
tree: 461176317d35d96dc0112a65436c909fd9ea0bd0
  1. .clang-format
  2. .eslintignore
  3. .eslintrc.json
  4. .gitignore
  5. Gruntfile.js
  7. README.md
  8. binding.gyp
  9. docker-tests.sh
  10. examples/
  11. index.js
  12. license-header.txt
  13. package-lock.json
  14. package.json
  15. perf/
  16. pulsar-test-service-start.sh
  17. pulsar-test-service-stop.sh
  18. pulsar-version.txt
  19. run-unit-tests.sh
  20. src/
  21. tests/

Pulsar Node.js client library

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 clientC++ client or later

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

How to install

Please install pulsar-client in 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

Rebuild Pulsar client library:

$ npm run build