Return MessageId as promise resolve at Producer#send (#137)

* feat: return MessageId as promise resolve at Producer#send

* test: delete unused conf from Produce/Consume and validate MessageId test
5 files changed
tree: 0ccf0f724ce5c32f428c1e08b129d4a726f2b0df
  1. .asf.yaml
  2. .clang-format
  3. .eslintignore
  4. .eslintrc.json
  5. .github/
  6. .gitignore
  7. Gruntfile.js
  10. binding.gyp
  12. examples/
  13. index.js
  14. license-header.txt
  15. package-lock.json
  16. package.json
  17. perf/
  20. pulsar-version.txt
  22. src/
  23. tests/

Pulsar Node.js client library

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


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 between each version of the Node.js client and the C++ client is as follows:

Node.js clientC++ client or later or later 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
$ cd pulsar-client-node
$ npm install

Rebuild Pulsar client library:

$ npm run build