Skip to content

Commit 992248b

Browse files
pasupulaphanipasupulaphani
committed
docs cmit prepublish
1 parent bf289ee commit 992248b

File tree

3 files changed

+49
-33
lines changed

3 files changed

+49
-33
lines changed

‎docs/RedisPool.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1845,7 +1845,7 @@ <h5>Returns:</h5>
18451845
<br class="clear">
18461846

18471847
<footer>
1848-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1848+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
18491849
</footer>
18501850

18511851
<script>prettyPrint();</script>

‎docs/index.html

Lines changed: 47 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -46,33 +46,44 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RedisPool
4646

4747

4848
<section class="readme">
49-
<article><p><a href="https://npmjs.org/package/node-redis-connection-pool"><img src="https://img.shields.io/npm/v/node-redis-connection-pool.svg?style=flat-square" alt="npm version"></a>
49+
<article><p><a href="https://badge.fury.io/js/node-redis-connection-pool"><img src="https://badge.fury.io/js/node-redis-connection-pool.svg" alt="npm version"></a>
5050
<a href="https://travis-ci.org/pasupulaphani/node-redis-connection-pool"><img src="https://travis-ci.org/pasupulaphani/node-redis-connection-pool.svg?branch=master" alt="Build Status"></a>
5151
<a href="https://coveralls.io/github/pasupulaphani/node-redis-connection-pool?branch=master"><img src="https://coveralls.io/repos/github/pasupulaphani/node-redis-connection-pool/badge.svg?branch=master" alt="Coverage Status"></a>
52-
<a href="https://www.versioneye.com/user/projects/58780c851fe8e3003e7a83b2"><img src="https://www.versioneye.com/user/projects/58780c851fe8e3003e7a83b2/badge.svg?style=flat-square" alt="Dependency Status"></a>
5352
<a href="https://gratipay.com/simple-redis-store/"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg?style=flat-square" alt="Gratipay donate button"></a></p>
54-
<h1>node-redis-connection-pool <a href="https://github.com/pasupulaphani/node-redis-connection-pool"><img src="https://github.com/themes/tactile/images/octocat-icon.png" alt="See on Github"></a></h1><p>Simplistic node redis connection pool ready can scale with generic-pool support</p>
55-
<h2>Prerequisites</h2><p><code>node &gt;= 4</code> This module requires nodejs v4 or above as it has dependencies on es6 components such as Map, Set, Promise etc.</p>
56-
<h3>Getting started</h3><pre class="prettyprint source"><code> npm install node-redis-connection-pool</code></pre><h4>Usage</h4><ul>
57-
<li><p>Seemless execution of commands.</p>
58-
<pre class="prettyprint source"><code> var RedisPool = require(&quot;node-redis-connection-pool&quot;);
59-
var pool = new RedisPool();
53+
<h1>node-redis-connection-pool <a href="https://github.com/pasupulaphani/node-redis-connection-pool"><img src="https://github.com/themes/tactile/images/octocat-icon.png" alt="See on Github"></a></h1>
54+
<p>Simplistic node redis connection pool ready can scale with generic-pool support</p>
55+
<h2>Prerequisites</h2>
56+
<p><code>node &gt;= 4</code> This module requires nodejs v4 or above as it has dependencies on es6 components such as Map, Set, Promise etc.</p>
57+
<h3>Getting started</h3>
58+
<pre class="prettyprint source"><code> npm install node-redis-connection-pool
59+
</code></pre>
60+
<h4>Usage</h4>
61+
<ul>
62+
<li>Seemless execution of commands.</li>
63+
</ul>
64+
<pre class="prettyprint source"><code> var RedisPool = require(&quot;node-redis-connection-pool&quot;);
65+
var pool = new RedisPool();
6066

