No Password Management

    TypeScript icon, indicating that this package has built-in type declarations

    1.6.2 • Public • Published

    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 client C++ client
    1.0.x 2.3.0 or later
    1.1.x 2.4.0 or later
    1.2.x 2.5.0 or later
    1.3.x 2.7.0 or later
    1.4.x - 1.5.x 2.8.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

    Install on windows

    1. Build the Pulsar C++ client on windows.
    cmake \
     -A x64 \
     -DVCPKG_TRIPLET=x64-windows \
     -DCMAKE_BUILD_TYPE=Release \
     -S .
    cmake --config Release
    1. Set the variable PULSAR_CPP_DIR with the pulsar-client-cpp path in a Windows command tool.
    # for example
    set PULSAR_CPP_DIR=C:\pulsar\pulsar-client-cpp
    1. Set the variable OS_ARCH in a Windows command tool, OS_ARCH is related to the configuration of VCPKG_TRIPLET on the command line above.(Optional)
    set OS_ARCH=x64-windows

    Install on mac

    1. Install the Pulsar C++ client on mac.
    brew install libpulsar
    1. Get the installation path of libpulsar
    brew info libpulsar
    1. Set the variable PULSAR_CPP_DIR with the pulsar-client-cpp path in a mac command tool.
    # for example
    export PULSAR_CPP_DIR=/usr/local/Cellar/libpulsar/2.9.1_1

    Install pulsar-client to 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
    $ cd pulsar-client-node
    $ npm install


    If you build pulsar-client-node on windows, you need to set the variable PULSAR_CPP_DIR first, then install npm (run the command npm install) in a Windows command-line tool.

    Rebuild Pulsar client library:

    $ npm run build




    npm i pulsar-client

    DownloadsWeekly Downloads






    Unpacked Size

    238 kB

    Total Files


    Last publish


    • massakam
    • nkurihar
    • hrsakai
    • yfuruta
    • guangning