support disable replication (#149)

Co-authored-by: yfuruta <yfuruta@yahoo-corp.jp>
1 file changed
tree: 6556ed94b05d31b059d832669429b65b535710ad
  1. .asf.yaml
  2. .clang-format
  3. .eslintignore
  4. .eslintrc.json
  5. .github/
  6. .gitignore
  7. Gruntfile.js
  8. LICENSE
  9. README.md
  10. binding.gyp
  11. docker-tests.sh
  12. examples/
  13. index.d.ts
  14. index.js
  15. license-header.txt
  16. package-lock.json
  17. package.json
  18. perf/
  19. pulsar-test-service-start.sh
  20. pulsar-test-service-stop.sh
  21. pulsar-version.txt
  22. run-unit-tests.sh
  23. src/
  24. tests/
  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.02.3.0 or later
1.1.02.4.0 or later
1.2.02.5.0 or later
1.3.02.7.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