{"_id":"pulsar-client","_rev":"112-89fa7e56f0623c1ae66a295e82f7a5a8","name":"pulsar-client","dist-tags":{"latest":"1.18.0","rc":"1.18.0-rc.1"},"versions":{"0.0.1-rc.1":{"name":"pulsar-client","version":"0.0.1-rc.1","author":{"name":"Apache Software Foundation"},"license":"Apache-2.0","_id":"pulsar-client@0.0.1-rc.1","maintainers":[{"name":"massakam","email":"massakam@apache.org"}],"homepage":"https://github.com/apache/pulsar-client-node#readme","bugs":{"url":"https://github.com/apache/pulsar-client-node/issues"},"dist":{"shasum":"be2ab536bcf8f460ca5cb1010ac0d86c0893b128","tarball":"https://registry.npmjs.org/pulsar-client/-/pulsar-client-0.0.1-rc.1.tgz","fileCount":51,"integrity":"sha512-tlypLKwNwA9G+CiCxzr1w6lFc6MGuLhZS1bVX+B2MufhCTYERcfTaesYG7FHHOmaNTBB9XO+mL9fVuLIWjsecA==","signatures":[{"sig":"MEUCIG429LlYK+sVnceybs0R03ZpfkiJdfvi+OSebQm4DxGsAiEA8JVTApe7GXrXUzLdQ/iNyw1Rxjy9JDUfSRSHc3t8+/4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":151610,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdX2mgCRA9TVsSAnZWagAAOtsP/1aro2irjYi4IIwYGZlF\nMZUT7brQ5nF39+swIoTZsYZlHdZq56pqsvltyP5fHv4y7RhEO6mpDOdnDxV3\nNS21Ssbq238+AU9wrj3EttPaihVqOGoXkXvWJmfhOBkBjkF56izwVtOWSaNe\nNlgk4krbdBoMGv+40RyxIw/KWFWSiq6zDqG+ZJVvvm4UdmS8A3pEtvNRPxum\nWru2wpJ2gok3DwfSqRoRYz+S4w9/NTPNxwP2BRzZl9hTt8xN086c60Qlrek4\nBw8g8X6pntxmMPk6X1q2hvK//TAFTnRz9Z2KWsv+Y+nmShteM2WpIyS134f8\nig0krBpR3TL1iwBOCXn7l96RL7lox+ZaWDMJdFdu2OxFL7fcdMiJ+Q5SfE6G\nH+y3F7fqLrEB5SYDYsOpSowTpLmSjt9JHgppDOW5zpIOTRalWrJb3IOfcLtq\nPXo1XkTLuRldkRWNsdIlzYZ+WouJa8MY6kiWeeH86DDxOpF/x47iYyXSHy/F\n7HRxtZoHYnqktZnnZBYGpfxILap+ehK1rsiszV4QnxNKxHhzHtsUTCXGARO3\nbJsPB+YZhtLOxG5SJ4qp/r/HGQZ67GUitKHgQmZE4xfHGwtCSm05yPcMoWT1\nH0aRM4ff5/iFeLJjUo649AV6BM3Ppi1Vf5Rh2o8xcl/b0fgZczTpkbWlHj94\nHoZg\r\n=UO6B\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","binary":{"host":"https://pulsar.apache.org/docs/en/client-libraries-cpp/","module_name":"libpulsar","module_path":"./build/Release"},"engines":{"node":">=10.0.0"},"gitHead":"c7eec7e1e86237b22083344c719cf9f47cd46061","gypfile":true,"scripts":{"lint":"eslint --ext .js .","test":"jest --verbose","build":"npm run format && node-gyp rebuild","clean":"node-gyp clean","format":"clang-format -i --verbose src/* && eslint --fix --ext .js .","install":"node-pre-gyp install --fallback-to-build","configure":"node-gyp configure","build:debug":"npm run format && node-gyp rebuild --debug","license:report":"mkdir -p report && grunt grunt-license-report","license:addheader":"license-check-and-add"},"_npmUser":{"name":"massakam","email":"massakam@apache.org"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.","repository":{"url":"git+https://github.com/apache/pulsar-client-node.git","type":"git"},"_npmVersion":"6.4.1","description":"Pulsar Node.js client","directories":{"src":"src","example":"examples"},"_nodeVersion":"10.14.2","dependencies":{"bindings":"^1.3.1","node-gyp":"^3.8.0","node-pre-gyp":"^0.12.0","node-addon-api":"^1.6.2"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^24.8.0","delay":"^4.3.0","grunt":"^1.0.4","eslint":"^5.16.0","lodash":"^4.17.15","commander":"^2.20.0","clang-format":"^1.2.4","hdr-histogram-js":"^1.1.4","eslint-plugin-import":"^2.18.2","grunt-license-report":"^0.0.8","license-check-and-add":"^2.3.6","eslint-config-airbnb-base":"^13.2.0"},"_npmOperationalInternal":{"tmp":"tmp/pulsar-client_0.0.1-rc.1_1566534047845_0.02554224812848771","host":"s3://npm-registry-packages"},"license-check-and-add-config":{"folder":".","license":"license-header.txt","file_types":[".json",".pem",".txt"],"exact_paths":[".git/","build/","node_modules/","report/","LICENSE"],"default_format":{"append":"#","prepend":"#","eachLine":{"prepend":"# "}},"insert_license":true,"license_formats":{"html|xml|md":{"append":"\n-->","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"","prepend":"\n\n# Pulsar Node.js client library\n\nThe Pulsar Node.js client can be used to create Pulsar producers and consumers in Node.js. For the supported Pulsar features, see [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).\n\nThis library works only in Node.js 12.3 or later because it uses:\n1. The [node-addon-api](https://github.com/nodejs/node-addon-api) module to wrap the C++ library.\n2. The [Mozilla CA](https://nodejs.org/api/tls.html#tlsrootcertificates) file, which is provided by Node.js v12.3.0 and subsequent versions.\n\n## Getting Started\n\n> **Note**\n>\n> These instructions are only available for versions after 1.8.0. For versions previous to 1.8.0, you need to install the C++ client first. Please switch to the corresponding version branch of this repo to read the specific instructions.\n>\n> To run the examples, skip this section.\n\nTo use the Pulsar Node.js client in your project, run:\n\n```shell\nnpm install pulsar-client\n```\n\nor\n\n```shell\nyarn add pulsar-client\n```\n\nThen you can run the following simple end-to-end example:\n\n```javascript\nconst Pulsar = require('pulsar-client');\n\n(async () => {\n // Create a client\n const client = new Pulsar.Client({\n serviceUrl: 'pulsar://localhost:6650'\n });\n\n // Create a producer\n const producer = await client.createProducer({\n topic: 'persistent://public/default/my-topic',\n });\n\n // Create a consumer\n const consumer = await client.subscribe({\n topic: 'persistent://public/default/my-topic',\n subscription: 'sub1'\n });\n\n // Send a message\n producer.send({\n data: Buffer.from(\"hello\")\n });\n\n // Receive the message\n const msg = await consumer.receive();\n console.log(msg.getData().toString());\n consumer.acknowledge(msg);\n\n await producer.close();\n await consumer.close();\n await client.close();\n})();\n```\n\nYou should find the output as:\n\n```\nhello\n```\n\nYou can see more examples in the [examples](./examples) directory. However, since these examples might use an API that was not released yet, you need to build this module. See the next section.\n\n## How to build\n\n> **Note**\n>\n> Building from source code requires a Node.js version greater than 16.18.\n\nFirst, clone the repository.\n\n```shell\ngit clone https://github.com/apache/pulsar-client-node.git\ncd pulsar-client-node\n```\n\nSince this client is a [C++ addon](https://nodejs.org/api/addons.html#c-addons) that depends on the [Pulsar C++ client](https://github.com/apache/pulsar-client-cpp), you need to install the C++ client first. You need to ensure there is a C++ compiler that supports C++11 installed in your system.\n\n- Install C++ client on Linux:\n\n```shell\npkg/linux/download-cpp-client.sh\n```\n\n- Install C++ client on Windows:\n\n```shell\npkg\\windows\\download-cpp-client.bat\n```\n\n- Install C++ client on macOS:\n\n```shell\npkg/mac/download-cpp-client.sh\n```\n\nAfter the C++ client is installed, run the following command to build this C++ addon.\n\n```shell\nnpm install\n```\n\nTo verify it has been installed successfully, you can run an example like:\n\n> **Note**\n>\n> A running Pulsar server is required. The example uses `pulsar://localhost:6650` to connect to the server.\n\n```shell\nnode examples/producer\n```\n\nYou should find the output as:\n\n```\nSent message: my-message-0\nSent message: my-message-1\nSent message: my-message-2\nSent message: my-message-3\nSent message: my-message-4\nSent message: my-message-5\nSent message: my-message-6\nSent message: my-message-7\nSent message: my-message-8\nSent message: my-message-9\n```\n\n## Documentation\n\nFor more details about Pulsar Node.js clients, see [Pulsar docs](https://pulsar.apache.org/docs/client-libraries-node/).\n\n### Contribute\n\nContributions are welcomed and greatly appreciated.\n\nIf your contribution adds Pulsar features for Node.js clients, you need to update both the [Pulsar docs](https://pulsar.apache.org/docs/client-libraries/) and the [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/). See [Contribution Guide](https://pulsar.apache.org/contribute/site-intro/#pages) for more details.\n\n### Generate API docs\n\n```shell\nnpm install\nnpx typedoc\n# Documentation generated at ./apidocs\n```\n","readmeFilename":"README.md"}