tree: 1cc4692d96d3d23e72863c9495047ea5a69750e8 [path history] [tgz]
  1. .asf.yaml
  2. .clang-format
  3. .eslintignore
  4. .eslintrc.json
  5. .gitignore
  6. Gruntfile.js
  7. LICENSE
  8. README.md
  9. binding.gyp
  10. docker-tests.sh
  11. examples/
  12. index.js
  13. license-header.txt
  14. package-lock.json
  15. package.json
  16. perf/
  17. pulsar-test-service-start.sh
  18. pulsar-test-service-stop.sh
  19. pulsar-version.txt
  20. run-unit-tests.sh
  21. src/
  22. tests/
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.02.3.0 or later
1.1.02.4.0 or later
1.2.02.5.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

Typescript Definitions

$ npm install @types/pulsar-client --save-dev

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