delete vscode
1 file changed
tree: c5ca6327450f433f3ba33218186924785cb77a1b
  1. examples/
  2. perf/
  3. src/
  4. tests/
  5. .clang-format
  6. .eslintrc.json
  7. .gitignore
  8. binding.gyp
  9. docker-tests.sh
  10. Gruntfile.js
  11. index.js
  12. LICENSE
  13. package-lock.json
  14. package.json
  15. pulsar-test-service-start.sh
  16. pulsar-test-service-stop.sh
  17. pulsar-version.txt
  18. README.md
  19. 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.

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