61-
pool.sendCommand(&quot;set&quot;, [&quot;key&quot;, &quot;value&quot;])</code></pre></li>
62-
<li><p>Want redis raw connection? you got it</p>
63-
<pre class="prettyprint source"><code> pool.acquire()
64-
.then(conn => {
67+
pool.sendCommand(&quot;set&quot;, [&quot;key&quot;, &quot;value&quot;])
68+
</code></pre>
69+
<ul>
70+
<li>Want redis raw connection? you got it</li>
71+
</ul>
72+
<pre class="prettyprint source"><code> pool.acquire()
73+
.then(conn => {
6574

66-
// Do some work
75+
// Do some work
6776

68-
// At the end release the conn back to the pool
69-
pool.release(conn)
70-
});</code></pre></li>
71-
</ul>
72-
<h4>API</h4><ul>
77+
// At the end release the conn back to the pool
78+
pool.release(conn)
79+
});
80+
</code></pre>
81+
<h4>API</h4>
82+
<ul>
7383
<li>RedisPool([options])</li>
7484
</ul>
75-
<h5><code>options</code> object properties</h5><table class="params">
85+
<h5><code>options</code> object properties</h5>
86+
<table class="params">
7687
<thead>
7788
<tr>
7889
<th>Name</th>
@@ -119,27 +130,32 @@ <h5><code>options</code> object properties</h5><table class="params">
119130
</tr>
120131
</tbody>
121132
</table>
122-
123-
124-
<h3>Run tests</h3><pre class="prettyprint source"><code>bash test.sh</code></pre><h2>Contribute</h2><p><a href="https://github.com/pasupulaphani/node-redis-connection-pool/blob/master/CONTRIBUTING.md">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a></p>
125-
<h2>Backers</h2><h3>Maintainers</h3><p>These amazing people are maintaining this project:</p>
133+
<h3>Run tests</h3>
134+
<pre><code>bash test.sh
135+
</code></pre>
136+
<h2>Contribute</h2>
137+
<p><a href="https://github.com/pasupulaphani/node-redis-connection-pool/blob/master/CONTRIBUTING.md">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a></p>
138+
<h2>Backers</h2>
139+
<h3>Maintainers</h3>
140+
<p>These amazing people are maintaining this project:</p>
126141
<ul>
127142
<li><a href="https://github.com/pasupulaphani">Phani</a> — <a href="https://github.com/pasupulaphani/node-redis-connection-pool/commits?author=pasupulaphani">view contributions</a></li>
128143
</ul>
129-
<h3>Sponsors</h3><p>No sponsors yet! Will you be the first?</p>
144+
<h3>Sponsors</h3>
145+
<p>No sponsors yet! Will you be the first?</p>
130146
<p><a href="http://patreon.com/phaninder" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button"></a>
131147
<a href="https://gratipay.com/~pasupulaphani/" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button"></a>
132-
<a href="https://flattr.com/profile/pasupulaphani" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button"></a>
148+
<a href="https://flattr.com/profile/pasupulaphani" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button"></a></p>
133149
<!-- [![PayPal donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://phaninder.com/paypal "Donate to this project using Paypal") -->
134150
<!-- [![Bitcoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://phaninder.com/bitcoin "Donate once-off to this project using Bitcoin") -->
135-
<!-- [![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](https://phaninder.com/wishlist "Buy an item on our wishlist for us") --></p>
136-
<h3>Contributors</h3><p>These amazing people have contributed to/reviewed this project:</p>
151+
<!-- [![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](https://phaninder.com/wishlist "Buy an item on our wishlist for us") -->
152+
<p><a href='https://pledgie.com/campaigns/33095'><img alt='Click here to lend your support to: simple-node-redis-cache and make a donation at pledgie.com !' src='https://pledgie.com/campaigns/33095.png?skin_name=chrome' border='0' ></a></p>
153+
<h3>Contributors</h3>
154+
<p>These amazing people have contributed to/reviewed this project:</p>
137155
<ul>
138156
<li><a href="https://github.com/oliverbrooks">Oliver Brooks</a></li>
139157
</ul>
140-
<p><a href="https://github.com/pasupulaphani/node-redis-connection-pool/blob/master/CONTRIBUTING.md">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a></p>
141-
<p><br /></p>
142-
<h2><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');ga('create', 'UA-57413413-3', 'auto');ga('send', 'pageview');</script></h2></article>
158+
<p><a href="https://github.com/pasupulaphani/node-redis-connection-pool/blob/master/CONTRIBUTING.md">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a></p></article>
143159
</section>
144160

145161

@@ -152,7 +168,7 @@ <h2><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||fun
152168
<br class="clear">
153169

154170
<footer>
155-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
171+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
156172
</footer>
157173

158174
<script>prettyPrint();</script>

‎docs/redis_pool.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ <h1 class="page-title">redis_pool.js</h1>
317317
<br class="clear">
318318

319319
<footer>
320-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
320+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
321321
</footer>
322322

323323
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)