<!DOCTYPE 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>apollo-passport-rethinkdbdash 0.0.2</h3>
<section>
<article><h1>apollo-passport-rethinkdbdash</h1><p>rethinkdbdash driver for apollo-passport</p>
<p><a href="https://www.npmjs.com/package/apollo-passport-rethinkdbdash"><img src="https://img.shields.io/npm/v/apollo-passport-rethinkdbdash.svg?maxAge=2592000" alt="npm"></a> <a href="https://circleci.com/gh/apollo-passport/rethinkdbdash"><img src="https://circleci.com/gh/apollo-passport/rethinkdbdash.svg?style=shield" alt="Circle CI"></a> <a href="https://coveralls.io/github/apollo-passport/rethinkdbdash?branch=master"><img src="https://coveralls.io/repos/github/apollo-passport/rethinkdbdash/badge.svg?branch=master" alt="Coverage Status"></a> <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License"></p>
<p>Copyright (c) 2016 by Gadi Cohen, released under the MIT license.</p>
<h2>Usage</h2><pre class="prettyprint source lang-js"><code>import rethinkdbdash from 'rethinkdbdash';
import RethinkDBDashDriver from 'apollo-passport-rethinkdbdash';
// However you usually create your "r" instance
const r = rethinkdbdash({
db: "myApp",
servers: [ { host, port } ]
});
// Pass to apollo passport at creation time
const apolloPassport = new ApolloPassport({
// along with any other relevant options
db: new RethinkDBDashDriver(r)
});</code></pre><p><strong>Optional parameters</strong>, e.g. if your <code>users</code> table is called something else:</p>
<pre class="prettyprint source lang-js"><code>new RethinkDBDashDriver(r, {
userTableName: 'users',
configTableName: 'apolloPassportConfig',
db: '(override default database given to rethinkdbdash)'
});</code></pre><p>See <a href="https://github.com/apollo-passport/apollo-passport">apollo-passport</a> for more info.</p>
<h2>Create your own DBDriver</h2><p>This package is fully documented with 100% test coverage. It can be used as a basis for creating other DBDrivers for Apollo Passport.</p>
<p>See also the <a href="docs/api/apollo-passport-rethinkdbdash">API Docs</a>.</p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RethinkDBDashDriver.html">RethinkDBDashDriver</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sat Aug 20 2016 13:51:25 GMT+0300 (IDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>