Google Git
Sign in
apache / pulsar-client-node / 5f8aadbc8922bb1c0a031d02416d69e082a9544f
commit5f8aadbc8922bb1c0a031d02416d69e082a9544f[log] [tgz]
authorMasahiro Sakamoto <massakam@yahoo-corp.jp>Thu Aug 22 10:21:35 2019 +0900
committerGitHub <noreply@github.com>Thu Aug 22 10:21:35 2019 +0900
tree8cf9f179441a971bac62fc0e5f228172c0f674bd
parent9bc6646721d1e78fe6dbb4c3583d4372e1399a8d [diff]
parentae5d29ca15d69c5ad2adcb2212b0b0f5270a0700 [diff]
Merge pull request #47 from daghdha/master

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

Pulsar Node.js client library

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

Compatibility

This Node.js client is developed and tested using Apache Pulsar 2.3.0

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.

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