commit | bc12d9dce348fb4d4ab77b1a90e3ab8d6e6285ad | [log] [tgz] |
---|---|---|
author | Brian Walendzinski <bwalendz@users.noreply.github.com> | Mon Jan 27 20:02:49 2020 -0500 |
committer | nkurihar <nkurihar@apache.org> | Tue Jan 28 10:02:49 2020 +0900 |
tree | 4e380502829011cbe34d5809d7b4798c6c43bf3b | |
parent | b8b2fdd002ccc95f42ee696f0a299d533d93f1ea [diff] |
add typescript definitions install instructions to readme (#64)
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 client | C++ client |
---|---|
1.0.0 | 2.3.0 or later |
If an incompatible version of the C++ client is installed, you may fail to build or run this library.
$ npm install pulsar-client
$ npm install @types/pulsar-client --save-dev
Please refer to examples.
$ git clone https://github.com/apache/pulsar-client-node.git $ cd pulsar-client-node $ npm install
$ npm run build