@financialforcedev/orizuru-transport-kafka
Version:
Kafka transport layer for the orizuru package
86 lines (46 loc) • 2.58 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><h1>Orizuru Transport Kafka.</h1><p><a href="https://travis-ci.org/financialforcedev/orizuru-transport-redis"><img src="https://travis-ci.org/financialforcedev/orizuru-transport-redis.svg?branch=master" alt="Build Status"></a>
<a href="https://nodesecurity.io/orgs/ffres/projects/62120cff-b6b1-4eb6-a608-338d22302f65"><img src="https://nodesecurity.io/orgs/ffres/projects/62120cff-b6b1-4eb6-a608-338d22302f65/badge" alt="NSP Status"></a></p>
<p>Orizuru Transport Kafka is a transport library for the <a href="https://www.npmjs.com/package/@financialforcedev/orizuru">Orizuru</a> framework.</p>
<h2>Install</h2><pre class="prettyprint source"><code>$ npm install @financialforcedev/orizuru-transport-kafka</code></pre><h2>Usage</h2><p>Use this dependency to specify the transport layer that <code>@financialforcedev/orizuru</code> uses as Kafka.</p>
<pre class="prettyprint source"><code>const
// get classes from orizuru
{ Server, Handler, Publisher } = require('@financialforcedev/orizuru'),
// get the transport
transport = require('@financialforcedev/orizuru-transport-kafka'),
// configure the transport
transportConfig = {
};
new Server({ transport, transportConfig }))...
new Handler({ transport, transportConfig })...
new Publisher({ transport, transportConfig })...</code></pre><h2>API Docs</h2><p>Click to view <a href="http://htmlpreview.github.io/?https://github.com/financialforcedev/orizuru-transport-kafka/blob/master/doc/index.html">JSDoc API documentation</a>.</p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-index.html">index</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 17 2017 12:46:07 GMT+0000 (GMT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>