Google Git
Sign in
apache / pulsar-client-node / refs/tags/v1.3.2-rc.1
tagc2445e061e130127d12b0e4794d4cdc6dbaf9157
taggerMasahiro Sakamoto <massakam@yahoo-corp.jp>Fri Oct 08 18:47:43 2021 +0900
objecta07e5db321bd3121de161ecc115a9e4aa77136ae 
1.3.2-rc.1
commita07e5db321bd3121de161ecc115a9e4aa77136ae[log] [tgz]
authorMasahiro Sakamoto <massakam@yahoo-corp.jp>Fri Oct 08 18:47:43 2021 +0900
committerMasahiro Sakamoto <massakam@yahoo-corp.jp>Fri Oct 08 18:47:43 2021 +0900
tree57c42375747ca5ef96994369a7834958ebc6fc09
parent55b27c533ba849db0de0c932b6674b91de6eaabf [diff]
1.3.2-rc.1
2 files changed
tree: 57c42375747ca5ef96994369a7834958ebc6fc09
  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.x2.8.0 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